Zephyr API Documentation 4.5.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
lora_modem_config_gfsk Struct Reference

Structure containing the configuration of a GFSK modem. More...

#include <zephyr/drivers/lora.h>

Data Fields

uint32_t frequency
 Frequency in Hz to use for transceiving.
uint32_t bitrate
 Bit rate in bits per second.
uint32_t freq_deviation
 Transmit frequency deviation in Hz.
uint32_t bandwidth
 Receive bandwidth in Hz, measured across both sidebands.
enum lora_gfsk_pulse_shape pulse_shape
 Pulse shaping filter.
uint8_t sync_word [8]
 Sync word to transmit and to match on.
uint8_t sync_word_len
 Sync word length in bytes; 0 leaves the sync word out.
uint16_t preamble_len
 Length of the preamble in bytes, at most LORA_GFSK_PREAMBLE_MAX.
int8_t tx_power
 TX-power in dBm to use for transmission.
bool tx
 Set to true for transmission, false for receiving.
bool whitening
 Whiten the payload to keep the transmitted spectrum flat.
bool fixed_len
 Send and expect a fixed payload length rather than a length byte ahead of the payload.
uint8_t payload_len
 Payload length in bytes, used only when fixed_len is set.
bool packet_crc_disable
 Set to true to disable the CRC-16-CCITT over the payload.

Detailed Description

Structure containing the configuration of a GFSK modem.

Field Documentation

◆ bandwidth

uint32_t lora_modem_config_gfsk::bandwidth

Receive bandwidth in Hz, measured across both sidebands.

Radio datasheets state their channel filters this way, so a value copied from one needs no conversion. A regulation that states a single-sideband figure does: it is half of this.

A radio offers a fixed set of filters, so the driver takes the narrowest one that is at least this wide, and refuses the configuration when it has none wide enough.

◆ bitrate

uint32_t lora_modem_config_gfsk::bitrate

Bit rate in bits per second.

◆ fixed_len

bool lora_modem_config_gfsk::fixed_len

Send and expect a fixed payload length rather than a length byte ahead of the payload.

◆ freq_deviation

uint32_t lora_modem_config_gfsk::freq_deviation

Transmit frequency deviation in Hz.

◆ frequency

uint32_t lora_modem_config_gfsk::frequency

Frequency in Hz to use for transceiving.

◆ packet_crc_disable

bool lora_modem_config_gfsk::packet_crc_disable

Set to true to disable the CRC-16-CCITT over the payload.

◆ payload_len

uint8_t lora_modem_config_gfsk::payload_len

Payload length in bytes, used only when fixed_len is set.

The frame carries no length byte, so the radio clocks out exactly this many bytes and a transmission of any other length is refused.

◆ preamble_len

uint16_t lora_modem_config_gfsk::preamble_len

Length of the preamble in bytes, at most LORA_GFSK_PREAMBLE_MAX.

◆ pulse_shape

enum lora_gfsk_pulse_shape lora_modem_config_gfsk::pulse_shape

Pulse shaping filter.

◆ sync_word

uint8_t lora_modem_config_gfsk::sync_word[8]

Sync word to transmit and to match on.

◆ sync_word_len

uint8_t lora_modem_config_gfsk::sync_word_len

Sync word length in bytes; 0 leaves the sync word out.

◆ tx

bool lora_modem_config_gfsk::tx

Set to true for transmission, false for receiving.

◆ tx_power

int8_t lora_modem_config_gfsk::tx_power

TX-power in dBm to use for transmission.

◆ whitening

bool lora_modem_config_gfsk::whitening

Whiten the payload to keep the transmitted spectrum flat.


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