From 925f6a8473fe27f13540c715dea2a1c4004ac33b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20G=C3=B6ttgens?= Date: Thu, 19 Jan 2023 15:53:02 +0100 Subject: [PATCH 1/3] 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 Date: Thu, 19 Jan 2023 16:15:20 +0100 Subject: [PATCH 2/3] LF fix. Format with Trunk --- .gitattributes | 3 +++ docs/blocks/_lora-regions.mdx | 4 ++-- docs/configuration/device-config/position.mdx | 4 ++-- 3 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..5dc46e6b --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +* text=auto eol=lf +*.{cmd,[cC][mM][dD]} text eol=crlf +*.{bat,[bB][aA][tT]} text eol=crlf \ No newline at end of file diff --git a/docs/blocks/_lora-regions.mdx b/docs/blocks/_lora-regions.mdx index 04a6849a..62734e72 100644 --- a/docs/blocks/_lora-regions.mdx +++ b/docs/blocks/_lora-regions.mdx @@ -12,8 +12,8 @@ | `RU` | Russia | | `IN` | India | | `NZ_865` | New Zealand 865MHz | -| `UA_433` | Ukraine 433MHz | -| `UA_868` | Ukraine 868MHz | +| `UA_433` | Ukraine 433MHz | +| `UA_868` | Ukraine 868MHz | | `TH` | Thailand | | `LORA_24` | 2.4 GHz band worldwide | diff --git a/docs/configuration/device-config/position.mdx b/docs/configuration/device-config/position.mdx index a08d5984..bce48a09 100644 --- a/docs/configuration/device-config/position.mdx +++ b/docs/configuration/device-config/position.mdx @@ -125,8 +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` | +| position.rx_gpio | `integer` (0-39) | `UNSET` | +| position.tx_gpio | `integer` (0-34) | `UNSET` | :::tip From 99be6a5249ff3cb5298fc2d3ca0fed6770c6a561 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20G=C3=B6ttgens?= Date: Tue, 24 Jan 2023 10:03:24 +0100 Subject: [PATCH 3/3] trunk --- docs/configuration/device-config/display.mdx | 32 +++++++++---------- docs/configuration/device-config/lora.mdx | 10 +++--- .../module-config/external-notification.mdx | 24 +++++++------- 3 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/configuration/device-config/display.mdx b/docs/configuration/device-config/display.mdx index bb5db5a7..60ea437a 100644 --- a/docs/configuration/device-config/display.mdx +++ b/docs/configuration/device-config/display.mdx @@ -53,12 +53,12 @@ The type of OLED Controller is auto-detected by default, but can be defined with Acceptable values: -| Value | Description | -| :------------: | :----------------------------: | -| `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) | +| Value | Description | +| :------------: | :-----------------------------------------: | +| `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 @@ -106,17 +106,17 @@ All display config options are available in the python CLI. Example commands are ::: -| Setting | Acceptable Values | Default | -| --------------------------------- | ------------------------------------------ | ---------------------------- | -| display.auto_screen_carousel_secs | `integer` | Default of `0` is 10 minutes | -| display.compass_north_top | `false`, `true` | `false` | -| display.flip_screen | `fasle`, `true` | `false` | -| display.gps_format | `DEC`, `DMS`, `UTM`, `MGRS`, `OLC`, `OSGR` | `DEC` | +| Setting | Acceptable Values | Default | +| --------------------------------- | --------------------------------------------------------- | ---------------------------- | +| display.auto_screen_carousel_secs | `integer` | Default of `0` is 10 minutes | +| 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_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` | +| 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 fe9b8562..21a0e008 100644 --- a/docs/configuration/device-config/lora.mdx +++ b/docs/configuration/device-config/lora.mdx @@ -114,12 +114,12 @@ 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` | +| 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`, `UA_433`, `UA_868` | `UNSET` | -| lora.hop_limit | `1`,`2`,`3`,`4`,`5`,`6`,`7` | `3` | -| lora.override_duty_cycle | `false`, `true` | `false` | +| lora.hop_limit | `1`,`2`,`3`,`4`,`5`,`6`,`7` | `3` | +| lora.override_duty_cycle | `false`, `true` | `false` | :::tip diff --git a/docs/configuration/module-config/external-notification.mdx b/docs/configuration/module-config/external-notification.mdx index d007e9a5..823dbdaa 100644 --- a/docs/configuration/module-config/external-notification.mdx +++ b/docs/configuration/module-config/external-notification.mdx @@ -85,22 +85,22 @@ All external notification module config options are available in the python CLI. ::: -| Setting | Acceptable Values | Default | +| 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.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 | `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` | +| 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