Type definitions#

Modules#

sid_pal_radio_lora_modulation_params_t

sid_pal_radio_lora_packet_params_t

sid_pal_radio_lora_rx_packet_status_t

sid_pal_radio_lora_cad_params_t

sid_pal_radio_lora_phy_settings_t

Enumerations#

enum
sid_pal_radio_lora_crc_present_t {
SID_PAL_RADIO_CRC_PRESENT_INVALID = 0
SID_PAL_RADIO_CRC_PRESENT_OFF = 1
SID_PAL_RADIO_CRC_PRESENT_ON = 2
SID_PAL_RADIO_CRC_PRESENT_MAX_NUM = SID_PAL_RADIO_CRC_PRESENT_ON
}

Sidewalk phy lora crc present.

Macros#

#define
SID_PAL_RADIO_LORA_SF5 0x05

Spreading Factor.

#define
SID_PAL_RADIO_LORA_SF6 0x06

Spreading factor 6

#define
SID_PAL_RADIO_LORA_SF7 0x07

Spreading factor 7

#define
SID_PAL_RADIO_LORA_SF8 0x08

Spreading factor 8

#define
SID_PAL_RADIO_LORA_SF9 0x09

Spreading factor 9

#define
SID_PAL_RADIO_LORA_SF10 0x0A

Spreading factor 10

#define
SID_PAL_RADIO_LORA_SF11 0x0B

Spreading factor 11

#define
SID_PAL_RADIO_LORA_SF12 0x0C

Spreading factor 12

#define
SID_PAL_RADIO_LORA_BW_7KHZ 0x00

Bandwidth.

#define
SID_PAL_RADIO_LORA_BW_10KHZ 0x08

Bandwidth of 10.4 KHz.

#define
SID_PAL_RADIO_LORA_BW_15KHZ 0x01

Bandwidth of 15.6 KHz.

#define
SID_PAL_RADIO_LORA_BW_20KHZ 0x09

Bandwidth of 20.8 KHz.

#define
SID_PAL_RADIO_LORA_BW_31KHZ 0x02

Bandwidth of 31.25 KHz.

#define
SID_PAL_RADIO_LORA_BW_41KHZ 0x0A

Bandwidth of 41.7 KHz.

#define
SID_PAL_RADIO_LORA_BW_62KHZ 0x03

Bandwidth of 62.5 KHz.

#define
SID_PAL_RADIO_LORA_BW_125KHZ 0x04

Bandwidth of 125 KHz.

#define
SID_PAL_RADIO_LORA_BW_250KHZ 0x05

Bandwidth of 250 KHz.

#define
SID_PAL_RADIO_LORA_BW_500KHZ 0x06

Bandwidth of 500 KHz.

#define
SID_PAL_RADIO_LORA_CODING_RATE_4_5 0x01

Coding Rate.

#define
SID_PAL_RADIO_LORA_CODING_RATE_4_6 0x02

Coding rate 4/6

#define
SID_PAL_RADIO_LORA_CODING_RATE_4_7 0x03

Coding rate 4/7

#define
SID_PAL_RADIO_LORA_CODING_RATE_4_8 0x04

Coding rate 4/8

#define
SID_PAL_RADIO_LORA_CODING_RATE_4_5_LI 0x05

Coding rate 4/5 LI

#define
SID_PAL_RADIO_LORA_CODING_RATE_4_6_LI 0x06

Coding rate 4/6 LI

#define
SID_PAL_RADIO_LORA_CODING_RATE_4_8_LI 0x07

Coding rate 4/8 LI

#define
SID_PAL_RADIO_LORA_HEADER_TYPE_VARIABLE_LENGTH 0x00

packet params header type

#define
SID_PAL_RADIO_LORA_HEADER_TYPE_FIXED_LENGTH 0x01

Fixed length header

#define
SID_PAL_RADIO_LORA_CRC_OFF 0x00

packet params crc modes

#define
SID_PAL_RADIO_LORA_CRC_ON 0x01

CRC on

#define
SID_PAL_RADIO_LORA_IQ_NORMAL 0x00

packet params IQ modes

#define
SID_PAL_RADIO_LORA_IQ_INVERTED 0x01

Inverted IQ

