Module: Meshtastic::SerialInterface

Defined in:
lib/meshtastic/serial_interface.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object

Author(s)

0day Inc. <[email protected]>



470
471
472
473
474
 
# File 'lib/meshtastic/serial_interface.rb', line 470

public_class_method def self.authors
  "AUTHOR(S):
    0day Inc. <[email protected]>
  "
end

.connect(opts = {}) ⇒ Object

Supported Method Parameters

serial_obj = Meshtastic::SerialInterface.connect(

block_dev: 'optional - serial block device path (defaults to /dev/ttyUSB0)',
baud: 'optional - (defaults to 115200)',
data_bits: 'optional - (defaults to 8)',
stop_bits: 'optional - (defaults to 1)',
parity: 'optional - :even|:mark|:odd|:space|:none (defaults to :none)'

)



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/meshtastic/serial_interface.rb', line 84

public_class_method def self.connect(opts = {})
  block_dev = opts[:block_dev] ||= '/dev/ttyUSB0'
  raise "Invalid block device: #{block_dev}" unless File.exist?(block_dev)

  baud = opts[:baud] ||= 115_200
  data_bits = opts[:data_bits] ||= 8
  stop_bits = opts[:stop_bits] ||= 1
  parity = opts[:parity] ||= :none

  case parity.to_s.to_sym
  when :even
    parity = 'E'
  when :odd
    parity = 'O'
  when :none
    parity = 'N'
  end
  raise "Invalid parity: #{opts[:parity]}" if parity.nil?

  mode = "#{data_bits}#{parity}#{stop_bits}"

  serial_conn = UART.open(
    block_dev,
    baud,
    mode
  )

  serial_obj = {}
  serial_obj[:serial_conn] = serial_conn
  serial_obj[:console_thread] = init_stdout_thread(
    serial_conn: serial_conn,
    type: :console
  )
  serial_obj[:proto_thread] = init_stdout_thread(
    serial_conn: serial_conn,
    type: :proto
  )

  wake_up_device(serial_obj: serial_obj)

  mui = Meshtastic::MeshInterface.new
  mui.start_config

  serial_obj
rescue StandardError => e
  disconnect(serial_obj: serial_obj) unless serial_obj.nil?
  raise e
end

.disconnect(opts = {}) ⇒ Object

Supported Method Parameters

serial_obj = Meshtastic.disconnect(

serial_obj: 'required - serial_obj returned from #connect method'

)



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/meshtastic/serial_interface.rb', line 450

public_class_method def self.disconnect(opts = {})
  serial_obj = opts[:serial_obj]

  if serial_obj
    console_thread = serial_obj[:console_thread]
    proto_thread = serial_obj[:proto_thread]
    serial_conn = serial_obj[:serial_conn]

    console_thread&.terminate
    proto_thread&.terminate
    serial_conn&.close
  end

  nil
rescue StandardError => e
  raise e
end

.dump_stdout_data(opts = {}) ⇒ Object

Supported Method Parameters

stdout_data = Meshtastic::SerialInterface.dump_stdout_data(

type: 'required - :proto or :console'

)



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/meshtastic/serial_interface.rb', line 152

public_class_method def self.dump_stdout_data(opts = {})
  type = opts[:type]
  valid_types = i[proto console]
  raise "ERROR: Invalid type: #{type}. Supported types are :proto or :console" unless valid_types.include?(type)

  if block_given?
    @proto_data.each { |proto_hash| yield proto_hash } if type == :proto
    @console_data.join.split("\n").each{ |line| yield line.force_encoding('UTF-8') } if type == :console
  else
    stdout_data = @proto_data if type == :proto
    stdout_data = @console_data.join if type == :console

    stdout_data
  end
rescue StandardError => e
  raise e
end

.flush_data(opts = {}) ⇒ Object

Supported Method Parameters

console_data = Meshtastic::SerialInterface.flush_data(opts = {})



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/meshtastic/serial_interface.rb', line 173

public_class_method def self.flush_data(opts = {})
  type = opts[:type]
  valid_types = i[proto console]
  raise "ERROR: Invalid type: #{type}. Supported types are :proto or :console" unless valid_types.include?(type)

  @console_data.clear if type == :console
  @proto_data.clear if type == :proto
rescue StandardError => e
  raise e
end

.help ⇒ Object

Display Usage for this Module



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/meshtastic/serial_interface.rb', line 478

