Enum orouter_serial::host::Message

pub enum Message {
    SendData {
        data: Vec<u8, { crate::MAX_LORA_PAYLOAD_LENGTH }>,
    },
    ReceiveData {
        data: Vec<u8, { crate::MAX_LORA_PAYLOAD_LENGTH }>,
    },
    Configure {
        region: u8,
        spreading_factor: u8,
        network: u16,
    },
    ReportRequest,
    Report {
        sn: u32,
        version_data: Vec<u8, 9>,
        region: u8,
        spreading_factor: u8,
        receive_queue_size: u8,
        transmit_queue_size: u8,
        network: u16,
    },
    Status {
        code: StatusCode,
    },
    UpgradeFirmwareRequest,
    SetTimestamp {
        timestamp: u64,
    },
    GetRawIq,
    RawIq {
        data: Vec<u8, RAWIQ_DATA_LENGTH>,
    },
}

Possible commands send over host protocol

This enum contains both messages send exlusively to node or exclusively to host

Variants

SendData

Fields

data: Vec<u8, { crate::MAX_LORA_PAYLOAD_LENGTH }>

Host sending data to node instructing it to broadcast it to the wireless network

ReceiveData

Fields

data: Vec<u8, { crate::MAX_LORA_PAYLOAD_LENGTH }>

Node sending data to host

Configure

Fields

region: u8

spreading_factor: u8

network: u16

Host is recongifuring the node

ReportRequest

Host requesting the node status

Report

Fields

sn: u32

BE encoded

version_data: Vec<u8, 9>

BE encoded

region: u8

spreading_factor: u8

receive_queue_size: u8

transmit_queue_size: u8

network: u16

Node reporting information to host

Status

Fields

code: StatusCode

Node reporting some error state to host

UpgradeFirmwareRequest

Firmware upgrade will follow

SetTimestamp

Fields

timestamp: u64

Set current time

GetRawIq

Get rawIq data

RawIq

Fields

data: Vec<u8, RAWIQ_DATA_LENGTH>

Node returns raw IQ data to host

Implementations

impl Message

pub fn try_from_cobs(buf: &mut [u8]) -> Result<Message, Error>

pub fn len(&self) -> usize

pub fn as_bytes(&self) -> Result<Vec<u8, MAX_MESSAGE_LENGTH>, Error>

pub fn encode(&self) -> Result<HostMessageVec, Error>

pub fn encode_to_slice<'a>(&self, buf: &'a mut [u8]) -> Result<usize, Error>

pub fn into_encoded_bytes(self) -> Result<HostMessageVec, Error>

pub fn as_frames<C: WireCodec>(&self) -> Result<C::Frames, Error>

Splits COBS encoded self to frames for sending. Frames can be send as is over the wire, it itself is a valid host protocol packet

Trait Implementations

impl Debug for Message

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for Message

type Err = ParseMessageError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, ParseMessageError>

Parses a string s to return a value of this type.

impl PartialEq for Message

fn eq(&self, other: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for Message

type Error = Error

The type returned in the event of a conversion error.

fn try_from(buf: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Message