#define
SID_PAL_RADIO_LORA_LDR_LONG_INTERLEAVER_OFF 0x00

packet params LI modes

#define
SID_PAL_RADIO_LORA_LDR_LONG_INTERLEAVER_ON 0x01

Long interleaver on

#define
SID_PAL_RADIO_LORA_CAD_01_SYMBOL 0x00

cad params

#define
SID_PAL_RADIO_LORA_CAD_02_SYMBOL 0x01

02 symbol

#define
SID_PAL_RADIO_LORA_CAD_04_SYMBOL 0x02

04 symbol

#define
SID_PAL_RADIO_LORA_CAD_08_SYMBOL 0x03

08 symbol

#define
SID_PAL_RADIO_LORA_CAD_16_SYMBOL 0x04

16 symbol

#define
SID_PAL_RADIO_LORA_CAD_EXIT_MODE_CAD_RX 0x01

CAD followed by RX

#define
SID_PAL_RADIO_LORA_CAD_EXIT_MODE_CAD_LBT 0x10

CAD followed by LBT

#define
SID_PAL_RADIO_LORA_SF5_SF6_MIN_PREAMBLE_LEN 12

Minimum preamble length for SF5 and SF6

#define
SECS_TO_MUS (X)

timeout duration in usec.

#define
SID_PAL_RADIO_LORA_CAD_DEFAULT_TX_TIMEOUT SECS_TO_MUS(5)

set max radio timeout to 5sec

#define
SID_PAL_RADIO_LORA_DEFAULT_TX_TIMEOUT SID_PAL_RADIO_LORA_CAD_DEFAULT_TX_TIMEOUT

Default transmission timeout

#define
SID_PAL_RADIO_LORA_TIMEOUT_DURATION_1_SEC SECS_TO_MUS(1)

1 sec timeout used by diagnostics code

#define
SID_PAL_RADIO_LORA_PRIVATE_NETWORK_SYNC_WORD 0x1424

Private network sync word

#define
SID_PAL_RADIO_LORA_PUBLIC_NETWORK_SYNC_WORD LORA_MAC_PUBLIC_SYNCWORD

Public network sync word

#define
SID_PAL_RADIO_LORA_MAX_PAYLOAD_LENGTH 250

Maximum payload length

#define
SID_PAL_RADIO_LORA_ED_PREAMBLE_LENGTH_DEFAULT (250 << 3)

Default preamble length

#define
SID_PAL_RADIO_LORA_ED_MOD_SHAPING MOD_SHAPING_G_BT_1

Default modulation shaping

#define
SID_PAL_RADIO_LORA_ED_PREAMBLE_MIN_DETECT RADIO_PREAMBLE_DETECTOR_08_BITS

Default preamble detection

#define
SID_PAL_RADIO_LORA_ED_SYNCWORD_LENGTH_DEFAULT (3 << 3)

Default sync word length

#define
SID_PAL_RADIO_LORA_ED_ADDRCOMP_DEFAULT RADIO_ADDRESSCOMP_FILT_OFF

Default address comparison

#define
SID_PAL_RADIO_LORA_ED_HEADER_TYPE_DEFAULT RADIO_PACKET_VARIABLE_LENGTH

Default header type

#define
SID_PAL_RADIO_LORA_ED_CRC_LENGTH_DEFAULT RADIO_CRC_2_BYTES_CCIT

Default CRC length

#define
SID_PAL_RADIO_LORA_ED_RADIO_WHITENING_MODE_DEFAULT RADIO_DC_FREEWHITENING

Default whitening mode

#define
SID_PAL_RADIO_LORA_ED_PAYLOAD_LENGTH_DEFAULT 0

Default payload length

#define
SID_PAL_RADIO_LORA_ED_DEFAULT_WHITENING_SEED 0x01FF

Default whitening seed

Enumeration Documentation#

sid_pal_radio_lora_crc_present_t#

sid_pal_radio_lora_crc_present_t

Sidewalk phy lora crc present.

Enumerator
SID_PAL_RADIO_CRC_PRESENT_INVALID

Invalid value

SID_PAL_RADIO_CRC_PRESENT_OFF

CRC not present

SID_PAL_RADIO_CRC_PRESENT_ON

CRC present

SID_PAL_RADIO_CRC_PRESENT_MAX_NUM

