From 0f8fb94f6a3b714c18a762a0164da46393318604 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Tue, 30 May 2023 16:49:52 -0500 Subject: [PATCH 1/2] Serial proto documentation --- docs/configuration/module-config/serial.mdx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/configuration/module-config/serial.mdx b/docs/configuration/module-config/serial.mdx index ad724edb..d920edad 100644 --- a/docs/configuration/module-config/serial.mdx +++ b/docs/configuration/module-config/serial.mdx @@ -35,6 +35,7 @@ Available Values: - `PROTO` Exposes the Protobuf Client API on this serial port. You can use this to connect from another device. [API Reference](/docs/development/device/client-api) - `TEXTMSG` Will send the string received over the serial port as a Text Message for Display on the other devices. - `NMEA` Will output a NMEA 0183 Data stream containing the internal GPS or fixed position and other node locations as Waypoints (WPL). +- `CALTOPO` Will output NMEA 0183 Waypoints (WPL) every 10 seconds for all valid node locations, to be consumed by [CalTopo / SARTopo](https://caltopo.com/) ### Receive GPIO Pin @@ -56,6 +57,10 @@ The serial baud rate. The amount of time to wait before we consider your packet as "done". +### Override Console Serial Port + +If set to true, this will allow Serial Module to control (set baud rate) and use the primary USB serial bus for output. This is only useful for NMEA and CalTopo modes and may behave strangely or not work at all in other modes. Setting TX/RX pins in the Serial Module config will cause this setting to be ignored. + :::tip Once module settings are changed, a **reset** is required for them to take effect. ::: From 58d208cd10fc4b5328d7a376beb8b233873f5237 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Tue, 30 May 2023 16:53:40 -0500 Subject: [PATCH 2/2] Update serial.mdx --- docs/configuration/module-config/serial.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/configuration/module-config/serial.mdx b/docs/configuration/module-config/serial.mdx index d920edad..dff4b573 100644 --- a/docs/configuration/module-config/serial.mdx +++ b/docs/configuration/module-config/serial.mdx @@ -107,11 +107,13 @@ All serial module config options are available in the python CLI. Example comman | :------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------: | | serial.enabled | `true`, `false` | `false` | | serial.echo | `true`, `false` | `false` | -| serial.mode | `DEFAULT` `SIMPLE` `PROTO` `TEXTMSG`, `NMEA` | `DEFAULT` | +| serial.mode | `DEFAULT` `SIMPLE` `PROTO` `TEXTMSG`, `NMEA`, `CALTOPO` | `DEFAULT` | | serial.rxd | GPIO Pin Number 1-39 | Default of `0` is Unset | | serial.txd | GPIO Pin Number 1-33 | Default of `0` is Unset | | serial.baud | `BAUD_DEFAULT` `BAUD_110` `BAUD_300` `BAUD_600` `BAUD_1200` `BAUD_2400` `BAUD_4800` `BAUD_9600` `BAUD_19200` `BAUD_38400` `BAUD_57600` `BAUD_115200` `BAUD_230400` `BAUD_460800` `BAUD_576000` `BAUD_921600` | `BAUD_DEFAULT` | | serial.timeout | `integer` (milli seconds) | Default of `0` corresponds to 250 ms | +| serial.override_console_serial_port | `true`, `false` | `false` | + :::tip