meshtastic 0.0.178 → 0.0.179

data/spec/lib/meshtastic/config_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::ClientonlyPB do
+describe Meshtastic::Config do
 end

data/spec/lib/meshtastic/config_spec.rb

@@ -2,5 +2,26 @@
 
 require 'spec_helper'
 
-describe Meshtastic::Clientonly do
+describe Meshtastic::Config do
+  def fake_serial_obj
+    written = +''.b
+    serial_conn = Object.new
+    serial_conn.define_singleton_method(:write) do |b|
+      written << b
+      b.bytesize
+    end
+    serial_conn.define_singleton_method(:flush) { true }
+    serial_conn.define_singleton_method(:closed?) { false }
+    serial_conn.define_singleton_method(:close) { true }
+    { serial_conn: serial_conn, written: written, my_node_num: 0xb0b }
+  end
+
+  it 'requests LoRa config via Admin' do
+    serial_obj = fake_serial_obj
+    described_class.get(serial_obj: serial_obj, config_type: :LORA_CONFIG)
+    frame = serial_obj[:written]
+    packet = Meshtastic::ToRadio.decode(frame.byteslice(4, (frame.getbyte(2) << 8) + frame.getbyte(3))).packet
+    admin = Meshtastic::AdminMessage.decode(packet.decoded.payload)
+    expect(admin.get_config_request).to eq(:LORA_CONFIG)
+  end
 end

data/spec/lib/meshtastic/connection_status_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::ConnectionStatusPB do
+describe Meshtastic::DeviceConnectionStatus do
 end

data/spec/lib/meshtastic/connection_status_spec.rb

@@ -3,4 +3,7 @@
 require 'spec_helper'
 
 describe Meshtastic::ConnectionStatus do
+  it 'decodes DeviceConnectionStatus bytes' do
+    expect(described_class.decode(Meshtastic::DeviceConnectionStatus.new.to_proto)).to be_a(Meshtastic::DeviceConnectionStatus)
+  end
 end

data/spec/lib/meshtastic/deviceonly_legacy_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::DeviceonlyLegacyPB do
+describe Meshtastic::NodeDatabase_Legacy do
 end

data/spec/lib/meshtastic/deviceonly_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::DeviceonlyPB do
+describe Meshtastic::DeviceState do
 end

data/spec/lib/meshtastic/deviceonly_spec.rb

@@ -3,4 +3,7 @@
 require 'spec_helper'
 
 describe Meshtastic::Deviceonly do
+  it 'decodes an empty DeviceState' do
+    expect(described_class.decode_state(Meshtastic::DeviceState.new.to_proto)).to be_a(Meshtastic::DeviceState)
+  end
 end

data/spec/lib/meshtastic/localonly_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::LocalonlyPB do
+describe Meshtastic::LocalConfig do
 end

data/spec/lib/meshtastic/localonly_spec.rb

@@ -3,4 +3,7 @@
 require 'spec_helper'
 
 describe Meshtastic::Localonly do
+  it 'decodes an empty LocalConfig' do
+    expect(described_class.decode_config(Meshtastic::LocalConfig.new.to_proto)).to be_a(Meshtastic::LocalConfig)
+  end
 end

data/spec/lib/meshtastic/mesh_beacon_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::MeshBeaconPB do
+describe Meshtastic::MeshBeacon do
 end

data/spec/lib/meshtastic/mesh_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::MeshPB do
+describe Meshtastic::MeshPacket do
 end

data/spec/lib/meshtastic/module_config_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::ModuleConfigPB do
+describe Meshtastic::ModuleConfig do
 end

data/spec/lib/meshtastic/module_config_spec.rb

@@ -3,4 +3,25 @@
 require 'spec_helper'
 
 describe Meshtastic::ModuleConfig do
+  def fake_serial_obj
+    written = +''.b
+    serial_conn = Object.new
+    serial_conn.define_singleton_method(:write) do |b|
+      written << b
+      b.bytesize
+    end
+    serial_conn.define_singleton_method(:flush) { true }
+    serial_conn.define_singleton_method(:closed?) { false }
+    serial_conn.define_singleton_method(:close) { true }
+    { serial_conn: serial_conn, written: written, my_node_num: 0xb0b }
+  end
+
+  it 'requests MQTT module config via Admin' do
+    serial_obj = fake_serial_obj
+    described_class.get(serial_obj: serial_obj, module_config_type: :MQTT_CONFIG)
+    frame = serial_obj[:written]
+    packet = Meshtastic::ToRadio.decode(frame.byteslice(4, (frame.getbyte(2) << 8) + frame.getbyte(3))).packet
+    admin = Meshtastic::AdminMessage.decode(packet.decoded.payload)
+    expect(admin.get_module_config_request).to eq(:MQTT_CONFIG)
+  end
 end

