meshtastic 0.0.178 → 0.0.180

data/documentation/protobufs.md

@@ -0,0 +1,162 @@
+# Generated protobuf types
+
+These classes and enums come from `lib/meshtastic/*_pb.rb` (Meshtastic protobufs via `grpc_tools_ruby_protoc`). They live in the `Meshtastic` namespace. Typical API:
+
+```ruby
+msg = Meshtastic::User.new(long_name: 'Node', short_name: 'N1')
+bytes = msg.to_proto
+again = Meshtastic::User.decode(bytes)
+msg.to_h
+```
+
+Enums: `Meshtastic::PortNum::TEXT_MESSAGE_APP`, `Meshtastic::PortNum.lookup(1)`, `Meshtastic::PortNum.resolve(:TEXT_MESSAGE_APP)`.
+
+A few generated **classes** are reopened with extra class methods: `Channel`, `Config`, `ModuleConfig`, `Paxcount`, `Position`, `Telemetry`. Do not name those extras `send` or `encode`.
+
+First-class wrappers for many of these types: [documentation index](README.md).
+
+## admin.proto
+
+- Messages: `AdminMessage`, `AdminMessage::InputEvent`, `AdminMessage::OTAEvent`, `LockdownAuth`, `HamParameters`, `NodeRemoteHardwarePinsResponse`, `SharedContact`, `KeyVerificationAdmin`, `SensorConfig`, `SCD4X_config`, `SEN5X_config`, `SEN6X_config`, `SCD30_config`, `SHTXX_config`, `DS248X_config`, `AS3935_config`
+- Enums: `AdminMessage::ConfigType`, `AdminMessage::ModuleConfigType`, `AdminMessage::BackupLocation`, `KeyVerificationAdmin::MessageType`, `OTAMode`
+
+See [Admin](admin.md).
+
+## apponly.proto
+
+- `ChannelSet` — [Apponly](apponly.md)
+
+## atak.proto
+
+- Messages: `TAKPacket`, `GeoChat`, `Group`, `Status`, `Contact`, `PLI`, `AircraftTrack`, `CotGeoPoint`, `DrawnShape`, `Marker`, `RangeAndBearing`, `Route`, `Route::Link`, `CasevacReport`, `ZMistEntry`, `EmergencyAlert`, `TaskRequest`, `TAKEnvironment`, `SensorFov`, `TakTalkMessage`, `TakTalkRoomData`, `Marti`, `TAKPacketV2`
+- Enums: `GeoChat::ReceiptType`, `DrawnShape::Kind`, `DrawnShape::StyleMode`, `Marker::Kind`, `Route::Method`, `Route::Direction`, `CasevacReport::Precedence`, `CasevacReport::HlzMarking`, `CasevacReport::Security`, `EmergencyAlert::Type`, `TaskRequest::Priority`, `TaskRequest::Status`, `SensorFov::SensorType`, `Team`, `MemberRole`, `CotHow`, `CotType`, `GeoPointSource`
+
+See [ATAK](atak.md).
+
+## cannedmessages.proto
+
+- `CannedMessageModuleConfig` — [Cannedmessages](cannedmessages.md)
+
+## channel.proto
+
+- `ChannelSettings`, `ModuleSettings`, `Channel`, `Channel::Role` — [Channel](channel.md)
+
+## clientonly.proto
+
+- `DeviceProfile` — [Clientonly](clientonly.md)
+
+## config.proto
+
+- `Config` and nested `DeviceConfig`, `PositionConfig`, `PowerConfig`, `NetworkConfig`, `DisplayConfig`, `LoRaConfig`, `BluetoothConfig`, `SecurityConfig`, `SessionkeyConfig` plus their enums — [Config](config.md)
+
+## connection_status.proto
+
+- `DeviceConnectionStatus`, `WifiConnectionStatus`, `EthernetConnectionStatus`, `NetworkConnectionStatus`, `BluetoothConnectionStatus`, `SerialConnectionStatus` — [ConnectionStatus](connection-status.md)
+
+## device_ui.proto
+
+- `DeviceUIConfig`, `NodeFilter`, `NodeHighlight`, `GeoPoint`, `Map`
+- Enums: `DeviceUIConfig::GpsCoordinateFormat`, `CompassMode`, `Theme`, `Language`
+
+No dedicated wrapper; set via Admin `DEVICEUI_CONFIG` / `Config.device_ui`.
+
+## deviceonly.proto / deviceonly_legacy.proto
+
+- `PositionLite`, `UserLite`, `NodeInfoLite`, `DeviceState`, `NodePositionEntry`, `NodeTelemetryEntry`, `NodeEnvironmentEntry`, `NodeStatusEntry`, `NodeDatabase`, `ChannelFile`, `BackupPreferences`
+- Legacy: `NodeInfoLite_Legacy`, `NodeDatabase_Legacy`
+
+See [Deviceonly](deviceonly.md).
+
+## interdevice.proto
+
+- `FileTransfer`, `DirectoryListing`, `I2CTransaction`, `SdCardInfo`, `I2CResult`, `InterdeviceMessage`
+- Enums: `SdCardInfo::CardType`, `SdCardInfo::FatType`, `I2CResult::Status`, `InterdeviceVersion`, `FileOperation`, `FileStatus`, `SdCommand`
+
+No dedicated wrapper. Encode/decode the generated classes directly.
+
+## localonly.proto
+
+- `LocalConfig`, `LocalModuleConfig` — [Localonly](localonly.md)
+
+## lorawan_bridge.proto
+
+- `LoRaWANBridge` plus nested `Uplink`, `Downlink`, `PayloadChunk`, `TxResult`
+
+No dedicated wrapper. Port `LORAWAN_BRIDGE` (75).
+
+## mesh_beacon.proto
+
+- `MeshBeacon` — port `MESH_BEACON_APP` (37)
+
+## mesh.proto
+
+Core radio types:
+
+- `Position` ([Position](position.md)), `User`, `RouteDiscovery` ([Traceroute](traceroute.md)), `Routing`, `Data`, `KeyVerification`, `StoreForwardPlusPlus`, `RemoteShell`, `BoundingBox`, `Waypoint`, `StatusMessage`, `MqttClientProxyMessage`, `MeshPacket`, `NodeInfo`, `MyNodeInfo`, `LogRecord`, `QueueStatus`, `FromRadio`, `LockdownStatus`, `ClientNotification`, `KeyVerificationNumberInform`, `KeyVerificationNumberRequest`, `KeyVerificationFinal`, `DuplicatedPublicKey`, `LowEntropyKey`, `FileInfo`, `ToRadio`, `Compressed`, `NeighborInfo`, `Neighbor`, `DeviceMetadata`, `LoRaPresetGroup`, `LoRaRegionPresets`, `LoRaRegionPresetMap`, `Heartbeat`, `NodeRemoteHardwarePin`, `ChunkedPayload`, `resend_chunks`, `ChunkedPayloadResponse`
+- Enums: `HardwareModel`, `Constants`, `CriticalErrorCode`, `FirmwareEdition`, `ExcludedModules`, plus nested enums on Position, Routing, MeshPacket, LogRecord, LockdownStatus, RemoteShell, StoreForwardPlusPlus
+
+Serial/TCP frames carry `ToRadio` / `FromRadio`. MQTT publishes `ServiceEnvelope` wrapping `MeshPacket`.
+
+## module_config.proto
+
+- `ModuleConfig` and nested MQTT/Serial/StoreForward/Telemetry/… configs — [ModuleConfig](module-config.md)
+- `RemoteHardwarePin`, `RemoteHardwarePinType`
+
+## mqtt.proto
+
+- `ServiceEnvelope`, `MapReport` — [MQTT](mqtt.md)
+
+## paxcount.proto
+
+- `Paxcount` — [Paxcount](paxcount.md)
+
+## portnums.proto
+
+- `PortNum` — [Portnums](portnums.md)
+
+## powermon.proto
+
+- `PowerMon`, `PowerStressMessage` (and nested enums)
+
+No dedicated wrapper. Port `POWERSTRESS_APP` (74).
+
+## remote_hardware.proto
+
+- `HardwareMessage`, `HardwareMessage::Type` — [RemoteHardware](remote-hardware.md)
+
+## rtttl.proto
+
+- `RTTTLConfig` — [RTTTL](rtttl.md)
+
+## serial_hal.proto
+
+- `SerialHalCommand`, `SerialHalResponse`
+
+GPIO serial HAL, not USB CDC. See [Serial](serial.md) for the USB Stream API.
+
+## storeforward.proto
+
+- `StoreAndForward` plus `Statistics`, `History`, `Heartbeat`, `RequestResponse` — [Storeforward](storeforward.md)
+
+## telemetry.proto
+
+- `Telemetry` ([Telemetry](telemetry.md)), `DeviceMetrics`, `EnvironmentMetrics`, `SoilWaterMetrics`, `PowerMetrics`, `AirQualityMetrics`, `LocalStats`, `TrafficManagementStats`, `HealthMetrics`, `HostMetrics`, `Nau7802Config`, `AS3935Config`, `SEN5XState`, `SEN6XState`, `TelemetrySensorType`
+
+## xmodem.proto
+
+- `XModem`, `XModem::Control` — [Xmodem](xmodem.md)
+
+## nanopb
+
+`require 'nanopb_pb'` is loaded with the gem. It is not a `Meshtastic::` module.
+
+## Example: inspect a type
+
+```ruby
+require 'meshtastic'
+
+Meshtastic::AdminMessage.descriptor.each { |f| puts f.name }
+Meshtastic::PortNum.constants.sort
+user = Meshtastic::User.new(long_name: 'Node', short_name: 'N1')
+Meshtastic::User.decode(user.to_proto)
+```

