Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
lora_driver_api Struct Reference

Driver Operations LoRa driver operations More...

#include <zephyr/drivers/lora.h>

Data Fields

lora_api_config config
  REQ Configure the LoRa modem.
lora_api_airtime airtime
  REQ Query the airtime of a packet with a given length.
lora_api_send send
  REQ Send data over LoRa.
lora_api_send_async send_async
  REQ Asynchronously send data over LoRa.
lora_api_recv recv
  REQ Receive data over LoRa.
lora_api_recv_async recv_async
  REQ Receive data asynchronously over LoRa.
lora_api_cad cad
  OPT Perform Channel Activity Detection.
lora_api_cad_async cad_async
  OPT Perform Channel Activity Detection asynchronously.
lora_api_recv_duty_cycle_async recv_duty_cycle_async
  OPT Start receive duty cycling (wake-on-radio).
lora_api_recv_duty_cycle recv_duty_cycle
  OPT Receive data using duty cycling (wake-on-radio).
lora_api_test_cw test_cw
  OPT Transmit an unmodulated continuous wave at a given frequency.

Detailed Description

Driver Operations LoRa driver operations

This is the driver API structure any LoRa driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also
DEVICE_DT_INST_DEFINE()
DEVICE_DT_DEFINE()
DEVICE_API()

Field Documentation

◆ airtime

lora_api_airtime lora_driver_api::airtime

REQ Query the airtime of a packet with a given length.

◆ cad

lora_api_cad lora_driver_api::cad

OPT Perform Channel Activity Detection.

◆ cad_async

lora_api_cad_async lora_driver_api::cad_async

OPT Perform Channel Activity Detection asynchronously.

◆ config

lora_api_config lora_driver_api::config

REQ Configure the LoRa modem.

◆ recv

lora_api_recv lora_driver_api::recv

REQ Receive data over LoRa.

◆ recv_async

lora_api_recv_async lora_driver_api::recv_async

REQ Receive data asynchronously over LoRa.

◆ recv_duty_cycle

lora_api_recv_duty_cycle lora_driver_api::recv_duty_cycle

OPT Receive data using duty cycling (wake-on-radio).

◆ recv_duty_cycle_async

lora_api_recv_duty_cycle_async lora_driver_api::recv_duty_cycle_async

OPT Start receive duty cycling (wake-on-radio).

◆ send

lora_api_send lora_driver_api::send

REQ Send data over LoRa.

◆ send_async

lora_api_send_async lora_driver_api::send_async

REQ Asynchronously send data over LoRa.

◆ test_cw

lora_api_test_cw lora_driver_api::test_cw

OPT Transmit an unmodulated continuous wave at a given frequency.


The documentation for this struct was generated from the following file: