meshtastic 0.0.98 → 0.0.99

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ef9c2e848f2f25dd8c88627da26b47d5413add60f9365aab8a4209c3aa1fa8
-  data.tar.gz: ef2b83a7b8d36ee461b8bbe994cb07fff1e1877054bc1a38ba9b0043555b4200
+  metadata.gz: 19b2268e9d4efe0f6859ad716e08cfcf0b77f867fe5c2f7915ba6fcf75e27f07
+  data.tar.gz: 92337d4c1dd42ce604710d014b1f1a702cff6738337b295c7ebe5ae7a9f40e58
 SHA512:
-  metadata.gz: c70dc79981d877a4d88cb680870d60e9db2c1cd9e3ec120149964dd45a092f027fbd8bca71634888b1aa7eadfb0dad28ac3074cb6ff9835b9da66bf3b627fa6b
-  data.tar.gz: a8ce895aa0025306898d40104a7e3bdb561726be4080e2b252b5f398131a1f3b405286451276ec9c90cc0f4aad68fe867694ba43caa2cae25b4f07e579faecfe
+  metadata.gz: 46eac9ee60d6276da8254c0c0383231e92280ecabc2c767f6cf6467e72769c50d9d29df545e214e35fec2f39b42c00b40caf6acec7b9676af58ae4aafc5f4116
+  data.tar.gz: 7622bd994c0e9af5945209e1426c13ec2292c5934976194b3f9aaadd2aad898ea0bc33c6426a3f9944df7dcf198d0a35465a2efd6c893561f2afe5964e020ebb

data/lib/meshtastic/mqtt.rb

@@ -216,9 +216,9 @@ module Meshtastic
     # Supported Method Parameters::
     # Meshtastic.send_text(
     #   mqtt_obj: 'required - mqtt_obj returned from #connect method',
-    #   from: ' required - From ID (String or Integer)',
-    #   to: 'optional - Destination ID (Default: 0xFFFFFFFF)',
-    #   topic: 'optional - topic to publish to (default: "msh/US/2/e/LongFast/1")',
+    #   from: 'required - From ID (String or Integer) (Default: "!00000b0b")',
+    #   to: 'optional - Destination ID (Default: "!ffffffff")',
+    #   topic: 'optional - topic to publish to (Default: "msh/US/2/e/LongFast/1")',
     #   channel: 'optional - channel (Default: 6)',
     #   text: 'optional - Text Message (Default: SYN)',
     #   want_ack: 'optional - Want Acknowledgement (Default: false)',
@@ -287,8 +287,8 @@ module Meshtastic
 
         #{self}.send_text(
           mqtt_obj: 'required - mqtt_obj returned from #connect method',
-          from: ' required - From ID (String or Integer)',
-          to: 'optional - Destination ID (Default: 0xFFFFFFFF)',
+          from: 'required - From ID (String or Integer) (Default: \"!00000b0b\")',
+          to: 'optional - Destination ID (Default: \"!ffffffff\")',
           topic: 'optional - topic to publish to (default: 'msh/US/2/e/LongFast/1')',
           channel: 'optional - channel (Default: 6)',
           text: 'optional - Text Message (Default: SYN)',

data/lib/meshtastic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Meshtastic
-  VERSION = '0.0.98'
+  VERSION = '0.0.99'
 end

data/lib/meshtastic.rb

@@ -51,8 +51,8 @@ module Meshtastic
 
   # Supported Method Parameters::
   # Meshtastic.send_text(
-  #   from: 'required - From ID (String or Integer)',
-  #   to: 'optional - Destination ID (Default: 0xFFFFFFFF)',
+  #   from: 'required - From ID (String or Integer) (Default: "!00000b0b")',
+  #   to: 'optional - Destination ID (Default: "!ffffffff")',
   #   last_packet_id: 'optional - Last Packet ID (Default: 0)',
   #   via: 'optional - :radio || :mqtt (Default: :radio)',
   #   channel: 'optional - Channel (Default: 6)',
@@ -65,13 +65,13 @@ module Meshtastic
   # )
   public_class_method def self.send_text(opts = {})
     # Send a text message to a node
