meshtastic 0.0.179 → 0.0.180

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa03c5234c1b6d136fca93a0a37a5c9dd6588b116b6f932f457f4e139eee89c
-  data.tar.gz: 54d66239895c5989f8f8ee5423e63d05769bdecd6281d59d914b31561177fabd
+  metadata.gz: f12d73c0e68d9f1171a2b92d2cfe2277d22e4e78c7c33788cc52924ee6d40778
+  data.tar.gz: b0be149633c2a659dcea3ce83546f9a2ea5121f632a90bb3ee9b21a43ae79221
 SHA512:
-  metadata.gz: fd7705cf063ef5448b167dc7d3f1664dea20cc25ff1b1791a72de2e4a656afc11ef5717969b4171f65736448616e05f985a9a5c40dc11196559b9767a2b5b286
-  data.tar.gz: 506c41dfa105d57a5fae6febd3fa9748f30319c1a280f0ebbc5412d1bfd8b9f9330c337aba25033ee06e9fbc10fa4c600a28cecd61baab145422ec02162df238
+  metadata.gz: a4d41dbc793a0eb380cbfb815ce9cd15ac98802e80a3903ea7ed765d09c42ff9a4009a2d68ff44338026e553f18fd7d96d4419233018185ff3f733735b033149
+  data.tar.gz: d035c8f9c42d536ad97bdefc0de870dff4694ef651c86dd1e7002ada63145f089e9e70a74d73144ebac991d0d9dd8365f5c53ae0b0b6154c466d99f849e4b34a

data/documentation/README.md

@@ -28,8 +28,9 @@ Do not open Serial and Bluetooth to the same radio at once. Always `disconnect`
 ## Feature modules
 
 - [Meshtastic::Admin](admin.md)
-- [Meshtastic::Channel](channel.md)
-- [Meshtastic::Config](config.md)
+- [Meshtastic::Admin::Channel](admin-channel.md)
+- [Meshtastic::Admin::Config](admin-config.md)
+- [Meshtastic::Admin::Firmware](admin-firmware.md)
 - [Meshtastic::ModuleConfig](module-config.md)
 - [Meshtastic::Position](position.md)
 - [Meshtastic::Telemetry](telemetry.md)

data/documentation/admin-channel.md

@@ -0,0 +1,33 @@
+# Meshtastic::Admin::Channel
+
+Admin get/set for mesh channels. The generated protobuf remains `Meshtastic::Channel`; this module talks to the node on `ADMIN_APP`.
+
+Roles: `:PRIMARY`, `:SECONDARY`, `:DISABLED`.
+
+## Methods
+
+- `build_settings` — `ChannelSettings` (name, psk, uplink/downlink, AEAD)
+- `build` — `Channel` (index, role, settings)
+- `get(index:)` — `get_channel_request`
+- `set` — `set_channel` with a Channel protobuf
+- `help` / `authors`
+
+Do not pass a Channel protobuf as MeshInterface `channel:` (that field is the numeric channel index). This module strips that key before send.
+
+## Example
+
+```ruby
+settings = Meshtastic::Admin::Channel.build_settings(name: 'LongFast', uplink_enabled: true)
+Meshtastic::Admin::Channel.set(
+  serial_obj: serial_obj,
+  index: 0,
+  role: :PRIMARY,
+  settings: settings
+)
+Meshtastic::Admin::Channel.get(serial_obj: serial_obj, index: 0)
+```
+
+## Related
+
+- [Meshtastic::Admin](admin.md)
+- [Meshtastic::Admin::Config](admin-config.md)

data/documentation/admin-config.md

@@ -0,0 +1,28 @@
+# Meshtastic::Admin::Config
+
+Admin get/set for radio `Meshtastic::Config` sections. The generated protobuf remains `Meshtastic::Config`.
+
+## Methods
+
+- `get(config_type:)` — default `:DEVICE_CONFIG`
+- `set(config:)`
+- Named getters: `get_device`, `get_position`, `get_power`, `get_network`, `get_display`, `get_lora`, `get_bluetooth`, `get_security`, `get_sessionkey`, `get_device_ui`
+- `set_device(device:)`, `set_lora(lora:)`
+- `help` / `authors`
+
+`config_type` values: `:DEVICE_CONFIG`, `:POSITION_CONFIG`, `:POWER_CONFIG`, `:NETWORK_CONFIG`, `:DISPLAY_CONFIG`, `:LORA_CONFIG`, `:BLUETOOTH_CONFIG`, `:SECURITY_CONFIG`, `:SESSIONKEY_CONFIG`, `:DEVICEUI_CONFIG`.
+
+## Example
+
+```ruby
+Meshtastic::Admin::Config.get_lora(serial_obj: serial_obj)
+
+config = Meshtastic::Config.new
+config.device = Meshtastic::Config::DeviceConfig.new(role: :CLIENT)
+Meshtastic::Admin::Config.set(serial_obj: serial_obj, config: config)
+```
+
+## Related
+
+- [Meshtastic::Admin](admin.md)
+- [Meshtastic::Admin::Channel](admin-channel.md)