public_class_method def self.help
  puts "USAGE:
    serial_obj = #{self}.connect(
      host: 'optional - mqtt host (default: mqtt.meshtastic.org)',
      port: 'optional - mqtt port (defaults: 1883)',
      tls: 'optional - use TLS (default: false)',
      username: 'optional - mqtt username (default: meshdev)',
      password: 'optional - (default: large4cats)',
      client_id: 'optional - client ID (default: random 4-byte hex string)',
      keep_alive: 'optional - keep alive interval (default: 15)',
      ack_timeout: 'optional - acknowledgement timeout (default: 30)'
    )

    #{self}.wake_up_device(
      serial_obj: 'required - serial_obj returned from #connect method'
    )

    #{self}.request(
      serial_obj: 'required serial_obj returned from #connect method',
      payload: 'required - array of bytes OR string to write to serial device (e.g. [0x00, 0x41, 0x90, 0x00] OR \"\\x00\\x41\\c90\\x00\\r\\n\"'
    )

    stdout_data = #{self}.dump_stdout_data(
      type: 'required - :proto or :console'
    )

    #{self}.flush_data(
      type: 'optional - :console or :proto (default: nil)'
    )

    #{self}.monitor_stdout(
      type: 'required - :proto or :console',
      refresh: 'optional - refresh interval (default: 3)',
      include: 'optional - comma-delimited string(s) to include in message (default: nil)',
      exclude: 'optional - comma-delimited string(s) to exclude in message (default: nil)',
    )

    #{self}.subscribe(
      serial_obj: 'required - serial_obj object returned from #connect method',
      root_topic: 'optional - root topic (default: msh)',
      region: 'optional - region e.g. 'US/VA', etc (default: US)',
      channel_topic: 'optional - channel ID path e.g. '2/stat/#' (default: '2/e/LongFast/#')',
      psks: 'optional - hash of :channel_id => psk key value pairs (default: { LongFast: 'AQ==' })',
      qos: 'optional - quality of service (default: 0)',
      json: 'optional - JSON output (default: false)',
      exclude: 'optional - comma-delimited string(s) to exclude in message (default: nil)',
      include: 'optional - comma-delimited string(s) to include on in message (default: nil)',
      gps_metadata: 'optional - include GPS metadata in output (default: false)'
    )

    #{self}.send_text(
      serial_obj: 'required - serial_obj returned from #connect method',
      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)',
      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==' })'
    )

    serial_obj = #{self}.disconnect(
      serial_obj: 'required - serial_obj object returned from #connect method'
    )

    #{self}.authors
  "
end

.monitor_stdout(opts = {}) ⇒ Object

Supported Method Parameters

console_data = Meshtastic::SerialInterface.monitor_stdout(

serial_obj: 'required - serial_obj returned from #connect method',
type: 'required - :proto or :console',
refresh: 'optional - refresh interval (default: 3)',
include: 'optional - comma-delimited string(s) to include in message (default: nil)',
exclude: 'optional - comma-delimited string(s) to exclude in message (default: nil)'

)



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/meshtastic/serial_interface.rb', line 193

public_class_method def self.monitor_stdout(opts = {})
  serial_obj = opts[:serial_obj]
  type = opts[:type]
  valid_types = i[proto console]
  raise "ERROR: Invalid type: #{type}. Supported types are :proto or :console" unless valid_types.include?(type)

  refresh = opts[:refresh] ||= 3
  include = opts[:include]
  exclude = opts[:exclude]

  loop do
    exclude_arr = exclude.to_s.split(',').map(&:strip)
    include_arr = include.to_s.split(',').map(&:strip)

    dump_stdout_data(type: type) do |data|
      disp = false
      disp = true if exclude_arr.none? { |exclude| data.include?(exclude) } && (
                       include_arr.empty? ||
                       include_arr.all? { |include| data.include?(include) }
                     )
      puts data if disp
      flush_data(type: type)
    end
    sleep refresh
  end
rescue Interrupt
  puts "\nCTRL+C detected. Breaking out of console mode..."
  disconnect(serial_obj: serial_obj) unless serial_obj.nil?
rescue StandardError => e
  disconnect(serial_obj: serial_obj) unless serial_obj.nil?
  raise e
end

.request(opts = {}) ⇒ Object

Supported Method Parameters

Meshtastic::SerialInterface.request(

serial_obj: 'required serial_obj returned from #connect method',
payload: 'required - array of bytes OR string to write to serial device (e.g. [0x00, 0x41, 0x90, 0x00] OR "\x00\x41\cc90\x00\r\n"'

)



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/meshtastic/serial_interface.rb', line 54

public_class_method def self.request(opts = {})
  serial_obj = opts[:serial_obj]
  serial_conn = serial_obj[:serial_conn]
  payload = opts[:payload]

  byte_arr = nil
  byte_arr = payload if payload.instance_of?(Array)
  byte_arr = payload.chars if payload.instance_of?(String)
  raise "ERROR: Invalid payload type: #{payload.class}" if byte_arr.nil?

  byte_arr.each do |byte|
    serial_conn.putc(byte)
  end

  sleep(0.1)
  serial_conn.flush