data/documentation/remote-hardware.md

@@ -0,0 +1,33 @@
+# Meshtastic::RemoteHardware
+
+GPIO control on `REMOTE_HARDWARE_APP` (port 2) using `Meshtastic::HardwareMessage`.
+
+## Methods
+
+- `encode(type:, gpio_mask:, gpio_value:)`
+- `send`
+- `read_gpios(gpio_mask:)`
+- `write_gpios(gpio_mask:, gpio_value:)`
+- `watch_gpios(gpio_mask:)`
+- `help` / `authors`
+
+`type` values: `:UNSET`, `:WRITE_GPIOS`, `:WATCH_GPIOS`, `:GPIOS_CHANGED`, `:READ_GPIOS`, `:READ_GPIOS_REPLY`.
+
+## Example
+
+```ruby
+Meshtastic::RemoteHardware.write_gpios(
+  serial_obj: serial_obj,
+  gpio_mask: 0x01,
+  gpio_value: 0x01
+)
+
+Meshtastic::RemoteHardware.read_gpios(serial_obj: serial_obj, gpio_mask: 0x01)
+Meshtastic::RemoteHardware.watch_gpios(serial_obj: serial_obj, gpio_mask: 0x01)
+```
+
+Enable the Remote Hardware module on the node and only drive pins the firmware exposes.
+
+## Related
+
+- [Meshtastic::ModuleConfig](module-config.md)