data/spec/lib/meshtastic/mqtt_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::MQTTPB do
+describe Meshtastic::ServiceEnvelope do
 end

data/spec/lib/meshtastic/paxcount_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::PaxcountPB do
+describe Meshtastic::Paxcount do
 end

data/spec/lib/meshtastic/paxcount_spec.rb

@@ -3,4 +3,27 @@
 require 'spec_helper'
 
 describe Meshtastic::Paxcount do
+  def fake_serial_obj
+    written = +''.b
+    serial_conn = Object.new
+    serial_conn.define_singleton_method(:write) do |b|
+      written << b
+      b.bytesize
+    end
+    serial_conn.define_singleton_method(:flush) { true }
+    serial_conn.define_singleton_method(:closed?) { false }
+    serial_conn.define_singleton_method(:close) { true }
+    { serial_conn: serial_conn, written: written, my_node_num: 0xb0b }
+  end
+
+  it 'transmits PAXCOUNTER_APP counts' do
+    serial_obj = fake_serial_obj
+    described_class.transmit(serial_obj: serial_obj, wifi: 3, ble: 2)
+    frame = serial_obj[:written]
+    packet = Meshtastic::ToRadio.decode(frame.byteslice(4, (frame.getbyte(2) << 8) + frame.getbyte(3))).packet
+    expect(packet.decoded.portnum).to eq(:PAXCOUNTER_APP)
+    count = Meshtastic::Paxcount.decode(packet.decoded.payload)
+    expect(count.wifi).to eq(3)
+    expect(count.ble).to eq(2)
+  end
 end

data/spec/lib/meshtastic/portnums_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::PortnumsPB do
+describe Meshtastic::PortNum do
 end

data/spec/lib/meshtastic/portnums_spec.rb

@@ -3,4 +3,8 @@
 require 'spec_helper'
 
 describe Meshtastic::Portnums do
+  it 'resolves names and numbers' do
+    expect(described_class.lookup(:TEXT_MESSAGE_APP)).to eq(1)
+    expect(described_class.lookup(1)).to eq(:TEXT_MESSAGE_APP)
+  end
 end

data/spec/lib/meshtastic/position_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Meshtastic::Position do
+  def fake_serial_obj
+    written = +''.b
+    serial_conn = Object.new
+    serial_conn.define_singleton_method(:write) do |b|
+      written << b
+      b.bytesize
+    end
+    serial_conn.define_singleton_method(:flush) { true }
+    serial_conn.define_singleton_method(:closed?) { false }
+    serial_conn.define_singleton_method(:close) { true }
+    { serial_conn: serial_conn, written: written, my_node_num: 0xb0b }
+  end
+
+  it 'sends a POSITION_APP packet with scaled lat/lon' do
+    serial_obj = fake_serial_obj
+    described_class.transmit(serial_obj: serial_obj, lat: 37.7749, lon: -122.4194)
+    frame = serial_obj[:written]
+    packet = Meshtastic::ToRadio.decode(frame.byteslice(4, (frame.getbyte(2) << 8) + frame.getbyte(3))).packet
+    expect(packet.decoded.portnum).to eq(:POSITION_APP)
+    position = Meshtastic::Position.decode(packet.decoded.payload)
+    expect(position.latitude_i).to eq(377_749_000)
+    expect(position.longitude_i).to eq(-1_224_194_000)
+  end
+
+  it 'prints usage without raising' do
+    expect { described_class.help }.to output(/USAGE/).to_stdout
+  end
+end

data/spec/lib/meshtastic/remote_hardware_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::RemoteHardwarePB do
+describe Meshtastic::HardwareMessage do
 end

data/spec/lib/meshtastic/remote_hardware_spec.rb

@@ -3,4 +3,28 @@
 require 'spec_helper'
 
 describe Meshtastic::RemoteHardware do
