meshtastic 0.0.178 → 0.0.179

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.rb

@@ -2,21 +2,79 @@
 
 require 'meshtastic/admin_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Admin
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    def self.encode(opts = {})
+      message = opts[:message] || Meshtastic::AdminMessage.new
+      opts.each do |key, value|
+        next if %i[message serial_obj bluetooth_obj tcp_obj to from channel want_ack hop_limit].include?(key)
+        next unless message.respond_to?("#{key}=")
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+        message.public_send("#{key}=", value)
+      end
+      message
+    end
+
+    def self.send(opts = {})
+      message = encode(opts)
+      data = Meshtastic::Data.new(
+        portnum: :ADMIN_APP,
+        payload: message.to_proto,
+        want_response: opts.fetch(:want_response, true)
+      )
+      Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::ADMIN_APP))
+    end
+
+    def self.reboot(opts = {})
+      send(opts.merge(reboot_seconds: opts.fetch(:seconds, 5)))
+    end
+
+    def self.shutdown(opts = {})
+      send(opts.merge(shutdown_seconds: opts.fetch(:seconds, 5)))
+    end
+
+    def self.set_owner(opts = {})
+      user = opts[:owner] || Meshtastic::User.new(long_name: opts[:long_name], short_name: opts[:short_name])
+      send(opts.merge(set_owner: user))
+    end
+
+    def self.get_owner(opts = {})
+      send(opts.merge(get_owner_request: true))
     end
 
-    # Display Usage for this Module
+    def self.set_channel(opts = {})
+      send(opts.merge(set_channel: opts.fetch(:channel_settings)))
+    end
+
+    def self.get_channel(opts = {})
+      send(opts.merge(get_channel_request: opts.fetch(:index, 0)))
+    end
+
+    def self.get_config(opts = {})
+      send(opts.merge(get_config_request: opts.fetch(:config_type, :DEVICE_CONFIG)))
+    end
+
+    def self.set_config(opts = {})
+      send(opts.merge(set_config: opts.fetch(:config)))
+    end
+
+    def self.nodedb_reset(opts = {})
+      send(opts.merge(nodedb_reset: true))
+    end
+
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.reboot(serial_obj: serial_obj, seconds: 5)
+        #{self}.shutdown(serial_obj: serial_obj, seconds: 5)
+        #{self}.get_owner(serial_obj: serial_obj)
+        #{self}.set_owner(serial_obj: serial_obj, long_name: 'Node', short_name: 'N1')
+        #{self}.get_channel(serial_obj: serial_obj, index: 0)
+        #{self}.get_config(serial_obj: serial_obj, config_type: :LORA_CONFIG)
+        #{self}.nodedb_reset(serial_obj: serial_obj)
         #{self}.authors
       "
     end

data/lib/meshtastic/apponly.rb

@@ -2,21 +2,27 @@
 
 require 'meshtastic/apponly_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Apponly
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    def self.encode(opts = {})
+      set = Meshtastic::ChannelSet.new
+      Array(opts[:settings]).each { |channel| set.settings << channel }
+      set.lora_config = opts[:lora_config] if opts[:lora_config]
+      set
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.decode(bytes)
+      Meshtastic::ChannelSet.decode(bytes)
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.encode(settings: [Meshtastic::ChannelSettings.new])
+        #{self}.decode(bytes)
         #{self}.authors
       "
     end

data/lib/meshtastic/atak.rb

@@ -2,21 +2,34 @@
 
 require 'meshtastic/atak_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module ATAK
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    def self.encode(opts = {})
+      packet = Meshtastic::TAKPacket.new
+      packet.is_compressed = opts.fetch(:is_compressed, false)
+      if opts[:chat]
+        packet.chat = opts[:chat]
+      elsif opts[:message]
+        packet.chat = Meshtastic::GeoChat.new(message: opts[:message])
+      end
+      packet
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.send(opts = {})
+      data = Meshtastic::Data.new(
+        portnum: :ATAK_PLUGIN,
+        payload: encode(opts).to_proto
+      )
+      Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::ATAK_PLUGIN))
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.send(serial_obj: serial_obj, message: 'ATAK chat')
         #{self}.authors
       "
     end

data/lib/meshtastic/cannedmessages.rb