-    from = opts[:from]
+    from = opts[:from] ||= '!00000b0b'
     # from_hex = from.delete('!').bytes.map { |b| b.to_s(16).rjust(2, '0') }.join if from.is_a?(String)
     from_hex = from.delete('!') if from.is_a?(String)
     from = from_hex.to_i(16) if from_hex
     raise 'ERROR: from parameter is required.' unless from
 
-    to = opts[:to] ||= 0xFFFFFFFF
+    to = opts[:to] ||= '!ffffffff'
     # to_hex = to.delete('!').bytes.map { |b| b.to_s(16).rjust(2, '0') }.join if to.is_a?(String)
     to_hex = to.delete('!') if to.is_a?(String)
     to = to_hex.to_i(16) if to_hex
@@ -123,8 +123,8 @@ module Meshtastic
 
   # Supported Method Parameters::
   # Meshtastic.send_data(
-  #   from: 'required - From ID (String or Integer)',
-  #   to: 'optional - Destination ID (Default: 0xFFFFFFFF)',
+  #   from: 'required - From ID (String or Integer) (Default: "!00000b0b")',
+  #   to: 'optional - Destination ID (Default: "!ffffffff")',
   #   last_packet_id: 'optional - Last Packet ID (Default: 0)',
   #   via: 'optional - :radio || :mqtt (Default: :radio)',
   #   channel: 'optional - Channel (Default: 0)',
@@ -136,13 +136,13 @@ module Meshtastic
   # )
   public_class_method def self.send_data(opts = {})
     # Send a text message to a node
-    from = opts[:from]
+    from = opts[:from] ||= '!00000b0b'
     # from_hex = from.delete('!').bytes.map { |b| b.to_s(16).rjust(2, '0') }.join if from.is_a?(String)
     from_hex = from.delete('!') if from.is_a?(String)
     from = from_hex.to_i(16) if from_hex
     raise 'ERROR: from parameter is required.' unless from
 
-    to = opts[:to] ||= 0xFFFFFFFF
+    to = opts[:to] ||= '!ffffffff'
     # to_hex = to.delete('!').bytes.map { |b| b.to_s(16).rjust(2, '0') }.join if to.is_a?(String)
     to_hex = to.delete('!') if to.is_a?(String)
     to = to_hex.to_i(16) if to_hex
@@ -188,8 +188,8 @@ module Meshtastic
   # Supported Method Parameters::
   # Meshtastic.send_packet(
   #   mesh_packet: 'required - Mesh Packet to Send',
-  #   from: 'required - From ID (String or Integer)',
-  #   to: 'optional - Destination ID (Default: 0xFFFFFFFF)',
+  #   from: 'required - From ID (String or Integer) (Default: "!00000b0b")',
+  #   to: 'optional - Destination ID (Default: "!ffffffff")',
   #   last_packet_id: 'optional - Last Packet ID (Default: 0)',
   #   via: 'optional - :radio || :mqtt (Default: :radio)',
   #   channel: 'optional - Channel (Default: 0)',
@@ -199,13 +199,13 @@ module Meshtastic
   # )
   public_class_method def self.send_packet(opts = {})
     mesh_packet = opts[:mesh_packet]
-    from = opts[:from]
+    from = opts[:from] ||= '!00000b0b'
     # from_hex = from.delete('!').bytes.map { |b| b.to_s(16).rjust(2, '0') }.join if from.is_a?(String)
     from_hex = from.delete('!') if from.is_a?(String)
     from = from_hex.to_i(16) if from_hex
     raise 'ERROR: from parameter is required.' unless from
 
-    to = opts[:to] ||= 0xFFFFFFFF
+    to = opts[:to] ||= '!ffffffff'
     # to_hex = to.delete('!').bytes.map { |b| b.to_s(16).rjust(2, '0') }.join if to.is_a?(String)
     to_hex = to.delete('!') if to.is_a?(String)
     to = to_hex.to_i(16) if to_hex
@@ -340,7 +340,7 @@ module Meshtastic
   # Supported Method Parameters::
   # Meshtastic.gps_search(
   #   lat: 'required - latitude float (e.g. 37.7749)',