data/documentation/rtttl.md

@@ -0,0 +1,24 @@
+# Meshtastic::RTTTL
+
+Ringtone helpers. `encode` builds `RTTTLConfig`. `set` / `get` go through [Admin](admin.md) (`set_ringtone_message` / `get_ringtone_request`).
+
+## Methods
+
+- `encode(ringtone:)`
+- `set(serial_obj:, ringtone:)`
+- `get(serial_obj:)`
+- `help` / `authors`
+
+## Example
+
+```ruby
+Meshtastic::RTTTL.set(
+  serial_obj: serial_obj,
+  ringtone: 'Mario:d=4,o=5,b=125:16e6'
+)
+Meshtastic::RTTTL.get(serial_obj: serial_obj)
+```
+
+## Related
+
+- [Meshtastic::Admin](admin.md)

data/documentation/serial.md

@@ -0,0 +1,78 @@
+# Meshtastic::Serial
+
+USB/UART Stream API. Framing is `[0x94][0xC3][len_hi][len_lo]` plus a `ToRadio` / `FromRadio` protobuf.
+
+The radio applies channel crypto. Payloads go out decoded. `channel:` is the device channel index (usually `0`), not an MQTT hash.
+
+## Setup
+
+Use the USB CDC port (`/dev/ttyACM*` or `/dev/ttyUSB*`). Enable Radio Configuration → Security → Serial Console (`security.serial_enabled`). That is not Module Configuration → Serial (`TEXTMSG` / `PROTO` on GPIO). Keep “Override Console Serial Port” off.
+
+Do not open Serial and Bluetooth to the same radio at once.
+
+## Methods
+
+- `connect(block_dev:, baud:, data_bits:, stop_bits:, parity:, debug_out:, want_config:)`
+- `wait_for_config(serial_obj:, timeout:)` — raises `Timeout::Error` if handshake never completes
+- `wake_up_device` — writes 32 × `START2`
+- `request` — raw bytes
+- `send_to_radio` — framed `ToRadio`
+- `send_text` / `send_data`
+- `recv_from_radio(timeout:)` — `0` polls, `nil` blocks, default `5`. Closed empty queue → `nil`. Unplug → `IOError`
+- `drain_from_radio`
+- `dump_stdout_data` / `flush_data` / `monitor_stdout` (`:proto` or `:console`)
+- `subscribe` — blocking FromRadio loop
+- `disconnect`
+- `help` / `authors`
+
+`send_text` / `send_data` return bytes written, not mesh delivery. `want_ack: true` asks for `ROUTING_APP` (`error_reason: NONE` means the local radio accepted the route). Incoming text is UTF-8 under `message[:packet][:decoded][:payload]`.
+
+Call `wait_for_config` before using `my_node_num` or sending. Opening a port is not a completed handshake.
+
+## Send / receive
+
+```ruby
+require 'meshtastic'
+
+serial_obj = nil
+begin
+  serial_obj = Meshtastic::Serial.connect(block_dev: '/dev/ttyACM0', baud: 115_200)
+  Meshtastic::Serial.wait_for_config(serial_obj: serial_obj, timeout: 10)
+  puts "local node: !#{serial_obj[:my_node_num].to_s(16)}"
+
+  Meshtastic::Serial.send_text(
+    serial_obj: serial_obj,
+    to: '!aabbccdd',       # or '!ffffffff' for the shared channel
+    channel: 0,
+    text: 'Hello over serial!',
+    want_ack: true
+  )
+
+  Meshtastic::Serial.subscribe(
+    serial_obj: serial_obj,
+    include: 'TEXT_MESSAGE_APP'
+  ) do |message|
+    packet = message[:packet]
+    puts "#{packet[:node_id_from]}: #{packet.dig(:decoded, :payload)}"
+  end
+ensure
+  Meshtastic::Serial.disconnect(serial_obj: serial_obj)
+end
+```
+
+Drive the loop yourself:
+
+```ruby
+from_radio = Meshtastic::Serial.recv_from_radio(serial_obj: serial_obj, timeout: 0)
+msgs = Meshtastic::Serial.drain_from_radio(serial_obj: serial_obj, max: 256)
+```
+
+If `wait_for_config` times out, the USB path is up but the Stream API is not (wrong port, Serial Console disabled, or firmware not responding).
+
+Default `block_dev` is `/dev/ttyUSB0`, baud `115200`, 8N1.
+
+## Related
+
+- [Meshtastic::TCP](tcp.md) (same framing)
+- [Meshtastic::Bluetooth](bluetooth.md)
+- [Meshtastic::Admin](admin.md)