rescue StandardError => e
  disconnect(serial_obj: serial_obj) unless serial_obj.nil?
  raise e
end

.send_text(opts = {}) ⇒ Object

Supported Method Parameters

Meshtastic::SerialInterface.send_text(

serial_obj: 'required - serial_obj returned from #connect method',
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)',
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_id => psk key value pairs (default: { LongFast: "AQ==" })'

)



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/meshtastic/serial_interface.rb', line 430

public_class_method def self.send_text(opts = {})
  # serial_obj = opts[:serial_obj]
  # topic = opts[:topic] ||= 'msh/US/2/e/LongFast/#'
  opts[:via] = :radio

  # TODO: Implement chunked message to deal with large messages
  mui = Meshtastic::MeshInterface.new
  mui.send_text(opts)

  # TODO: serial equivalent of publish
  # serial_obj.publish(topic, protobuf_text)
rescue StandardError => e
  serial_obj = disconnect(serial_obj: serial_obj) unless serial_obj.nil?
  raise e
end

.subscribe(opts = {}) ⇒ Object

Supported Method Parameters

Meshtastic::SerialInterface.subscribe(

serial_obj: 'required - serial_obj returned from #connect method'
root_topic: 'optional - root topic (default: msh)',
region: 'optional - region e.g. 'US/VA', etc (default: US)',
channel_topic: 'optional - channel ID path e.g. "2/stat/#" (default: "2/e/LongFast/#")',
psks: 'optional - hash of :channel_id => psk key value pairs (default: { LongFast: "AQ==" })',
qos: 'optional - quality of service (default: 0)',
exclude: 'optional - comma-delimited string(s) to exclude in message (default: nil)',
include: 'optional - comma-delimited string(s) to include on in message (default: nil)',
gps_metadata: 'optional - include GPS metadata in output (default: false)',
include_raw: 'optional - include raw packet data in output (default: false)'

)



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/meshtastic/serial_interface.rb', line 240

