From 7ca2e57faa07c8976af0aa6135b51107ae7117a5 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Fri, 24 Jun 2022 19:40:15 -0700 Subject: [PATCH] 1.3 Config updates --- docs/settings/config/device.mdx | 110 +++++++++++++++++++++++++++++++ docs/settings/config/display.mdx | 100 ++++++++++++++++++++++++++++ 2 files changed, 210 insertions(+) create mode 100644 docs/settings/config/device.mdx create mode 100644 docs/settings/config/display.mdx diff --git a/docs/settings/config/device.mdx b/docs/settings/config/device.mdx new file mode 100644 index 00000000..fd37b4cf --- /dev/null +++ b/docs/settings/config/device.mdx @@ -0,0 +1,110 @@ +--- +id: device +title: Device Configuration +sidebar_label: Device +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +The device config options are: Role, Serial Output, Debug Log, NTP Server and Factory Reset. Device config uses an admin message sending a `Config.Device` protobuf. + +## Device Config Values + +### Role +Sets the role of node. + +Acceptable values: + +| Value | Description | +| :-------: | :---------------------------------------------------------------------------------------: | +| `client` | Client (default) - App connected client. | +| `clientMute` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | +| `router` | Router - Mesh packets will prefer to be routed over this node. This node will not be used by client apps. The wifi/ble radios and the oled screen will be put to sleep. | +| `routerClient` | Router Client - Mesh packets will prefer to be routed over this node. The Router Client can be used as both a Router and an app connected Client. | + + +### Serial Console +Acceptable values: `true` or `false` + +On by default. If set to true this will disable the serial console by not initilizing the StreamAPI. + +### Debug Log +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. + +### NTP Server +Acceptable value: `string` + +NTP server to use if WiFi is conneced, defaults to `0.pool.ntp.org` + +### Factory Reset +Acceptable values: `true` or `false` + +This setting is never saved to disk, but if set, all device settings will be returned to factory defaults. + +## Device Config Client Availability + + + + +:::info +Device config is not available for Android. +::: + + + + +:::info +All device config options other than NTP Server are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Device. + +WiFi related settings are not available on Apple OS's. +::: + + + + +All device config options are available in the python CLI. Example commands are below: + +```shell title="Set the role to client" +meshtastic --set role client +``` + +```shell title="Disable serial console" +meshtastic --set serial_disabled true +``` + +```shell title="Enable debug logging" +meshtastic --set debug_log_enabled true +``` + +```shell title="Factory reset your radio" +meshtastic --set factory_reset true +``` + + + + +:::info +Device config is not available in the Flasher. +::: + + + + +:::info +Device config is not available for the Web UI. +::: + + + \ No newline at end of file diff --git a/docs/settings/config/display.mdx b/docs/settings/config/display.mdx new file mode 100644 index 00000000..967859c7 --- /dev/null +++ b/docs/settings/config/display.mdx @@ -0,0 +1,100 @@ +--- +id: display +title: Display Configuration +sidebar_label: Display +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +The display config options are: Screen On Duration, Auto Carousel Interval, and GPS Format. Display config uses an admin message sending a `Config.Display` protobuf. + +## Device Config Values + +### Screen On Duration +How long the screen remains on after the user button is pressed or messages are received. + +### Auto Carousel Interval + +Automatically toggles to the next page on the screen like a carousel, based the specified interval. +### GPS Format + +The format used to display GPS coordinates on the device screen. + +Acceptable values: + +| Value | Description | +| :-------: | :--------------------------: | +| `gpsFormatDec` | Decimal Degrees | +| `gpsFormatDms` | Degrees Minutes Seconds | +| `gpsFormatUtm` | Universal Transverse Mercator | +| `gpsFormatMgrs` | Military Grid Reference System | +| `gpsFormatOlc` | Open Location Code (Plus Codes) | +| `gpsFormatOsgr` | Ordnance Survey Grid Reference | + +## Device Config Client Availability + + + + +:::info +Display config is not available for Android. +::: + + + + +:::info +All display config options are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Display. +::: + + + + +All display config options are available in the python CLI. Example commands are below: + +```shell title="Set display_screen_on_secs to default (10 minutes)" +meshtastic --set display_screen_on_secs 0 +``` + +```shell title="Set display_screen_on_secs to 120 seconds (2 minutes)" +meshtastic --set display_screen_on_secs 120 +``` + +```shell title="Set display_auto_screen_carousel_secs to default value of off" +meshtastic --set display_auto_screen_carousel_secs 0 +``` + +```shell title="Set display_auto_screen_carousel_secs to 120 seconds (2 minutes)" +meshtastic --set display_auto_screen_carousel_secs 120 +``` + +```shell title="Specify GPS format on device screen" +meshtastic --set display_gps_format GpsFormatUTM +``` + + + + +:::info +Display config is not available in the Flasher. +::: + + + + +:::info +Display config is not available in the Web UI. +::: + + + \ No newline at end of file