From 925f6a8473fe27f13540c715dea2a1c4004ac33b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20G=C3=B6ttgens?= <tgoettgens@gmail.com>
Date: Thu, 19 Jan 2023 15:53:02 +0100
Subject: [PATCH] Update a few descriptions for new protobuf settings

---
 docs/blocks/_lora-regions.mdx                 |  2 +
 docs/configuration/device-config/device.mdx   | 10 +++++
 docs/configuration/device-config/display.mdx  | 15 ++++++-
 docs/configuration/device-config/lora.mdx     |  4 +-
 docs/configuration/device-config/position.mdx |  6 +++
 .../module-config/external-notification.mdx   | 45 ++++++++++++-------
 src/data/regions/ua_433.ts                    | 13 ++++++
 src/data/regions/ua_868.ts                    | 13 ++++++
 8 files changed, 88 insertions(+), 20 deletions(-)
 create mode 100644 src/data/regions/ua_433.ts
 create mode 100644 src/data/regions/ua_868.ts

diff --git a/docs/blocks/_lora-regions.mdx b/docs/blocks/_lora-regions.mdx
index 3c51cf01..04a6849a 100644
--- a/docs/blocks/_lora-regions.mdx
+++ b/docs/blocks/_lora-regions.mdx
@@ -12,6 +12,8 @@
 |    `RU`     |         Russia          |
 |    `IN`     |          India          |
 |  `NZ_865`   |   New Zealand 865MHz    |
+|  `UA_433`   |  Ukraine 433MHz         |
+|  `UA_868`   |  Ukraine 868MHz         |
 |    `TH`     |        Thailand         |
 |  `LORA_24`  | 2.4 GHz band worldwide  |
 
diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx
index 394024b1..b27c4ae6 100644
--- a/docs/configuration/device-config/device.mdx
+++ b/docs/configuration/device-config/device.mdx
@@ -37,6 +37,14 @@ Acceptable values: `true` or `false`
 
 By default we turn off logging as soon as an API client connects. Set this to true to leave the debug log outputting even when API is active.
 
+### GPIO for user button
+
+This is the GPIO pin number that will be used for the user button, if your device does not come with a predefined user button.
+
+### GPIO for PWM Buzzer
+
+This is the GPIO pin number that will be used for the PWM buzzer, if your device does not come with a predefined buzzer.
+
 ## Device Config Client Availability
 
 <Tabs
@@ -80,6 +88,8 @@ All device config options are available in the python CLI. Example commands are
 | device.debug_log_enabled | `true`, `false`                                    | `false`  |
 | device.role              | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `ROUTER_CLIENT` | `CLIENT` |
 | device.serial_enabled    | `true`, `false`                                    | `true`   |
+| device.button_gpio       | `0` - `34`                                         | `0`      |
+| device.buzzer_gpio       | `0` - `34`                                         | `0`      |
 
 :::tip
 
diff --git a/docs/configuration/device-config/display.mdx b/docs/configuration/device-config/display.mdx
index 34fbf803..bb5db5a7 100644
--- a/docs/configuration/device-config/display.mdx
+++ b/docs/configuration/device-config/display.mdx
@@ -49,7 +49,7 @@ If enabled, the screen will be rotated 180 degrees, for cases that mount the scr
 
 ### OLED Defintion
 
-The type of OLED Controller is auto-detected by default, but can be defined with this setting if the auto-detection fails.
+The type of OLED Controller is auto-detected by default, but can be defined with this setting if the auto-detection fails. For the SH1107, we assume a square display with 128x128 Pixels like the GME128128-1.
 
 Acceptable values:
 
@@ -58,6 +58,15 @@ Acceptable values:
 |  `OLED_AUTO`   | Auto detect display controller |
 | `OLED_SSD1306` |   Always use SSD1306 driver    |
 | `OLED_SH1106`  |    Always use SH1106 driver    |
+| `OLED_SH1107`  |    Always use SH1107 driver (Geometry 128x128)   |
+
+### Display Mode
+
+The display mode can be set to `NORMAL` (default), `TWOCOLOR` or `INVERTED`. The `TWOCOLOR` mode is intended for OLED displays with the first line of output being a different color than the rest of the display. The `INVERTED` mode will invert that bicolor area, resulting in a white background headline on monochrome displays.
+
+### Heading Bold
+
+The heading can be hard to read when 'INVERTED' or 'TWOCOLOR' display mode is used. This setting will make the heading bold, so it is easier to read.
 
 ## Device Config Client Availability
 
@@ -103,9 +112,11 @@ All display config options are available in the python CLI. Example commands are
 | display.compass_north_top         | `false`, `true`                            | `false`                      |
 | display.flip_screen               | `fasle`, `true`                            | `false`                      |
 | display.gps_format                | `DEC`, `DMS`, `UTM`, `MGRS`, `OLC`, `OSGR` | `DEC`                        |