+  def fake_serial_obj
+    written = +''.b
+    serial_conn = Object.new
+    serial_conn.define_singleton_method(:write) do |b|
+      written << b
+      b.bytesize
+    end
+    serial_conn.define_singleton_method(:flush) { true }
+    serial_conn.define_singleton_method(:closed?) { false }
+    serial_conn.define_singleton_method(:close) { true }
+    { serial_conn: serial_conn, written: written, my_node_num: 0xb0b }
+  end
+
+  it 'writes GPIO bits on REMOTE_HARDWARE_APP' do
+    serial_obj = fake_serial_obj
+    described_class.write_gpios(serial_obj: serial_obj, gpio_mask: 0x01, gpio_value: 0x01)
+    frame = serial_obj[:written]
+    packet = Meshtastic::ToRadio.decode(frame.byteslice(4, (frame.getbyte(2) << 8) + frame.getbyte(3))).packet
+    expect(packet.decoded.portnum).to eq(:REMOTE_HARDWARE_APP)
+    hw = Meshtastic::HardwareMessage.decode(packet.decoded.payload)
+    expect(hw.type).to eq(:WRITE_GPIOS)
+    expect(hw.gpio_mask).to eq(1)
+    expect(hw.gpio_value).to eq(1)
+  end
 end

data/spec/lib/meshtastic/rtttl_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::RTTTLPB do
+describe Meshtastic::RTTTLConfig do
 end

data/spec/lib/meshtastic/rtttl_spec.rb

@@ -3,4 +3,25 @@
 require 'spec_helper'
 
 describe Meshtastic::RTTTL do
+  def fake_serial_obj
+    written = +''.b
+    serial_conn = Object.new
+    serial_conn.define_singleton_method(:write) do |b|
+      written << b
+      b.bytesize
+    end
+    serial_conn.define_singleton_method(:flush) { true }
+    serial_conn.define_singleton_method(:closed?) { false }
+    serial_conn.define_singleton_method(:close) { true }
+    { serial_conn: serial_conn, written: written, my_node_num: 0xb0b }
+  end
+
+  it 'sets a ringtone via Admin' do
+    serial_obj = fake_serial_obj
+    described_class.set(serial_obj: serial_obj, ringtone: 'beep:d=4,o=5,b=120:16c6')
+    frame = serial_obj[:written]
+    packet = Meshtastic::ToRadio.decode(frame.byteslice(4, (frame.getbyte(2) << 8) + frame.getbyte(3))).packet
+    admin = Meshtastic::AdminMessage.decode(packet.decoded.payload)
+    expect(admin.set_ringtone_message).to eq('beep:d=4,o=5,b=120:16c6')
+  end
 end

data/spec/lib/meshtastic/storeforward_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::StoreforwardPB do
+describe Meshtastic::StoreAndForward do
 end

data/spec/lib/meshtastic/storeforward_spec.rb

@@ -3,4 +3,25 @@
 require 'spec_helper'
 
 describe Meshtastic::Storeforward do
+  def fake_serial_obj
+    written = +''.b
+    serial_conn = Object.new
+    serial_conn.define_singleton_method(:write) do |b|
+      written << b
+      b.bytesize
+    end
+    serial_conn.define_singleton_method(:flush) { true }
+    serial_conn.define_singleton_method(:closed?) { false }
+    serial_conn.define_singleton_method(:close) { true }
+    { serial_conn: serial_conn, written: written, my_node_num: 0xb0b }
+  end
+
+  it 'sends STORE_FORWARD_APP history request' do
+    serial_obj = fake_serial_obj
+    described_class.send(serial_obj: serial_obj, rr: :CLIENT_HISTORY)
+    frame = serial_obj[:written]
+    packet = Meshtastic::ToRadio.decode(frame.byteslice(4, (frame.getbyte(2) << 8) + frame.getbyte(3))).packet
+    expect(packet.decoded.portnum).to eq(:STORE_FORWARD_APP)
+    expect(Meshtastic::StoreAndForward.decode(packet.decoded.payload).rr).to eq(:CLIENT_HISTORY)
+  end
 end