public_class_method def self.subscribe(opts = {})
  serial_obj = opts[:serial_obj]
  root_topic = opts[:root_topic] ||= 'msh'
  region = opts[:region] ||= 'US'
  channel_topic = opts[:channel_topic] ||= '2/e/LongFast/#'
  # TODO: Support Array of PSKs and attempt each until decrypted

  public_psk = '1PG7OiApB1nwvP+rz05pAQ=='
  psks = opts[:psks] ||= { LongFast: public_psk }
  raise 'ERROR: psks parameter must be a hash of :channel_id => psk key value pairs' unless psks.is_a?(Hash)

  psks[:LongFast] = public_psk if psks[:LongFast] == 'AQ=='
  mui = Meshtastic::MeshInterface.new
  psks = mui.get_cipher_keys(psks: psks)

  qos = opts[:qos] ||= 0
  json = opts[:json] ||= false
  exclude = opts[:exclude]
  include = opts[:include]
  gps_metadata = opts[:gps_metadata] ||= false
  include_raw = opts[:include_raw] ||= false

  # NOTE: Use MQTT Explorer for topic discovery
  full_topic = "#{root_topic}/#{region}/#{channel_topic}"
  full_topic = "#{root_topic}/#{region}" if region == '#'
  puts "Subscribing to: #{full_topic}"
  serial_obj.subscribe(full_topic, qos)

  # MQTT::ProtocolException: No Ping Response received for 23 seconds (MQTT::ProtocolException)

  include_arr = include.to_s.split(',').map(&:strip)
  exclude_arr = exclude.to_s.split(',').map(&:strip)
  serial_obj.get_packet do |packet_bytes|
    raw_packet = packet_bytes.to_s if include_raw
    raw_topic = packet_bytes.topic ||= ''
    raw_payload = packet_bytes.payload ||= ''

    begin
      disp = false
      decoded_payload_hash = {}
      message = {}
      stdout_message = ''

      if json
        decoded_payload_hash = JSON.parse(raw_payload, symbolize_names: true)
      else
        # decoded_payload = Meshtastic::ToRadio.decode(raw_payload)
        decoded_payload = Meshtastic::FromRadio.decode(raw_payload)
        decoded_payload_hash = decoded_payload.to_h
      end

      next unless decoded_payload_hash[:packet].is_a?(Hash)

      message = decoded_payload_hash[:packet] if decoded_payload_hash.keys.include?(:packet)
      message[:topic] = raw_topic
      message[:node_id_from] = "!#{message[:from].to_i.to_s(16)}"
      message[:node_id_to] = "!#{message[:to].to_i.to_s(16)}"
      if message.keys.include?(:rx_time)
        rx_time_int = message[:rx_time]
        if rx_time_int.is_a?(Integer)
          rx_time_utc = Time.at(rx_time_int).utc.to_s
          message[:rx_time_utc] = rx_time_utc
        end
      end

      if message.keys.include?(:public_key)
        raw_public_key = message[:public_key]
        message[:public_key] = Base64.strict_encode64(raw_public_key)
      end

      # If encrypted_message is not nil, then decrypt
      # the message prior to decoding.
      encrypted_message = message[:encrypted]
      if encrypted_message.to_s.length.positive? &&
         message[:topic]

        # if message[:pki_encrypted]
        #   # TODO: Display Decrypted PKI Message
        #   public_key = message[:public_key]
        #   dec_public_key = Base64.strict_decode64(public_key)
        # else
        packet_id = message[:id]
        packet_from = message[:from]

        nonce_packet_id = [packet_id].pack('V').ljust(8, "\x00")
        nonce_from_node = [packet_from].pack('V').ljust(8, "\x00")
        nonce = "#{nonce_packet_id}#{nonce_from_node}"

        psk = psks[:LongFast]
        target_channel = message[:topic].split('/')[-2].to_sym
        psk = psks[target_channel] if psks.keys.include?(target_channel)
        dec_psk = Base64.strict_decode64(psk)

        cipher = OpenSSL::Cipher.new('AES-128-CTR')
        cipher = OpenSSL::Cipher.new('AES-256-CTR') if dec_psk.length == 32
        cipher.decrypt
        cipher.key = dec_psk
        cipher.iv = nonce

        decrypted = cipher.update(encrypted_message) + cipher.final
        # end
        message[:decoded] = Meshtastic::Data.decode(decrypted).to_h
        message[:encrypted] = :decrypted
      end

      if message[:decoded]
        # payload = Meshtastic::Data.decode(message[:decoded][:payload]).to_h
        payload = message[:decoded][:payload]
        msg_type = message[:decoded][:portnum]
        mui = Meshtastic::MeshInterface.new
        message[:decoded][:payload] = mui.decode_payload(
          payload: payload,
          msg_type: msg_type,
          gps_metadata: gps_metadata
        )
      end

      message[:raw_packet] = raw_packet if include_raw
      decoded_payload_hash[:packet] = message
      unless block_given?
        message[:stdout] = 'pretty'
        stdout_message = JSON.pretty_generate(decoded_payload_hash)
      end
    rescue Encoding::CompatibilityError,
           Google::Protobuf::ParseError,
           JSON::GeneratorError,
           ArgumentError => e

      unless e.is_a?(Encoding::CompatibilityError)
        message[:decrypted] = e.message if e.message.include?('key must be')
        message[:decrypted] = 'unable to decrypt - psk?' if e.message.include?('occurred during parsing')
        decoded_payload_hash[:packet] = message
        unless block_given?
          puts "WARNING: #{e.inspect} - MSG IS >>>"
          # puts e.backtrace
          message[:stdout] = 'inspect'
          stdout_message = decoded_payload_hash.inspect
        end
      end

      next
    ensure
      include_arr = [message[:id].to_s] if include_arr.empty?
      if message.is_a?(Hash)
        flat_message = message.values.join(' ')

        disp = true if exclude_arr.none? { |exclude| flat_message.include?(exclude) } && (
                         include_arr.first == message[:id] ||
                         include_arr.all? { |include| flat_message.include?(include) }
                       )

        if disp
          if block_given?
            yield decoded_payload_hash
          else
            puts "\n"
            puts '-' * 80
            puts 'MSG:'
            puts stdout_message
            puts '-' * 80
            puts "\n\n\n"
          end
          # else
          # print '.'
        end
      end
    end
  end
rescue Interrupt
  puts "\nCTRL+C detected. Exiting..."
  serial_obj = disconnect(serial_obj: serial_obj) unless serial_obj.nil?
rescue StandardError => e
  serial_obj = disconnect(serial_obj: serial_obj) unless serial_obj.nil?
  raise e
end

.wake_up_device(opts = {}) ⇒ Object

Supported Method Parameters

wake_up_device(

serial_obj: 'required - serial_obj returned from #connect method'

)



137
138
139
140
141
142
143
144
145
 
# File 'lib/meshtastic/serial_interface.rb', line 137

public_class_method def self.wake_up_device(opts = {})
  serial_obj = opts[:serial_obj]

  start2_byte_arr = [START2].pack('C') * 32
  request(serial_obj: serial_obj, payload: start2_byte_arr)
rescue StandardError => e
  disconnect(serial_obj: serial_obj) unless serial_obj.nil?
  raise e
end