Skip to content

Commit

Permalink
docs: Update readme photo (#632)
Browse files Browse the repository at this point in the history
plus driveby tweak to zenquotes config
  • Loading branch information
tomsci authored May 20, 2023
1 parent 6f3e140 commit 627d4b3
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 7 deletions.
15 changes: 13 additions & 2 deletions device/nodemcu/README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,24 @@

The firmware is responsible for managing the StatusPanel device itself. It handles WiFi setup, encryption keys, device sleep, and scheduling fetching updates, and drawing on the eInk display.

The device runs Lua using [NodeMCU](https://nodemcu.readthedocs.io/en/dev-esp32-idf4/). We use the [`tomsci-dev-esp32-idf4`](https://github.com/tomsci/nodemcu-firmware/tree/tomsci-dev-esp32-idf4) branch of NodeMCU which provides some additional features that have not yet been accepted upstream, as well as being based on the latest IDF v4 which supports the esp32s2.
The device runs Lua using [NodeMCU](https://nodemcu.readthedocs.io/en/dev-esp32-idf4/). We use the [`tomsci-dev-esp32-idf4`](https://github.com/tomsci/nodemcu-firmware/tree/tomsci-dev-esp32-idf4) branch of NodeMCU which provides some additional features that have not yet been accepted upstream, as well as being based on the latest IDF v4 which supports the esp32s2 and esp32s3.

## Usage

## Status LED

- **Flashing** -- the device is in pairing / hotspot mode
- **Flashing** – the device is in pairing / hotspot mode.
- **On, non-flashing** – device is busy, eg downloading or processing an update, or updating the display.

## NeoPixel

On platforms that have one, the NeoPixel will use different colours to indicate different states:

- **Solid blue** – device is accessing the network.
- **Flashing blue** – device is in pairing / hotspot mode.
- **Solid green** – WiFi credentials were accepted (will shortly transition to blue indicating accessing the network.
- **Solid red** – indicates unpairing is starting (and you can stop holding down the toggle/unpair button).
- **Solid pink** – device is processing an update or updating the display.

## Development

Expand Down
Binary file modified images/hero.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions ios/StatusPanel/Data/Text/TextDataSource.swift
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@

import SwiftUI

import Diligence

final class TextDataSource: DataSource {

struct Settings: DataSourceSettings & Equatable {
Expand Down
6 changes: 4 additions & 2 deletions ios/StatusPanel/Data/Zen Quotes/ZenQuotesDataSource.swift
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ final class ZenQuotesDataSource: DataSource {

static let dataSourceType: DataSourceType = .zenQuotes

var flags: DataItemFlags
var mode: Mode

}
Expand Down Expand Up @@ -71,6 +72,7 @@ final class ZenQuotesDataSource: DataSource {
Text(Settings.Mode.random.localizedName).tag(Settings.Mode.random)
}
}
FlagsSection(flags: $model.settings.flags)
Section {
Link("ZenQuotes", url: URL(string: "https://zenquotes.io/")!)
Link("Privacy Policy", url: URL(string: "https://docs.zenquotes.io/privacy-policy/")!)
Expand Down Expand Up @@ -101,7 +103,7 @@ final class ZenQuotesDataSource: DataSource {
static let name = "ZenQuotes"
static let image = Image(systemName: "quote.bubble")

let defaults = Settings(mode: .today)
let defaults = Settings(flags: [], mode: .today)

func data(settings: Settings, completion: @escaping ([DataItemBase], Error?) -> Void) {

Expand All @@ -128,7 +130,7 @@ final class ZenQuotesDataSource: DataSource {
}

let text = "\"\(quote.quote.trimmingCharacters(in: .whitespacesAndNewlines))\"\(quote.author)"
completion([DataItem(icon: "💬", text: text, flags: [])], nil)
completion([DataItem(icon: "💬", text: text, flags: settings.flags)], nil)
}
}

Expand Down
2 changes: 1 addition & 1 deletion ios/StatusPanel/Device.swift
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ struct Device: Identifiable, Equatable, Hashable {
flags: [.header, .spansColumns]).anyDataSourceSettings(),
WeatherDataSource.Settings(flags: [],
address: "Bletchley Park, Sherwood Drive, Bletchley, Milton Keynes, MK3 6EB").anyDataSourceSettings(),
ZenQuotesDataSource.Settings(mode: .today).anyDataSourceSettings(),
ZenQuotesDataSource.Settings(flags: [], mode: .today).anyDataSourceSettings(),
CalendarDataSource.Settings(showLocations: true,
showUrls: false,
offset: 0,
Expand Down

0 comments on commit 627d4b3

Please sign in to comment.