-| display.oled                      | `OLED_AUTO`, `OLED_SSD1306`, `OLED_SH1106` | `OLED_AUTO`                  |
+| display.oled                      | `OLED_AUTO`, `OLED_SSD1306`, `OLED_SH1106`, `OLED_SH1107` | `OLED_AUTO`                  |
 | display.screen_on_secs            | `integer`                                  | Default of `0` is off.       |
 | display.units                     | `METRIC`, `IMPERIAL`                       | `METRIC`                     |
+| display.displaymode               | `NORMAL`, `TWOCOLOR`, `INVERTED`           | `NORMAL`                     |
+| display.heading_bold              | `false`, `true`                            | `false`                      |
 
 :::tip
 
diff --git a/docs/configuration/device-config/lora.mdx b/docs/configuration/device-config/lora.mdx
index be159166..fe9b8562 100644
--- a/docs/configuration/device-config/lora.mdx
+++ b/docs/configuration/device-config/lora.mdx
@@ -117,9 +117,9 @@ LoRa config commands are available in the python CLI. Example commands are below
 |         Setting          |                                            Acceptable Values                                            |   Default   |
 | :----------------------: | :-----------------------------------------------------------------------------------------------------: | :---------: |
 |    lora.modem_preset     |  `LONG_FAST`, `LONG_SLOW`, `VERY_LONG_SLOW`, `MEDIUM_SLOW`, `MEDIUM_FAST`, `SHORT_SLOW`, `SHORT_FAST`   | `LONG_FAST` |
-|       lora.region        | `UNSET`, `US`, `EU_433`, `EU_868`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` ,`IN`, `NZ_865`, `TH`, `LORA_24` |   `UNSET`   |
+|       lora.region        | `UNSET`, `US`, `EU_433`, `EU_868`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` ,`IN`, `NZ_865`, `TH`, `LORA_24`, `UA_433`, `UA_868` |   `UNSET`   |
 |      lora.hop_limit      |                                       `1`,`2`,`3`,`4`,`5`,`6`,`7`                                       |     `3`     |
-| lora.override_duty_cycle |                                             `false`, `true`                                             |   `false`   |
+|  lora.override_duty_cycle |                                            `false`, `true`                                             |   `false`   |
 
 :::tip
 
