Meshcore.Reader (Meshcore v0.1.0)

Copy Markdown View Source

Decodes frames received from the device into Meshcore.Events.

The reader is a pure state machine (no processes): handle_rx/2 takes a frame and returns the events it produced together with the updated reader. It keeps only the state needed to turn frames into events:

  • the contact list currently being received (CONTACT_START … CONTACT_END),
  • pending binary requests (so :binary_response frames can be decoded into :status_response, :telemetry_response, :mma_response, :acl_response and :neighbours_response events),
  • the Meshcore.PacketParser used for RX-log decoding and channel-message path correlation.

Malformed or truncated frames never raise: they are logged and dropped, as in the Python implementation.

Summary

Types

pending()
t()

Functions

cleanup_expired(r)

Drops expired pending binary requests.

decrypt_channels?(reader)

Whether channel decryption is enabled.

handle_rx(reader, data)

Decodes one frame. Returns {events, reader}; events is in dispatch order.

new()

Creates a new reader.

register_binary_request(r, prefix, tag, request_type, timeout_ms, opts \\ [])

Registers a pending binary request keyed by its expected tag (hex), so the matching :binary_response can be decoded. Expired registrations are purged.

set_decrypt_channels(r, value)

Enables or disables decryption of group-channel packets in the RX log.

Types

pending()

@type pending() :: %{
  request_type: atom(),
  pubkey_prefix: String.t(),
  expires_at: integer(),
  is_anon: boolean(),
  context: map()
}

t()

@type t() :: %Meshcore.Reader{
  contact_nb: non_neg_integer(),
  contacts: %{required(String.t()) => map()},
  parser: Meshcore.PacketParser.t(),
  pending_binary_requests: %{required(String.t()) => pending()}
}

Functions

cleanup_expired(r)

@spec cleanup_expired(t()) :: t()

Drops expired pending binary requests.

decrypt_channels?(reader)

@spec decrypt_channels?(t()) :: boolean()

Whether channel decryption is enabled.

handle_rx(reader, data)

@spec handle_rx(t(), binary()) :: {[Meshcore.Event.t()], t()}

Decodes one frame. Returns {events, reader}; events is in dispatch order.

new()

@spec new() :: t()

Creates a new reader.

register_binary_request(r, prefix, tag, request_type, timeout_ms, opts \\ [])

@spec register_binary_request(
  t(),
  String.t(),
  String.t(),
  atom(),
  non_neg_integer(),
  keyword()
) :: t()

Registers a pending binary request keyed by its expected tag (hex), so the matching :binary_response can be decoded. Expired registrations are purged.

Options: :context (map copied into the result), :is_anon (boolean).

set_decrypt_channels(r, value)

@spec set_decrypt_channels(t(), boolean()) :: t()

Enables or disables decryption of group-channel packets in the RX log.