data/spec/lib/meshtastic/tcp_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'socket'
+
+describe Meshtastic::TCP do
+  def with_tcp_link(opts = {})
+    local, remote = UNIXSocket.pair
+    tcp_obj = described_class.connect({ socket: local, host: '127.0.0.1', port: 4403, want_config: false }.merge(opts))
+    begin
+      yield tcp_obj, remote
+    ensure
+      described_class.disconnect(tcp_obj: tcp_obj)
+      remote.close unless remote.closed?
+    end
+  end
+
+  def radio_frame(message)
+    body = message.to_proto
+    [Meshtastic::START1, Meshtastic::START2, body.bytesize].pack('CCn') + body
+  end
+
+  it 'writes a decoded ToRadio mesh packet over TCP without MQTT encryption' do
+    with_tcp_link do |tcp_obj, remote|
+      described_class.send_text(tcp_obj: tcp_obj, text: 'ping', to: '!ffffffff', channel: 0)
+      expect(remote.read(32)).to eq(([Meshtastic::START2] * 32).pack('C*'))
+      header = remote.read(4)
+      packet = Meshtastic::ToRadio.decode(remote.read(header.unpack('CCn').last)).packet
+      expect(packet.decoded.payload).to eq('ping')
+      expect(packet.encrypted.to_s).to eq('')
+    end
+  end
+
+  it 'receives a framed FromRadio over TCP' do
+    with_tcp_link do |tcp_obj, remote|
+      remote.read(32)
+      message = Meshtastic::FromRadio.new(packet: Meshtastic::MeshPacket.new(
+        from: 123, decoded: Meshtastic::Data.new(portnum: :TEXT_MESSAGE_APP, payload: 'hello')
+      ))
+      remote.write(radio_frame(message))
+      expect(described_class.recv_from_radio(tcp_obj: tcp_obj, timeout: 1)).to eq(message)
+    end
+  end
+
+  it 'prints usage without raising' do
+    expect { described_class.help }.to output(/USAGE/).to_stdout
+  end
+end

data/spec/lib/meshtastic/telemetry_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::TelemetryPB do
+describe Meshtastic::Telemetry do
 end

data/spec/lib/meshtastic/telemetry_spec.rb

@@ -3,4 +3,25 @@
 require 'spec_helper'
 
 describe Meshtastic::Telemetry do
+  def fake_serial_obj
+    written = +''.b
+    serial_conn = Object.new
+    serial_conn.define_singleton_method(:write) do |b|
+      written << b
+      b.bytesize
+    end
+    serial_conn.define_singleton_method(:flush) { true }
+    serial_conn.define_singleton_method(:closed?) { false }
+    serial_conn.define_singleton_method(:close) { true }
+    { serial_conn: serial_conn, written: written, my_node_num: 0xb0b }
+  end
+
+  it 'requests TELEMETRY_APP with want_response' do
+    serial_obj = fake_serial_obj
+    described_class.request(serial_obj: serial_obj, to: '!aabbccdd')
+    frame = serial_obj[:written]
+    packet = Meshtastic::ToRadio.decode(frame.byteslice(4, (frame.getbyte(2) << 8) + frame.getbyte(3))).packet
+    expect(packet.decoded.portnum).to eq(:TELEMETRY_APP)
+    expect(packet.decoded.want_response).to be true
+  end
 end

data/spec/lib/meshtastic/traceroute_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Meshtastic::Traceroute do
+  def fake_serial_obj
+    written = +''.b
+    serial_conn = Object.new
+    serial_conn.define_singleton_method(:write) do |b|
+      written << b
+      b.bytesize
+    end
+    serial_conn.define_singleton_method(:flush) { true }
+    serial_conn.define_singleton_method(:closed?) { false }
+    serial_conn.define_singleton_method(:close) { true }
+    { serial_conn: serial_conn, written: written, my_node_num: 0xb0b }
+  end
+
+  it 'sends an empty RouteDiscovery on TRACEROUTE_APP' do
+    serial_obj = fake_serial_obj
+    described_class.send(serial_obj: serial_obj, to: '!aabbccdd')
+    frame = serial_obj[:written]
+    packet = Meshtastic::ToRadio.decode(frame.byteslice(4, (frame.getbyte(2) << 8) + frame.getbyte(3))).packet
+    expect(packet.decoded.portnum).to eq(:TRACEROUTE_APP)
+    expect(Meshtastic::RouteDiscovery.decode(packet.decoded.payload)).to be_a(Meshtastic::RouteDiscovery)
+  end
+end

data/spec/lib/meshtastic/xmodem_pb_spec.rb

@@ -2,5 +2,5 @@
 
 require 'spec_helper'
 
-describe Meshtastic::XModemPB do
+describe Meshtastic::XModem do
 end