Maximum number of CRC present


Macro Definition Documentation#

SID_PAL_RADIO_LORA_SF5#

#define SID_PAL_RADIO_LORA_SF5
Value:
0x05

Spreading Factor.

Spreading factor 5


SID_PAL_RADIO_LORA_SF6#

#define SID_PAL_RADIO_LORA_SF6
Value:
0x06

Spreading factor 6


SID_PAL_RADIO_LORA_SF7#

#define SID_PAL_RADIO_LORA_SF7
Value:
0x07

Spreading factor 7


SID_PAL_RADIO_LORA_SF8#

#define SID_PAL_RADIO_LORA_SF8
Value:
0x08

Spreading factor 8


SID_PAL_RADIO_LORA_SF9#

#define SID_PAL_RADIO_LORA_SF9
Value:
0x09

Spreading factor 9


SID_PAL_RADIO_LORA_SF10#

#define SID_PAL_RADIO_LORA_SF10
Value:
0x0A

Spreading factor 10


SID_PAL_RADIO_LORA_SF11#

#define SID_PAL_RADIO_LORA_SF11
Value:
0x0B

Spreading factor 11


SID_PAL_RADIO_LORA_SF12#

#define SID_PAL_RADIO_LORA_SF12
Value:
0x0C

Spreading factor 12


SID_PAL_RADIO_LORA_BW_7KHZ#

#define SID_PAL_RADIO_LORA_BW_7KHZ
Value:
0x00

Bandwidth.

Bandwidth of 7.8 KHz.


SID_PAL_RADIO_LORA_BW_10KHZ#

#define SID_PAL_RADIO_LORA_BW_10KHZ
Value:
0x08

Bandwidth of 10.4 KHz.


SID_PAL_RADIO_LORA_BW_15KHZ#

#define SID_PAL_RADIO_LORA_BW_15KHZ
Value:
0x01

Bandwidth of 15.6 KHz.


SID_PAL_RADIO_LORA_BW_20KHZ#

#define SID_PAL_RADIO_LORA_BW_20KHZ
Value:
0x09

Bandwidth of 20.8 KHz.


SID_PAL_RADIO_LORA_BW_31KHZ#

#define SID_PAL_RADIO_LORA_BW_31KHZ
Value:
0x02

Bandwidth of 31.25 KHz.


SID_PAL_RADIO_LORA_BW_41KHZ#

#define SID_PAL_RADIO_LORA_BW_41KHZ
Value:
0x0A

Bandwidth of 41.7 KHz.


SID_PAL_RADIO_LORA_BW_62KHZ#

#define SID_PAL_RADIO_LORA_BW_62KHZ
Value:
0x03

Bandwidth of 62.5 KHz.


SID_PAL_RADIO_LORA_BW_125KHZ#

#define SID_PAL_RADIO_LORA_BW_125KHZ
Value:
0x04

Bandwidth of 125 KHz.


SID_PAL_RADIO_LORA_BW_250KHZ#

#define SID_PAL_RADIO_LORA_BW_250KHZ
Value:
0x05

Bandwidth of 250 KHz.


SID_PAL_RADIO_LORA_BW_500KHZ#

#define SID_PAL_RADIO_LORA_BW_500KHZ
Value:
0x06

Bandwidth of 500 KHz.


SID_PAL_RADIO_LORA_CODING_RATE_4_5#

#define SID_PAL_RADIO_LORA_CODING_RATE_4_5
Value:
0x01

Coding Rate.

Coding rate 4/5


SID_PAL_RADIO_LORA_CODING_RATE_4_6#

#define SID_PAL_RADIO_LORA_CODING_RATE_4_6
Value:
0x02

Coding rate 4/6


SID_PAL_RADIO_LORA_CODING_RATE_4_7#

#define SID_PAL_RADIO_LORA_CODING_RATE_4_7
Value:
0x03

Coding rate 4/7


SID_PAL_RADIO_LORA_CODING_RATE_4_8#

#define SID_PAL_RADIO_LORA_CODING_RATE_4_8
Value:
0x04

Coding rate 4/8


SID_PAL_RADIO_LORA_CODING_RATE_4_5_LI#

#define SID_PAL_RADIO_LORA_CODING_RATE_4_5_LI
Value:
0x05