diff --git a/docs/configuration/device-config/position.mdx b/docs/configuration/device-config/position.mdx
index acab186e..a08d5984 100644
--- a/docs/configuration/device-config/position.mdx
+++ b/docs/configuration/device-config/position.mdx
@@ -74,6 +74,10 @@ Bit field of boolean configuration options for POSITION messages (bitwise OR of
 |      HEADING       |          Include positional heading (from GPS solution)          |
 |       SPEED        |           Include positional speed (from GPS solution)           |
 
+### GPIO RX/TX for GPS Module
+
+If your device does not have a fixed GPS chip, you can define the GPIO pins for the RX and TX pins of a GPS module.
+
 ## Position Config Client Availability
 
 <Tabs
@@ -121,6 +125,8 @@ All Position config commands are available in the python CLI. Example commands a
 | position.position_broadcast_smart_enabled |                                                              `true`, `false`                                                              |            `true`            |
 |     position.position_broadcast_secs      |                                                            `integer` (seconds)                                                            | Default of `0` is 15 Minutes |
 |              position.flags               | `UNSET`, `ALTITUDE`, `ALTITUDE_MSL`, `GEOIDAL_SEPARATION`, `DOP`, `HVDOP`, `PDOP`, `SATINVIEW`, `SEQ_NO`, `TIMESTAMP`, `HEADING`, `SPEED` |           `UNSET`            |
+| position.rx_gpio | `integer` (0-39) | `UNSET` |
+| position.tx_gpio | `integer` (0-34) | `UNSET` |
 
 :::tip
 
diff --git a/docs/configuration/module-config/external-notification.mdx b/docs/configuration/module-config/external-notification.mdx
index 45e3de9d..d007e9a5 100644
--- a/docs/configuration/module-config/external-notification.mdx
+++ b/docs/configuration/module-config/external-notification.mdx
@@ -8,7 +8,7 @@ sidebar_label: External Notification
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-The External Notification Module will allow you to connect a buzzer, speaker, LED, or other device to notify you when a message has been received from the mesh network.
+The External Notification Module will allow you to connect a buzzer, speaker, LED, or other device to notify you when a message has been received from the mesh network. You can enable up to 3 pins independently from each other.
 
 ## External Notification Module Config Values
 
@@ -16,21 +16,22 @@ The External Notification Module will allow you to connect a buzzer, speaker, LE
 
 Enables the external notification module.
 
-### Alert when receiving a bell
+### Alert when receiving a bell (general / LED, Vibra and Buzzer)
 
 Specifies if an alert should be triggered when receiving an incoming bell.
 
-### Alert when receiving a message
+### Alert when receiving a message (general / LED, Vibra and Buzzer)
 
 Specifies if an alert should be triggered when receiving an incoming message.
 
-### Active
+### Active (general / LED only)
 
-Specifies whether the external circuit is triggered when the device's GPIO is low or high.
+Specifies whether the external circuit is active when the device's GPIO is low or high.
 
-### GPIO to monitor
+### GPIO Pins (general / LED, Vibra and Buzzer)
 
-Specifies the GPIO that your external circuit is attached to on the device. On devices that have a PWM buzzer, you can use the buzzer for notifications by setting this to the same pin the buzzer uses.
+Specifies the GPIO that your external circuit is attached to on the device. On devices that have a PWM buzzer, you can use the buzzer for notifications by setting the use_pwm property to TRUE. The Buzzer Pin will be ignored and the device.buzzer_gpio is used instead. If you enable PWM mode, the device will use
+so-called RTTTL ring tones for notification. You can find examples of RTTTL ring tones [here](https://www.laub-home.de/wiki/RTTTL_Songs) and upload them to the device via a client application.
 
 :::info
 On ESP32 based boards, GPIOs 34 to 39 are GPIs – input only pins. These pins do not have internal pull-up or pull-down resistors. They can not be used as outputs, so you can NOT use these pins as outputs.
@@ -38,10 +39,14 @@ On ESP32 based boards, GPIOs 34 to 39 are GPIs – input only pins. These pins d
 
 ### How long monitored GPIO is triggered
 
-Specifies how long in milliseconds you would like your external circuit to be triggered.
+Specifies how long in milliseconds you would like your GPIOs to be active. In case of the repeat option, this is the duration of every tone and pause.
 
 Default of 0 is 1000ms
 
+### Repeat (Nag Timeout) (general / LED, Vibra and Buzzer)
+
+Specifies if the alert should be repeated. If set to a value greater than zero, the alert will be repeated until the user button is pressed or 'value' number of seconds have past.
+
 ## External Notification Module Config Client Availability
 
 <Tabs
@@ -80,14 +85,22 @@ All external notification module config options are available in the python CLI.
 
 :::
 
-|               Setting               |    Acceptable Values     | Default |
-| :---------------------------------: | :----------------------: | :-----: |
-|    external_notification.enabled    |     `true`, `false`      | `false` |
-|    external_notification.active     |     `true`, `false`      | `false` |
-|  external_notification.alert_bell   |     `true`, `false`      | `false` |
-| external_notification.alert_message |     `true`, `false`      | `false` |
-|    external_notification.output     |        `integer`         |   `0`   |
-|   external_notification.output_ms   | `integer` (milliseconds) |   `0`   |
+|               Setting                      |    Acceptable Values     | Default |
+| :----------------------------------------: | :----------------------: | :-----: |
+|    external_notification.enabled           |     `true`, `false`      | `false` |
+|    external_notification.active            |     `true`, `false`      | `false` |
+|  external_notification.alert_bell          |     `true`, `false`      | `false` |
+|  external_notification.alert_bell_vibra    |     `true`, `false`      | `false` |
+|  external_notification.alert_bell_buzzer   |     `true`, `false`      | `false` |
+| external_notification.alert_message        |     `true`, `false`      | `false` |
+| external_notification.alert_message_vibra  |     `true`, `false`      | `false` |
+| external_notification.alert_message_buzzer |     `true`, `false`      | `false` |
+|    external_notification.output            |        `integer`         |   `0`   |
+| external_notification.output_vibra         |        `integer`         |   `0`   |
+| external_notification.output_buzzer        |        `integer`         |   `0`   |
+|   external_notification.output_ms          | `integer` (milliseconds) |   `0`   |
+|   external_notification.use_pwm            |     `true`, `false`      | `false` |
+|   external_notification.nag_timeout        | `integer` (seconds)      |   `0`   |
 
 :::tip
 
diff --git a/src/data/regions/ua_433.ts b/src/data/regions/ua_433.ts
new file mode 100644
index 00000000..69d10cb0
--- /dev/null
+++ b/src/data/regions/ua_433.ts
@@ -0,0 +1,13 @@
+import { IRegion } from "../region";
+
+export const UA_433: IRegion = {
+  name: "UA_433",
+  freqStart: 433.0,
+  freqEnd: 434.7,
+  dutyCycle: 10,
+  spacing: 0,
+  powerLimit: 10,
+  audioPermitted: true,
+  frequencySwitching: false,
+  wideLora: false
+};
diff --git a/src/data/regions/ua_868.ts b/src/data/regions/ua_868.ts
new file mode 100644
index 00000000..a2982cd7
--- /dev/null
+++ b/src/data/regions/ua_868.ts
@@ -0,0 +1,13 @@
+import { IRegion } from "../region";
+
+export const UA_868: IRegion = {
+  name: "UA_868",
+  freqStart: 868.0,
+  freqEnd: 868.6,
+  dutyCycle: 1,
+  spacing: 0,
+  powerLimit: 14,
+  audioPermitted: true,
+  frequencySwitching: false,
+  wideLora: false
+};