data/spec/lib/meshtastic/xmodem_spec.rb

@@ -2,5 +2,10 @@
 
 require 'spec_helper'
 
-describe Meshtastic::XModem do
+describe Meshtastic::Xmodem do
+  it 'encodes an XModem SOH packet' do
+    packet = described_class.encode(control: :SOH, seq: 1, buffer: 'A')
+    expect(packet.control).to eq(:SOH)
+    expect(packet.seq).to eq(1)
+  end
 end

data/spec/lib/meshtastic_spec.rb

@@ -3,4 +3,7 @@
 require 'spec_helper'
 
 describe Meshtastic do
+  it 'requires a transport for deliver_data' do
+    expect { described_class.deliver_data(data: Meshtastic::Data.new) }.to raise_error(ArgumentError, /serial_obj/)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meshtastic
 version: !ruby/object:Gem::Version
-  version: 0.0.178
+  version: 0.0.179
 platform: ruby
 authors:
 - 0day Inc.
@@ -284,6 +284,37 @@ files:
 - Rakefile
 - bin/meshtastic_autoinc_version
 - build_gem.sh
+- documentation/README.md
+- documentation/admin.md
+- documentation/apponly.md
+- documentation/atak.md
+- documentation/bluetooth-bluez.md
+- documentation/bluetooth.md
+- documentation/cannedmessages.md
+- documentation/channel.md
+- documentation/clientonly.md
+- documentation/config.md
+- documentation/connection-status.md
+- documentation/deviceonly.md
+- documentation/localonly.md
+- documentation/mesh-interface.md
+- documentation/meshtastic.md
+- documentation/module-config.md
+- documentation/mqtt.md
+- documentation/paxcount.md
+- documentation/portnums.md
+- documentation/position.md
+- documentation/protobufs.md
+- documentation/remote-hardware.md
+- documentation/rtttl.md
+- documentation/serial.md
+- documentation/storeforward.md
+- documentation/stream-interface.md
+- documentation/tcp.md
+- documentation/telemetry.md
+- documentation/traceroute.md
+- documentation/util.md
+- documentation/xmodem.md
 - git_commit.sh
 - lib/meshtastic.rb
 - lib/meshtastic/admin.rb
@@ -323,6 +354,7 @@ files:
 - lib/meshtastic/paxcount_pb.rb
 - lib/meshtastic/portnums.rb
 - lib/meshtastic/portnums_pb.rb
+- lib/meshtastic/position.rb
 - lib/meshtastic/powermon_pb.rb
 - lib/meshtastic/remote_hardware.rb
 - lib/meshtastic/remote_hardware_pb.rb
@@ -333,8 +365,10 @@ files:
 - lib/meshtastic/storeforward.rb
 - lib/meshtastic/storeforward_pb.rb
 - lib/meshtastic/stream_interface.rb
+- lib/meshtastic/tcp.rb
 - lib/meshtastic/telemetry.rb
 - lib/meshtastic/telemetry_pb.rb
+- lib/meshtastic/traceroute.rb
 - lib/meshtastic/util.rb
 - lib/meshtastic/version.rb
 - lib/meshtastic/xmodem.rb
@@ -380,6 +414,7 @@ files:
 - spec/lib/meshtastic/paxcount_spec.rb
 - spec/lib/meshtastic/portnums_pb_spec.rb
 - spec/lib/meshtastic/portnums_spec.rb
+- spec/lib/meshtastic/position_spec.rb
 - spec/lib/meshtastic/powermon_pb_spec.rb
 - spec/lib/meshtastic/remote_hardware_pb_spec.rb
 - spec/lib/meshtastic/remote_hardware_spec.rb
@@ -390,8 +425,10 @@ files:
 - spec/lib/meshtastic/storeforward_pb_spec.rb
 - spec/lib/meshtastic/storeforward_spec.rb
 - spec/lib/meshtastic/stream_interface_spec.rb
+- spec/lib/meshtastic/tcp_spec.rb
 - spec/lib/meshtastic/telemetry_pb_spec.rb
 - spec/lib/meshtastic/telemetry_spec.rb
+- spec/lib/meshtastic/traceroute_spec.rb
 - spec/lib/meshtastic/util_spec.rb
 - spec/lib/meshtastic/version_spec.rb
 - spec/lib/meshtastic/xmodem_pb_spec.rb