@@ -2,21 +2,29 @@
 
 require 'meshtastic/cannedmessages_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Cannedmessages
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    def self.encode(opts = {})
+      config = Meshtastic::CannedMessageModuleConfig.new
+      config.messages = opts.fetch(:messages, '')
+      config
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.send(opts = {})
+      data = Meshtastic::Data.new(
+        portnum: :TEXT_MESSAGE_APP,
+        payload: encode(opts).messages.to_s.b
+      )
+      Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::TEXT_MESSAGE_APP))
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.encode(messages: \"Yes\\nNo\\nMaybe\")
         #{self}.authors
       "
     end

data/lib/meshtastic/channel.rb

@@ -2,21 +2,25 @@
 
 require 'meshtastic/channel_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
-  module Channel
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+  class Channel
+    def self.get(opts = {})
+      Admin.get_channel(opts)
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.set(opts = {})
+      channel = opts[:channel] || opts[:channel_settings] || new
+      Admin.set_channel(opts.merge(channel_settings: channel))
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.get(serial_obj: serial_obj, index: 0)
+        #{self}.set(serial_obj: serial_obj, channel: #{self}.new)
         #{self}.authors
       "
     end

data/lib/meshtastic/clientonly.rb

@@ -2,21 +2,27 @@
 
 require 'meshtastic/clientonly_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Clientonly
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    def self.encode(opts = {})
+      profile = Meshtastic::DeviceProfile.new
+      profile.long_name = opts[:long_name].to_s if opts[:long_name]
+      profile.short_name = opts[:short_name].to_s if opts[:short_name]
+      profile
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.decode(bytes)
+      Meshtastic::DeviceProfile.decode(bytes)
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.encode(long_name: 'Node', short_name: 'N1')
+        #{self}.decode(bytes)
         #{self}.authors
       "
     end

data/lib/meshtastic/config.rb

@@ -2,21 +2,24 @@
 
 require 'meshtastic/config_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
-  module Config
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+  class Config
+    def self.get(opts = {})
+      Admin.get_config(opts)
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.set(opts = {})
+      Admin.set_config(opts.merge(config: opts.fetch(:config)))
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.get(serial_obj: serial_obj, config_type: :LORA_CONFIG)
+        #{self}.set(serial_obj: serial_obj, config: #{self}.new)
         #{self}.authors
       "
     end

data/lib/meshtastic/connection_status.rb

@@ -2,21 +2,19 @@
 
 require 'meshtastic/connection_status_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module ConnectionStatus
-    # Author(s):: 0day Inc. <support@0dayinc.com>
-
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.decode(bytes)
+      Meshtastic::DeviceConnectionStatus.decode(bytes)
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.decode(bytes)
         #{self}.authors
       "
     end

data/lib/meshtastic/deviceonly.rb

@@ -2,21 +2,24 @@
 
 require 'meshtastic/deviceonly_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Deviceonly
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    def self.decode_state(bytes)
+      Meshtastic::DeviceState.decode(bytes)
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.decode_nodedb(bytes)
+      Meshtastic::NodeDatabase.decode(bytes)
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.decode_state(bytes)
+        #{self}.decode_nodedb(bytes)
         #{self}.authors
       "
     end

data/lib/meshtastic/localonly.rb

@@ -2,21 +2,24 @@
 
 require 'meshtastic/localonly_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Localonly
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    def self.decode_config(bytes)
+      Meshtastic::LocalConfig.decode(bytes)
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.decode_module_config(bytes)
+      Meshtastic::LocalModuleConfig.decode(bytes)
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.decode_config(bytes)
+        #{self}.decode_module_config(bytes)
         #{self}.authors
       "
     end

data/lib/meshtastic/module_config.rb

@@ -2,21 +2,24 @@
 
 require 'meshtastic/module_config_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
-  module ModuleConfig
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+  class ModuleConfig
+    def self.get(opts = {})
+      Admin.send(opts.merge(get_module_config_request: opts.fetch(:module_config_type, :MQTT_CONFIG)))
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.set(opts = {})
+      Admin.send(opts.merge(set_module_config: opts.fetch(:module_config)))
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.get(serial_obj: serial_obj, module_config_type: :MQTT_CONFIG)
+        #{self}.set(serial_obj: serial_obj, module_config: #{self}.new)
         #{self}.authors
       "
     end

data/lib/meshtastic/paxcount.rb

@@ -2,21 +2,31 @@
 
 require 'meshtastic/paxcount_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
-  module Paxcount
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+  class Paxcount
+    def self.build(opts = {})
+      count = new
+      count.wifi = opts[:wifi].to_i if opts[:wifi]
+      count.ble = opts[:ble].to_i if opts[:ble]
+      count.uptime = opts[:uptime].to_i if opts[:uptime]
+      count
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    def self.transmit(opts = {})
+      data = Meshtastic::Data.new(
+        portnum: :PAXCOUNTER_APP,
+        payload: build(opts).to_proto
+      )
+      Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::PAXCOUNTER_APP))
     end
 
-    # Display Usage for this Module
+    def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
-    public_class_method def self.help
+    def self.help
       puts "USAGE:
+        #{self}.transmit(serial_obj: serial_obj, wifi: 3, ble: 2)
         #{self}.authors
       "
     end