-  #   lon: 'required - longitude float (e.g. -122.4194)',
+  #   lon: 'required - longitude float (e.g. -122.4194)'
   # )
   public_class_method def self.gps_search(opts = {})
     lat = opts[:lat]
@@ -477,13 +477,74 @@ module Meshtastic
   # Display a List of Every Meshtastic Module
 
   public_class_method def self.help
-    constants.sort
-
-    # puts "USAGE:
-    #   #{self}.gps_search(
-    #     lat: 'required - latitude float (e.g. 37.7749)',
-    #     lon: 'required - longitude float (e.g. -122.4194)',
-    #   )
-    # "
+    puts "USAGE:
+      #{self}.send_text(
+        from: 'required - From ID (String or Integer) (Default: \"!00000b0b\")',
+        to: 'optional - Destination ID (Default: \"!ffffffff\")',
+        last_packet_id: 'optional - Last Packet ID (Default: 0)',
+        via: 'optional - :radio || :mqtt (Default: :radio)',
+        channel: 'optional - Channel (Default: 6)',
+        text: 'optional - Text Message (Default: SYN)',
+        want_ack: 'optional - Want Acknowledgement (Default: false)',
+        want_response: 'optional - Want Response (Default: false)',
+        hop_limit: 'optional - Hop Limit (Default: 3)',
+        on_response: 'optional - Callback on Response',
+        psks: 'optional - hash of :channel => psk key value pairs (default: { LongFast: \"AQ==\" })'
+      )
+
+      #{self}.send_data(
+        from: 'required - From ID (String or Integer) (Default: \"!00000b0b\")',
+        to: 'optional - Destination ID (Default: \"!ffffffff\")',
+        last_packet_id: 'optional - Last Packet ID (Default: 0)',
+        via: 'optional - :radio || :mqtt (Default: :radio)',
+        channel: 'optional - Channel (Default: 0)',
+        data: 'required - Data to Send',
+        want_ack: 'optional - Want Acknowledgement (Default: false)',
+        hop_limit: 'optional - Hop Limit (Default: 3)',
+        port_num: 'optional - (Default: Meshtastic::PortNum::PRIVATE_APP)',
+        psks: 'optional - hash of :channel => psk key value pairs (default: { LongFast: \"AQ==\" })'
+      )
+
+      #{self}.send_packet(
+        mesh_packet: 'required - Mesh Packet to Send',
+        from: 'required - From ID (String or Integer) (Default: \"!00000b0b\")',
+        to: 'optional - Destination ID (Default: \"!ffffffff\")',
+        last_packet_id: 'optional - Last Packet ID (Default: 0)',
+        via: 'optional - :radio || :mqtt (Default: :radio)',
+        channel: 'optional - Channel (Default: 0)',
+        want_ack: 'optional - Want Acknowledgement (Default: false)',
+        hop_limit: 'optional - Hop Limit (Default: 3)',
+        psks: 'optional - hash of :channel => psk key value pairs (default: { LongFast: \"AQ==\" })'
+      )
+
+      #{self}.generate_packet_id(
+        last_packet_id: 'optional - Last Packet ID (Default: 0)'
+      )
+
+      #{self}.get_cipher_keys(
+        psks: 'required - hash of channel / pre-shared key value pairs'
+      )
+
+      #{self}.send_to_radio(
+        to_radio: 'required - ToRadio Message to Send'
+      )
+
+      #{self}.send_to_mqtt(
+        service_envelope: 'required - ServiceEnvelope Message to Send'
+      )
+
+      #{self}.gps_search(
+        lat: 'required - latitude float (e.g. 37.7749)',
+        lon: 'required - longitude float (e.g. -122.4194)'
+      )
+
+      #{self}.decode_payload(
+        payload: 'required - payload to recursively decode',
+        msg_type: 'required - message type (e.g. :TEXT_MESSAGE_APP)',
+        gps_metadata: 'optional - include GPS metadata in output (default: false)',
+      )
+
+      #{self}.authors
+    "
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meshtastic
 version: !ruby/object:Gem::Version
-  version: 0.0.98
+  version: 0.0.99
 platform: ruby
 authors:
 - 0day Inc.