Coding rate 4/5 LI


SID_PAL_RADIO_LORA_CODING_RATE_4_6_LI#

#define SID_PAL_RADIO_LORA_CODING_RATE_4_6_LI
Value:
0x06

Coding rate 4/6 LI


SID_PAL_RADIO_LORA_CODING_RATE_4_8_LI#

#define SID_PAL_RADIO_LORA_CODING_RATE_4_8_LI
Value:
0x07

Coding rate 4/8 LI


SID_PAL_RADIO_LORA_HEADER_TYPE_VARIABLE_LENGTH#

#define SID_PAL_RADIO_LORA_HEADER_TYPE_VARIABLE_LENGTH
Value:
0x00

packet params header type

Variable length header


SID_PAL_RADIO_LORA_HEADER_TYPE_FIXED_LENGTH#

#define SID_PAL_RADIO_LORA_HEADER_TYPE_FIXED_LENGTH
Value:
0x01

Fixed length header


SID_PAL_RADIO_LORA_CRC_OFF#

#define SID_PAL_RADIO_LORA_CRC_OFF
Value:
0x00

packet params crc modes

CRC off


SID_PAL_RADIO_LORA_CRC_ON#

#define SID_PAL_RADIO_LORA_CRC_ON
Value:
0x01

CRC on


SID_PAL_RADIO_LORA_IQ_NORMAL#

#define SID_PAL_RADIO_LORA_IQ_NORMAL
Value:
0x00

packet params IQ modes

Normal IQ


SID_PAL_RADIO_LORA_IQ_INVERTED#

#define SID_PAL_RADIO_LORA_IQ_INVERTED
Value:
0x01

Inverted IQ


SID_PAL_RADIO_LORA_LDR_LONG_INTERLEAVER_OFF#

#define SID_PAL_RADIO_LORA_LDR_LONG_INTERLEAVER_OFF
Value:
0x00

packet params LI modes

Long interleaver off


SID_PAL_RADIO_LORA_LDR_LONG_INTERLEAVER_ON#

#define SID_PAL_RADIO_LORA_LDR_LONG_INTERLEAVER_ON
Value:
0x01

Long interleaver on


SID_PAL_RADIO_LORA_CAD_01_SYMBOL#

#define SID_PAL_RADIO_LORA_CAD_01_SYMBOL
Value:
0x00

cad params

01 symbol


SID_PAL_RADIO_LORA_CAD_02_SYMBOL#

#define SID_PAL_RADIO_LORA_CAD_02_SYMBOL
Value:
0x01

02 symbol


SID_PAL_RADIO_LORA_CAD_04_SYMBOL#

#define SID_PAL_RADIO_LORA_CAD_04_SYMBOL
Value:
0x02

04 symbol


SID_PAL_RADIO_LORA_CAD_08_SYMBOL#

#define SID_PAL_RADIO_LORA_CAD_08_SYMBOL
Value:
0x03

08 symbol


SID_PAL_RADIO_LORA_CAD_16_SYMBOL#

#define SID_PAL_RADIO_LORA_CAD_16_SYMBOL
Value:
0x04

16 symbol


SID_PAL_RADIO_LORA_CAD_EXIT_MODE_CAD_ONLY#

#define SID_PAL_RADIO_LORA_CAD_EXIT_MODE_CAD_ONLY
Value:
0x00

CAD only


SID_PAL_RADIO_LORA_CAD_EXIT_MODE_CAD_RX#

#define SID_PAL_RADIO_LORA_CAD_EXIT_MODE_CAD_RX
Value:
0x01

CAD followed by RX


SID_PAL_RADIO_LORA_CAD_EXIT_MODE_CAD_LBT#

#define SID_PAL_RADIO_LORA_CAD_EXIT_MODE_CAD_LBT
Value:
0x10

CAD followed by LBT


SID_PAL_RADIO_LORA_SF5_SF6_MIN_PREAMBLE_LEN#

#define SID_PAL_RADIO_LORA_SF5_SF6_MIN_PREAMBLE_LEN
Value:
12

Minimum preamble length for SF5 and SF6


SECS_TO_MUS#

#define SECS_TO_MUS
Value:
(X)

timeout duration in usec.