data/documentation/admin-firmware.md

@@ -0,0 +1,69 @@
+# Meshtastic::Admin::Firmware
+
+Install Meshtastic firmware using the PhoneAPI / admin path (not esptool). Nested under [Admin](admin.md) because OTA is an `AdminMessage`.
+
+## What it does
+
+1. SHA-256 the image (`-update.bin` for ESP32 BLE/WiFi OTA).
+2. Send `ota_request` (`OTAEvent`: 32-byte hash + `:OTA_BLE` or `:OTA_WIFI`) on `ADMIN_APP`.
+3. On serial / TCP / Bluetooth, stream the image as `ToRadio.xmodemPacket` (SOH 128-byte blocks, CRC16, EOT). MQTT has no PhoneAPI XModem; it only publishes the admin `ota_request` so the node can reboot into OTA.
+
+`enter_dfu` sends `enter_dfu_mode_request` (nRF52 USB UF2 / serial DFU). `reboot_ota(seconds:)` is the older `reboot_ota_seconds` field.
+
+Use a firmware file that matches the board. Interrupting a flash can brick the radio. Keep battery high.
+
+This is not the web flasher / `esptool` USB bootloader path, and not nRF `.zip` via `adafruit-nrfutil`.
+
+## Methods
+
+- `install(firmware:, mode:, serial_obj: | tcp_obj: | bluetooth_obj: | mqtt_obj:)`
+- `request_ota` — admin hash + mode only
+- `enter_dfu`
+- `reboot_ota(seconds: 10)`
+- `xmodem_blocks(bytes)` / `send_xmodem(xmodem:)`
+- `sha256`
+- `help` / `authors`
+
+`mode:` is `:OTA_BLE` or `:OTA_WIFI`. `firmware:` is a path; `bytes:` is raw image bytes.
+
+## Serial / TCP / Bluetooth
+
+```ruby
+Meshtastic::Admin::Firmware.install(
+  serial_obj: serial_obj,
+  firmware: 'firmware-heltec-v3-update.bin',
+  mode: :OTA_BLE
+)
+
+Meshtastic::Admin::Firmware.install(
+  tcp_obj: tcp_obj,
+  firmware: 'firmware-heltec-v3-update.bin',
+  mode: :OTA_WIFI
+)
+
+Meshtastic::Admin::Firmware.install(
+  bluetooth_obj: bluetooth_obj,
+  firmware: 'firmware-heltec-v3-update.bin',
+  mode: :OTA_BLE
+)
+```
+
+## MQTT (remote admin)
+
+Publishes one encrypted `ADMIN_APP` envelope. The node must accept remote admin. It does not push XModem over the broker.
+
+```ruby
+Meshtastic::Admin::Firmware.install(
+  mqtt_obj: mqtt_obj,
+  firmware: 'firmware-heltec-v3-update.bin',
+  mode: :OTA_WIFI,
+  to: '!aabbccdd',
+  psks: { LongFast: 'AQ==' }
+)
+```
+
+## Related
+
+- [Meshtastic::Admin](admin.md)
+- [Meshtastic::Xmodem](xmodem.md)
+- [Meshtastic::MQTT](mqtt.md)

data/documentation/admin.md

@@ -1,6 +1,6 @@
 # Meshtastic::Admin
 
-Builds `Meshtastic::AdminMessage` and sends it on `ADMIN_APP` (port 6) through [Meshtastic.deliver_data](meshtastic.md). Pass a connected `serial_obj`, `bluetooth_obj`, or `tcp_obj`.
+Builds `Meshtastic::AdminMessage` and sends it on `ADMIN_APP` (port 6) through [Meshtastic.deliver_data](meshtastic.md). Pass a connected `serial_obj`, `bluetooth_obj`, `tcp_obj`, or `mqtt_obj`.
 
 Responses come back as `FromRadio` packets on the same transport (`subscribe` / `recv_from_radio`).
 
