Struct Modem 

pub struct Modem<'a, AtCl, const N: usize, const L: usize> { /* private fields */ }

A handle to the modem, providing access to AT command operations and URC subscription handling.

Implementations

impl<'a, AtCl, const N: usize, const L: usize> Modem<'a, AtCl, N, L>

where AtCl: AtatClient,

pub fn new(client: AtCl, urc_chan: &'a UrcChannel<Urc, N, L>) -> Self

Constructs a new Modem instance with a client, URC channel, and shared state.

Arguments

• client: An AT command client for communicating with the modem.
• urc_chan: A reference to the URC channel used to receive asynchronous modem messages.

This method does not initialize the modem; call begin to do so.

pub fn urc_handler(&self) -> UrcHandler<'a, N, L>

Creates a new URC handler associated with this modem.

The URC handler will subscribe to unsolicited messages from the modem and process them, updating shared state where necessary. The user must run the UrcHandler to begin handling messages.

Panics

Panics if the subscription to the URC channel fails (e.g., buffer full or uninitialized).

pub async fn send<Cmd: AtatCmd>( &mut self, cmd: &Cmd, ) -> Result<Cmd::Response, Error>

pub async fn begin(&mut self) -> Result<(), Error>

Initializes the modem by sending basic configuration commands.

This method must be called once before other modem operations are invoked. It is safe to call multiple times; subsequent calls will be no-ops.

• Enables numeric CME error reporting.
• Enables network registration URC reporting.

pub async fn get_operation_mode(&mut self) -> Result<RAT, Error>

pub async fn set_opeartion_mode(&mut self, mode: RAT) -> Result<(), Error>

pub async fn ping(&mut self) -> Result<(), Error>

pub async fn define_pdp_context(&mut self) -> Result<(), Error>

pub async fn set_op_state(&mut self, mode: FunctionalMode) -> Result<(), Error>

pub fn get_network_registration_state(&self) -> NetworkRegistrationState

impl<'sub, AtCl, const N: usize, const L: usize> Modem<'sub, AtCl, N, L>

where AtCl: AtatClient,

pub async fn lte_connect(&mut self) -> Result<(), Error>

Connect to the LTE network.

This function will connect the modem to the LTE network. This function will block until the modem is attached.

pub async fn lte_disconnect(&mut self) -> Result<(), Error>

Disconnect from the LTE network.

This function will disconnect the modem from the LTE network and block until the network is actually disconnected. After the network is disconnected the GNSS subsystem can be used.

impl<'sub, AtCl, const N: usize, const L: usize> Modem<'sub, AtCl, N, L>

where AtCl: AtatClient,

pub async fn mqtt_configure( &mut self, client_id: &str, auth: Option<MqttAuth>, ) -> Result<(), Error>

pub async fn mqtt_connect(&mut self, host: &str) -> Result<(), Error>

pub async fn mqtt_send( &mut self, topic: &str, qos: Qos, data: &[u8], ) -> Result<(), Error>

pub async fn mqtt_disconnect(&mut self) -> Result<(), Error>

impl<'sub, AtCl, const N: usize, const L: usize> Modem<'sub, AtCl, N, L>

where AtCl: AtatClient,

pub async fn nvm_write( &mut self, data_type: DataType, index: u8, data: &[u8], ) -> Result<(), Error>

impl<'sub, AtCl, const N: usize, const L: usize> Modem<'sub, AtCl, N, L>

where AtCl: AtatClient,

pub async fn configure_tls_profile( &mut self, sp_id: u8, ca_cert_id: u8, client_cert_id: u8, client_private_key_id: u8, ) -> Result<(), Error>

Configures TLS/SSL security profile for use with e.g. MQTT.

Certificates first need to be written to NVM (boot persistent).