the conversion to semtech ticks is done by start_rx() start_tx()


SID_PAL_RADIO_LORA_CAD_DEFAULT_TX_TIMEOUT#

#define SID_PAL_RADIO_LORA_CAD_DEFAULT_TX_TIMEOUT
Value:
SECS_TO_MUS(5)

set max radio timeout to 5sec


SID_PAL_RADIO_LORA_DEFAULT_TX_TIMEOUT#

#define SID_PAL_RADIO_LORA_DEFAULT_TX_TIMEOUT
Value:
SID_PAL_RADIO_LORA_CAD_DEFAULT_TX_TIMEOUT

Default transmission timeout


SID_PAL_RADIO_LORA_TIMEOUT_DURATION_1_SEC#

#define SID_PAL_RADIO_LORA_TIMEOUT_DURATION_1_SEC
Value:
SECS_TO_MUS(1)

1 sec timeout used by diagnostics code


SID_PAL_RADIO_LORA_PRIVATE_NETWORK_SYNC_WORD#

#define SID_PAL_RADIO_LORA_PRIVATE_NETWORK_SYNC_WORD
Value:
0x1424

Private network sync word


SID_PAL_RADIO_LORA_PUBLIC_NETWORK_SYNC_WORD#

#define SID_PAL_RADIO_LORA_PUBLIC_NETWORK_SYNC_WORD
Value:
LORA_MAC_PUBLIC_SYNCWORD

Public network sync word


SID_PAL_RADIO_LORA_MAX_PAYLOAD_LENGTH#

#define SID_PAL_RADIO_LORA_MAX_PAYLOAD_LENGTH
Value:
250

Maximum payload length


SID_PAL_RADIO_LORA_ED_PREAMBLE_LENGTH_DEFAULT#

#define SID_PAL_RADIO_LORA_ED_PREAMBLE_LENGTH_DEFAULT
Value:
(250 << 3)

Default preamble length


SID_PAL_RADIO_LORA_ED_MOD_SHAPING#

#define SID_PAL_RADIO_LORA_ED_MOD_SHAPING
Value:
MOD_SHAPING_G_BT_1

Default modulation shaping


SID_PAL_RADIO_LORA_ED_PREAMBLE_MIN_DETECT#

#define SID_PAL_RADIO_LORA_ED_PREAMBLE_MIN_DETECT
Value:
RADIO_PREAMBLE_DETECTOR_08_BITS

Default preamble detection


SID_PAL_RADIO_LORA_ED_SYNCWORD_LENGTH_DEFAULT#

#define SID_PAL_RADIO_LORA_ED_SYNCWORD_LENGTH_DEFAULT
Value:
(3 << 3)

Default sync word length


SID_PAL_RADIO_LORA_ED_ADDRCOMP_DEFAULT#

#define SID_PAL_RADIO_LORA_ED_ADDRCOMP_DEFAULT
Value:
RADIO_ADDRESSCOMP_FILT_OFF

Default address comparison


SID_PAL_RADIO_LORA_ED_HEADER_TYPE_DEFAULT#

#define SID_PAL_RADIO_LORA_ED_HEADER_TYPE_DEFAULT
Value:
RADIO_PACKET_VARIABLE_LENGTH

Default header type


SID_PAL_RADIO_LORA_ED_CRC_LENGTH_DEFAULT#

#define SID_PAL_RADIO_LORA_ED_CRC_LENGTH_DEFAULT
Value:
RADIO_CRC_2_BYTES_CCIT

Default CRC length


SID_PAL_RADIO_LORA_ED_RADIO_WHITENING_MODE_DEFAULT#

#define SID_PAL_RADIO_LORA_ED_RADIO_WHITENING_MODE_DEFAULT
Value:
RADIO_DC_FREEWHITENING

Default whitening mode


SID_PAL_RADIO_LORA_ED_PAYLOAD_LENGTH_DEFAULT#

#define SID_PAL_RADIO_LORA_ED_PAYLOAD_LENGTH_DEFAULT
Value:
0

Default payload length


SID_PAL_RADIO_LORA_ED_DEFAULT_WHITENING_SEED#

#define SID_PAL_RADIO_LORA_ED_DEFAULT_WHITENING_SEED
Value:
0x01FF

Default whitening seed