data/documentation/storeforward.md

@@ -0,0 +1,24 @@
+# Meshtastic::Storeforward
+
+Sends `Meshtastic::StoreAndForward` on `STORE_FORWARD_APP` (port 65).
+
+## Methods
+
+- `encode(rr:)` — request/response enum, default `:ROUTER_HEARTBEAT`
+- `send`
+- `help` / `authors`
+
+`rr` includes values such as `:CLIENT_HISTORY`, `:ROUTER_HEARTBEAT`.
+
+## Example
+
+```ruby
+Meshtastic::Storeforward.send(
+  serial_obj: serial_obj,
+  rr: :CLIENT_HISTORY
+)
+```
+
+## Related
+
+- [Meshtastic::ModuleConfig](module-config.md) (`:STOREFORWARD_CONFIG`)

data/documentation/stream-interface.md

@@ -0,0 +1,15 @@
+# Meshtastic::StreamInterface
+
+Abstract UART helper left from the Python client layout. Instantiating it raises unless a subclass sets `@stream` (or `no_proto: true`).
+
+Use [Meshtastic::Serial](serial.md) for USB/UART.
+
+```ruby
+# raises: StreamInterface is now abstract (to update existing code use Meshtastic::Serial instead)
+Meshtastic::StreamInterface.new
+```
+
+## Related
+
+- [Meshtastic::Serial](serial.md)
+- [Meshtastic::TCP](tcp.md)

data/documentation/tcp.md

@@ -0,0 +1,43 @@
+# Meshtastic::TCP
+
+Same framed Stream API as [Serial](serial.md), over TCP. Firmware default port is `4403`. Use `tcp_obj:` instead of `serial_obj:`. Internally reuses Serial’s RX thread and framing.
+
+## Methods
+
+- `connect(host:, port:, socket:, want_config:, debug_out:)` — `host` default `127.0.0.1`, `port` default `4403`. `socket:` is for tests.
+- `wait_for_config`
+- `send_text` / `send_data` / `send_to_radio`
+- `recv_from_radio` / `drain_from_radio`
+- `subscribe`
+- `disconnect`
+- `help` / `authors`
+
+## Send / receive
+
+```ruby
+require 'meshtastic'
+
+tcp_obj = nil
+begin
+  tcp_obj = Meshtastic::TCP.connect(host: '192.0.2.10', port: 4403)
+  Meshtastic::TCP.wait_for_config(tcp_obj: tcp_obj, timeout: 10)
+  Meshtastic::TCP.send_text(
+    tcp_obj: tcp_obj,
+    to: '!ffffffff',
+    channel: 0,
+    text: 'Hello over TCP!'
+  )
+  Meshtastic::TCP.subscribe(tcp_obj: tcp_obj, include: 'TEXT_MESSAGE_APP') do |message|
+    puts message.dig(:packet, :decoded, :payload)
+  end
+ensure
+  Meshtastic::TCP.disconnect(tcp_obj: tcp_obj)
+end
+```
+
+Enable TCP in radio network settings. Feature modules accept `tcp_obj:` the same way as `serial_obj:`.
+
+## Related
+
+- [Meshtastic::Serial](serial.md)
+- [Meshtastic::Admin](admin.md)