@@ -48,6 +48,7 @@ Meshtastic::Admin.send(
 
 ## Related
 
+- [Meshtastic::Admin::Firmware](admin-firmware.md)
 - [Meshtastic::Channel](channel.md)
 - [Meshtastic::Config](config.md)
 - [Meshtastic::ModuleConfig](module-config.md)

data/documentation/atak.md

@@ -1,27 +1,110 @@
 # Meshtastic::ATAK
 
-Encodes `Meshtastic::TAKPacket` and sends it on `ATAK_PLUGIN` (port 72).
+TAK / ATAK over Meshtastic. Three wire formats, same as the official clients:
+
+| Format | Port | Payload |
+| --- | --- | --- |
+| V1 `ATAK_PLUGIN` | 72 | Bare `TAKPacket` (PLI, GeoChat, optional `detail` bytes) |
+| V2 `ATAK_PLUGIN_V2` | 78 | `[flags][TAKPacketV2]`. This gem emits uncompressed frames (`flags=0xFF`) |
+| V1 `ATAK_FORWARDER` | 257 | zlib-compressed CoT XML (single packet, max `DATA_PAYLOAD_LEN`) |
+
+V2 typed payloads: GeoChat, aircraft, shapes, markers, range-and-bearing, routes, CASEVAC, emergency, task, TAKTALK, raw detail. Contact / group / status on V1; callsign / team / role / lat-lon on V2.
+
+Firmware ≥ 2.8.0 speaks V2. Older radios use V1 PLI/chat, and generic CoT on the forwarder port.
+
+Compressed V2 (zstd dictionary id 0 or 1) is not unpacked here; `decode_v2` raises unless `flags=0xFF`.
 
 ## Methods
 
-- `encode(is_compressed:, chat:, message:)` — `message:` builds a `GeoChat`
-- `send`
+- `encode` / `encode_v1` — `TAKPacket`
+- `send` / `send_v1` / `send_chat` / `send_pli` — port 72
+- `build_v2` / `encode_v2` / `wrap_v2` / `decode_v2` / `send_v2` — port 78
+- `compress_cot` / `decompress_cot` / `send_cot` — port 257 (`cot:` XML string)
+- `decode(payload:, portnum:)` — dispatches on port
 - `help` / `authors`
 
-## Example
+`lat` / `lon` are decimal degrees (stored × 1e7). Pass a connected `serial_obj`, `bluetooth_obj`, or `tcp_obj`.
+
+## V1 GeoChat and PLI
 
 ```ruby
-Meshtastic::ATAK.send(
+Meshtastic::ATAK.send_chat(
+  serial_obj: serial_obj,
+  message: 'ATAK chat',
+  to: 'ANDROID-aabbccdd',
+  callsign: 'ALPHA',
+  device_callsign: 'RADIO-1',
+  team: :Cyan,
+  role: :TeamMember,
+  battery: 87
+)
+
+Meshtastic::ATAK.send_pli(
+  serial_obj: serial_obj,
+  lat: 37.7749,
+  lon: -122.4194,
+  altitude: 10,
+  speed: 0,
+  course: 90,
+  callsign: 'ALPHA',
+  team: :Cyan
+)
+```
+
+## V2 typed events
+
+```ruby
+Meshtastic::ATAK.send_v2(serial_obj: serial_obj, message: 'v2 chat', callsign: 'ALPHA')
+
+Meshtastic::ATAK.send_v2(
   serial_obj: serial_obj,
-  message: 'ATAK chat'
+  callsign: 'ALPHA',
+  lat: 37.7749,
+  lon: -122.4194,
+  aircraft: Meshtastic::AircraftTrack.new(icao: 'ABC123', flight: 'N1')
 )
 
-packet = Meshtastic::ATAK.encode(message: 'ATAK chat')
-packet.chat.message # => "ATAK chat"
+Meshtastic::ATAK.send_v2(serial_obj: serial_obj, shape: Meshtastic::DrawnShape.new(kind: :Kind_Circle, major_cm: 1000))
+Meshtastic::ATAK.send_v2(serial_obj: serial_obj, marker: Meshtastic::Marker.new(kind: :Kind_Spot))
+Meshtastic::ATAK.send_v2(serial_obj: serial_obj, route: Meshtastic::Route.new(prefix: 'R1'))
+Meshtastic::ATAK.send_v2(serial_obj: serial_obj, casevac: Meshtastic::CasevacReport.new(title: 'CASEVAC'))
+Meshtastic::ATAK.send_v2(serial_obj: serial_obj, emergency: Meshtastic::EmergencyAlert.new(type: :Type_Alert911))
+Meshtastic::ATAK.send_v2(serial_obj: serial_obj, task: Meshtastic::TaskRequest.new(task_type: 'recon'))
+Meshtastic::ATAK.send_v2(serial_obj: serial_obj, taktalk: Meshtastic::TakTalkMessage.new(text: 'hi', chatroom_id: 'room1'))
 ```
 
-Related protobufs: `TAKPacket`, `GeoChat`, `Contact`, `Group`, `PLI`, `TAKPacketV2`. See [protobufs.md](protobufs.md).
+Receive V2:
+
+```ruby
+Meshtastic::Serial.subscribe(serial_obj: serial_obj, include: 'ATAK_PLUGIN') do |message|
+  port = message.dig(:packet, :decoded, :portnum)
+  payload = message.dig(:packet, :decoded, :payload)
+  decoded = Meshtastic::ATAK.decode(payload: payload, portnum: port)
+  p decoded
+end
+```
+
+## Generic CoT (forwarder)
+
+```ruby
+Meshtastic::ATAK.send_cot(
+  serial_obj: serial_obj,
+  cot: '<event type="b-m-p-s-m" uid="marker-1"><point lat="37.77" lon="-122.41"/></event>'
+)
+```
+
+Raises if zlib output exceeds `Meshtastic::Constants::DATA_PAYLOAD_LEN`. Multi-packet fountain (FTN) is not implemented; keep CoT small or use V2 typed payloads.
+
+## Radio TAK module
+
+Device role `TAK` / `TAK_TRACKER` and Module Config → TAK (`team` / `role`) are [Admin](admin.md) / [ModuleConfig](module-config.md), not this client:
+
+```ruby
+Meshtastic::ModuleConfig.get(serial_obj: serial_obj, module_config_type: :TAK_CONFIG)
+```
 
 ## Related
 
-- [Meshtastic::ModuleConfig](module-config.md) (`:TAK_CONFIG`)
+- [Meshtastic::ModuleConfig](module-config.md)
+- [Generated protobuf types](protobufs.md)
+- [TAK wire formats](https://meshtastic.org/docs/software/apple/developer/tak-protocol/)

data/documentation/channel.md

@@ -1,30 +1,3 @@
 # Meshtastic::Channel
 
-Reopens the generated `Meshtastic::Channel` protobuf class with get/set helpers that call [Admin](admin.md).
-
-This is a protobuf class, not a Ruby module. Do not add class methods named `send` or `encode`.
-
-## Methods
-
-- `get(serial_obj:, index:)` — `get_channel_request`
-- `set(serial_obj:, channel:)` — `set_channel`
-- `help` / `authors`
-
-Also all protobuf instance fields: `index`, `settings` (`ChannelSettings`), `role` (`:DISABLED`, `:PRIMARY`, `:SECONDARY`).
-
-## Example
-
-```ruby
-Meshtastic::Channel.get(serial_obj: serial_obj, index: 0)
-
-settings = Meshtastic::ChannelSettings.new(name: 'LongFast', psk: "\x01")
-channel = Meshtastic::Channel.new(index: 0, settings: settings, role: :PRIMARY)
-Meshtastic::Channel.set(serial_obj: serial_obj, channel: channel)
-```
-
-Listen for `ADMIN_APP` replies on the same transport.
-
-## Related
-
-- [Meshtastic::Admin](admin.md)
-- [Meshtastic::Apponly](apponly.md) (`ChannelSet`)
+Generated protobuf (`index`, `settings`, `role`). Get/set on a live node is [Meshtastic::Admin::Channel](admin-channel.md).

data/documentation/config.md

@@ -1,29 +1,3 @@
 # Meshtastic::Config
 
-Reopens the generated `Meshtastic::Config` protobuf class. Get/set go through [Admin](admin.md).
-
-## Methods
-
-- `get(serial_obj:, config_type: :DEVICE_CONFIG)`
-- `set(serial_obj:, config:)` — `config` is a `Meshtastic::Config`
-- `help` / `authors`
-
-Protobuf oneofs include `device`, `position`, `power`, `network`, `display`, `lora`, `bluetooth`, `security`, `sessionkey`, `device_ui`.
-
-## Example
-
-```ruby
-Meshtastic::Config.get(serial_obj: serial_obj, config_type: :LORA_CONFIG)
-
-config = Meshtastic::Config.new
-config.device = Meshtastic::Config::DeviceConfig.new(role: :CLIENT)
-Meshtastic::Config.set(serial_obj: serial_obj, config: config)
-```
-
-`config_type` list: [Admin](admin.md).
-
-## Related
-
-- [Meshtastic::Admin](admin.md)
-- [Meshtastic::ModuleConfig](module-config.md)
-- [Meshtastic::Localonly](localonly.md)
+Generated protobuf (device, position, power, network, display, lora, bluetooth, security, sessionkey, device_ui). Get/set on a live node is [Meshtastic::Admin::Config](admin-config.md).

data/documentation/meshtastic.md

@@ -31,13 +31,13 @@ Routes a `Meshtastic::Data` payload to a connected radio.
 
 ```ruby
 Meshtastic.deliver_data(
-  serial_obj: serial_obj,   # or bluetooth_obj: or tcp_obj:
+  serial_obj: serial_obj,   # or bluetooth_obj: / tcp_obj: / mqtt_obj:
   data: Meshtastic::Data.new(portnum: :TEXT_MESSAGE_APP, payload: 'hi'),
   port_num: Meshtastic::PortNum::TEXT_MESSAGE_APP
 )
 ```
 
-Raises `ArgumentError` unless `data` is a `Meshtastic::Data` and one of `serial_obj`, `bluetooth_obj`, or `tcp_obj` is present.
+Raises `ArgumentError` unless `data` is a `Meshtastic::Data` and one of `serial_obj`, `bluetooth_obj`, `tcp_obj`, or `mqtt_obj` is present.
 
 ## Related
 

data/lib/meshtastic/admin/channel.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'meshtastic/channel_pb'
+
+module Meshtastic
+  module Admin
+    module Channel
+      public_class_method def self.build_settings(opts = {})
+        settings = opts[:settings] || Meshtastic::ChannelSettings.new
+        settings.name = opts[:name].to_s if opts[:name]
+        settings.psk = opts[:psk] if opts[:psk]
+        settings.channel_num = opts[:channel_num].to_i if opts[:channel_num]
+        settings.id = opts[:id].to_i if opts[:id]
+        settings.uplink_enabled = opts[:uplink_enabled] unless opts[:uplink_enabled].nil?
+        settings.downlink_enabled = opts[:downlink_enabled] unless opts[:downlink_enabled].nil?
+        settings.module_settings = opts[:module_settings] if opts[:module_settings]
+        settings.use_aead = opts[:use_aead] unless opts[:use_aead].nil?
+        settings
+      end
+
+      public_class_method def self.build(opts = {})
+        channel = opts[:channel] || Meshtastic::Channel.new
+        channel.index = opts[:index].to_i if opts[:index]
+        channel.role = opts[:role] if opts[:role]
+        channel.settings = opts[:settings] || build_settings(opts.merge({}))
+        channel
+      end
+
+      public_class_method def self.get(opts = {})
+        index = opts[:index]
+        index = 0 if index.nil?
+        Admin.get_channel(opts.merge(index: index))
+      end
+
+      public_class_method def self.set(opts = {})
+        channel = opts[:channel] || build(opts.merge({}))
+        merged = opts.merge(channel_settings: channel)
+        merged.delete(:channel)
+        Admin.set_channel(merged)
+      end
+
+      public_class_method def self.authors
+        "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+      end
+
+      public_class_method def self.help
+        puts "USAGE:
+          # Build ChannelSettings for a mesh channel.
+          #{self}.build_settings(
+            settings: 'optional - existing ChannelSettings protobuf to fill',
+            name: 'optional - channel name such as LongFast',
+            psk: 'optional - raw PSK bytes for the channel',
+            channel_num: 'optional - LoRa channel number',
+            id: 'optional - channel hash id',
+            uplink_enabled: 'optional - whether MQTT uplink is enabled',
+            downlink_enabled: 'optional - whether MQTT downlink is enabled',
+            module_settings: 'optional - ModuleSettings protobuf',
+            use_aead: 'optional - whether AEAD crypto is enabled'
+          )
+
+          # Build a Channel protobuf with index, role, and settings.
+          #{self}.build(
+            channel: 'optional - existing Channel protobuf to fill',
+            index: 'optional - channel slot index on the node',
+            role: 'optional - :PRIMARY, :SECONDARY, or :DISABLED',
+            settings: 'optional - ChannelSettings protobuf to attach'
+          )
+
+          # Request a channel slot from the node.
+          #{self}.get(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect',
+            index: 'optional - channel slot index to request (default: 0)'
+          )
+
+          # Write a channel slot on the node.
+          #{self}.set(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect',
+            channel: 'optional - Channel protobuf to write',
+            index: 'optional - channel slot index when building a channel',
+            role: 'optional - :PRIMARY, :SECONDARY, or :DISABLED',
+            settings: 'optional - ChannelSettings protobuf to attach'
+          )
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+      end
+    end
+  end
+end