data/documentation/telemetry.md

@@ -0,0 +1,32 @@
+# Meshtastic::Telemetry
+
+Reopens the generated `Meshtastic::Telemetry` protobuf class. Requests metrics on `TELEMETRY_APP` (port 67) with `want_response: true`.
+
+Use `build` / `request`, not `send` / `encode`.
+
+## Methods
+
+- `build(time:)`
+- `request(serial_obj:, to:, ...)`
+- `help` / `authors`
+
+## Example
+
+```ruby
+Meshtastic::Telemetry.request(
+  serial_obj: serial_obj,
+  to: '!aabbccdd'
+)
+
+Meshtastic::Serial.subscribe(serial_obj: serial_obj, include: 'TELEMETRY_APP') do |message|
+  tel = Meshtastic::Telemetry.decode(message.dig(:packet, :decoded, :payload).to_s) rescue nil
+  p tel&.device_metrics
+end
+```
+
+Incoming payloads may include `device_metrics`, `environment_metrics`, `air_quality_metrics`, `power_metrics`, `local_stats`, `health_metrics`, `host_metrics`, `traffic_management_stats`, `soil_water_metrics`.
+
+## Related
+
+- [Meshtastic::Position](position.md)
+- [Meshtastic::Paxcount](paxcount.md)

data/documentation/traceroute.md

@@ -0,0 +1,28 @@
+# Meshtastic::Traceroute
+
+Sends `RouteDiscovery` on `TRACEROUTE_APP` (port 70) with `want_response: true`.
+
+## Methods
+
+- `encode(route:)` — optional hop list
+- `send(serial_obj:, to:, ...)`
+- `help` / `authors`
+
+## Example
+
+```ruby
+Meshtastic::Traceroute.send(
+  serial_obj: serial_obj,
+  to: '!aabbccdd',
+  want_ack: true
+)
+
+Meshtastic::Serial.subscribe(serial_obj: serial_obj, include: 'TRACEROUTE_APP') do |message|
+  p message.dig(:packet, :decoded)
+end
+```
+
+## Related
+
+- [Meshtastic::Serial](serial.md)
+- Protobuf: `RouteDiscovery`, `Routing` in [protobufs.md](protobufs.md)

data/documentation/util.md

@@ -0,0 +1,27 @@
+# Meshtastic::Util
+
+Small helpers used by [MeshInterface](mesh-interface.md).
+
+## `Meshtastic::Util::Acknowledgement`
+
+Flags: `received_ack`, `received_nak`, `received_impl_ack`, `received_trace_route`, `received_telemetry`, `received_position`, `received_waypoint`. `#reset` clears them.
+
+## `Meshtastic::Util::Timeout`
+
+`expire_timeout` (default 20 seconds), `expire_time`, `sleep_interval` (0.1). `#reset` sets `expire_time` from now.
+
+## Module methods
+
+- `authors` / `help`
+
+```ruby
+ack = Meshtastic::Util::Acknowledgement.new
+ack.reset
+
+t = Meshtastic::Util::Timeout.new(expire_timeout: 10)
+t.reset
+```
+
+## Related
+
+- [Meshtastic::MeshInterface](mesh-interface.md)

data/documentation/xmodem.md

@@ -0,0 +1,22 @@
+# Meshtastic::Xmodem
+
+Builds `Meshtastic::XModem` packets (`xmodem.proto`). Distinct from the generated class `Meshtastic::XModem`.
+
+## Methods
+
+- `encode(control:, seq:, buffer:)`
+- `help` / `authors`
+
+`control` includes `:SOH` and other `XModem::Control` values.
+
+## Example
+
+```ruby
+packet = Meshtastic::Xmodem.encode(control: :SOH, seq: 1, buffer: 'A')
+packet.control # => :SOH
+packet.seq     # => 1
+```
+
+## Related
+
+- [Generated protobuf types](protobufs.md)

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