data/lib/meshtastic/admin/config.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require 'meshtastic/config_pb'
+
+module Meshtastic
+  module Admin
+    module Config
+      public_class_method def self.get(opts = {})
+        Admin.get_config(opts.merge(config_type: opts[:config_type] || :DEVICE_CONFIG))
+      end
+
+      public_class_method def self.set(opts = {})
+        Admin.set_config(opts.merge(config: opts[:config]))
+      end
+
+      public_class_method def self.get_device(opts = {})
+        get(opts.merge(config_type: :DEVICE_CONFIG))
+      end
+
+      public_class_method def self.get_position(opts = {})
+        get(opts.merge(config_type: :POSITION_CONFIG))
+      end
+
+      public_class_method def self.get_power(opts = {})
+        get(opts.merge(config_type: :POWER_CONFIG))
+      end
+
+      public_class_method def self.get_network(opts = {})
+        get(opts.merge(config_type: :NETWORK_CONFIG))
+      end
+
+      public_class_method def self.get_display(opts = {})
+        get(opts.merge(config_type: :DISPLAY_CONFIG))
+      end
+
+      public_class_method def self.get_lora(opts = {})
+        get(opts.merge(config_type: :LORA_CONFIG))
+      end
+
+      public_class_method def self.get_bluetooth(opts = {})
+        get(opts.merge(config_type: :BLUETOOTH_CONFIG))
+      end
+
+      public_class_method def self.get_security(opts = {})
+        get(opts.merge(config_type: :SECURITY_CONFIG))
+      end
+
+      public_class_method def self.get_sessionkey(opts = {})
+        get(opts.merge(config_type: :SESSIONKEY_CONFIG))
+      end
+
+      public_class_method def self.get_device_ui(opts = {})
+        get(opts.merge(config_type: :DEVICEUI_CONFIG))
+      end
+
+      public_class_method def self.set_device(opts = {})
+        config = Meshtastic::Config.new
+        config.device = opts[:device]
+        set(opts.merge(config: config))
+      end
+
+      public_class_method def self.set_lora(opts = {})
+        config = Meshtastic::Config.new
+        config.lora = opts[:lora]
+        set(opts.merge(config: config))
+      end
+
+      public_class_method def self.authors
+        "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+      end
+
+      public_class_method def self.help
+        puts "USAGE:
+          # Request a radio Config section by ConfigType.
+          #{self}.get(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect',
+            config_type: 'optional - :DEVICE_CONFIG or another ConfigType (default: :DEVICE_CONFIG)'
+          )
+
+          # Write a Config protobuf to the node.
+          #{self}.set(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect',
+            config: 'required - Meshtastic::Config protobuf to write'
+          )
+
+          # Request DEVICE_CONFIG from the node.
+          #{self}.get_device(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Request POSITION_CONFIG from the node.
+          #{self}.get_position(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Request POWER_CONFIG from the node.
+          #{self}.get_power(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Request NETWORK_CONFIG from the node.
+          #{self}.get_network(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Request DISPLAY_CONFIG from the node.
+          #{self}.get_display(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Request LORA_CONFIG from the node.
+          #{self}.get_lora(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Request BLUETOOTH_CONFIG from the node.
+          #{self}.get_bluetooth(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Request SECURITY_CONFIG from the node.
+          #{self}.get_security(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Request SESSIONKEY_CONFIG from the node.
+          #{self}.get_sessionkey(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Request DEVICEUI_CONFIG from the node.
+          #{self}.get_device_ui(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect'
+          )
+
+          # Write DeviceConfig wrapped in a Config protobuf.
+          #{self}.set_device(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect',
+            device: 'required - Meshtastic::Config::DeviceConfig protobuf to write'
+          )
+
+          # Write LoRaConfig wrapped in a Config protobuf.
+          #{self}.set_lora(
+            serial_obj: 'optional - serial handle from Meshtastic::Serial.connect',
+            lora: 'required - Meshtastic::Config::LoRaConfig protobuf to write'
+          )
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+      end
+    end
+  end
+end