Accept or rejects RxParamSetupReq MAC command.

The function processes a RX parameter setup request in response to server MAC command for RX setup.

Parameters

[in]

params

A pointer to rx parameter setup request.

Returns

The status of the operation, according to the LoRaWAN specification.

accept_tx_param_setup_req Makes decision whether to accept or reject TxParamSetupReq MAC command.

Parameters

ul_dwell_time	The uplink dwell time.
dl_dwell_time	The downlink dwell time.

Returns

True to let the MAC know that the request is accepted and MAC can apply TX parameters received form Network Server. Otherwise false is returned.

Adds a channel to the channel list.

Verifies the channel parameters and if everything is found legitimate, adds that particular channel to the channel list and updates the channel mask.

Parameters

[in]	new_channel	A pointer to the parameters for the new channel.
[in]	id	Channel ID

Returns

LORAWAN_STATUS_OK if everything goes fine, negative error code otherwise.

Processes the incoming CF-list.

Handles the payload containing CF-list and enables channels defined therein.

Parameters

payload	Payload to process.
size	Size of the payload.

Computes new data rate according to the given offset.

Parameters

[in]	dr	The current datarate.
[in]	dr_offset	The offset to be applied.

Returns

The computed datarate.

calculate_backoff Calculates and applies duty cycle back-off time.

Explicitly updates the band time-off.

Parameters

joined	Set to true, if the node has already joined a network, otherwise false.
last_tx_was_join_req	Set to true, if the last uplink was a join request.
dc_enabled	Set to true, if the duty cycle is enabled, otherwise false.
channel	The current channel index.
elapsed_time	Elapsed time since the start of the node.
tx_toa	Time-on-air of the last transmission.

Computing Receive Windows.

The algorithm tries to calculate the length of receive windows (i.e., the minimum time it should remain to acquire a lock on the Preamble for synchronization) and the error offset which compensates for the system timing errors. Basic idea behind the algorithm is to optimize for the reception of last 'min_rx_symbols' symbols out of transmitted Premable symbols. The algorithm compensates for the clock drifts, tick granularity and system wake up time (from sleep state) by opening the window early for the lower SFs. For higher SFs, the symbol time is large enough that we can afford to open late (hence the positive offset). The table below shows the calculated values for SF7 to SF12 with 125 kHz bandwidth.

+-—+–—+----——+---——+-------------------——+----------------——+-------------------——+ | SF | BW (kHz) | rx_error (ms) | wake_up (ms) | min_rx_symbols | window_timeout(symb) | window_offset(ms) | +-—+–—+----——+---——+-------------------——+----------------——+-------------------——+ | 7 | 125 | 5 | 5 | 5 | 18 | -7 | | 8 | 125 | 5 | 5 | 5 | 10 | -4 | | 9 | 125 | 5 | 5 | 5 | 6 | 2 | | 10 | 125 | 5 | 5 | 5 | 6 | 14 | | 11 | 125 | 5 | 5 | 5 | 6 | 39 | | 12 | 125 | 5 | 5 | 5 | 6 | 88 | +-—+–—+----——+---——+-------------------——+----------------——+-------------------——+

For example for SF7, the receive window will open at downlink start time plus the offset calculated and will remain open for the length window_timeout.

        Symbol time = 1.024 ms
        Downlink start: T = Tx + 1s (+/- 20 us)
                          |
                          |
                          |
                          |
                          |
                          +---+---+---+---+---+---+---+---+
                          |       8 Preamble Symbols      |
                          +---+---+---+---+---+---+---+---+

| RX Window start time = T +/- Offset +—+—+—+—+—+—+—+—+—+—+—+—+—+—+—+—+—+—+ | | | | | | | | | | | | | | | | | | | +—+—+—+—+—+—+—+—+—+—+—+—+—+—+—+—+—+—+

Similarly for SF12:

        Symbol time = 32.768 ms
        Downlink start: T = Tx + 1s (+/- 20 us)
           |
           |
           |
           |
           |
           +---+---+---+---+---+---+---+---+
           |       8 Preamble Symbols      |
           +---+---+---+---+---+---+---+---+
                      | RX Window start time = T +/- Offset
                      +---+---+---+---+---+---+
                      |   |   |   |   |   |   |
                      +---+---+---+---+---+---+

Computes the RX window timeout and offset.

Parameters

[in]	datarate	The RX window datarate index to be used.
[in]	min_rx_symbols	The minimum number of symbols required to detect an RX frame.
[in]	rx_error	The maximum timing error of the receiver in milliseconds. The receiver will turn on in a [-rxError : +rxError] ms interval around RxOffset.
[out]	rx_conf_params	Pointer to the structure that needs to be filled with receive window parameters.

Computes the txPower, based on the max EIRP and the antenna gain.

Copy channel masks.

Counts number of bits on in a given mask.

Disables a channel in a given channels mask.

Processes a DlChannelReq MAC command.

Parameters

channel_id	The channel ID to add the frequency.
rx1_frequency	The alternative frequency for the Rx1 window.

Returns

The status of the operation, according to the LoRaWAN specification.

get_ack_timeout Gets timeout value for ACK to be received

Returns

ACK timeout

Alternates the datarate of the channel for the join request.

Parameters

nb_trials

Number of trials to be made on one given data rate.

Returns

The datarate to apply .

Get channel bandwidth depending upon data rate table index.

get_channel_mask Gets the channel mask

Parameters

get_default

If true the default mask is returned, otherwise the current mask is returned

Returns

A channel mask

get_default_max_tx_datarate Gets the maximum achievable data rate for LoRa modulation.

This will always be the highest data rate achievable with LoRa as defined in the regional specifications.

Returns

Maximum achievable data rate with LoRa modulation.

get_default_rx2_datarate Gets default RX2 datarate

Returns

RX2 datarate

get_default_rx2_frequency Gets default RX2 frequency

Returns

RX2 frequency

get_default_tx_datarate Gets the default TX datarate

Returns

default TX datarate

get_default_tx_power Gets the default TX power

Returns

Default TX power

get_max_nb_channels Gets maximum number of channels supported

Returns

Number of channels

get_max_payload Gets maximum amount in bytes which device can send

Parameters

datarate	A datarate to use
use_repeater	If true repeater table is used, otherwise payloads table is used

Returns

Maximum number of bytes for payload

get_maximum_frame_counter_gap Gets maximum frame counter gap

Returns

Maximum frame counter gap

get_minimum_rx_datarate Gets the minimum RX datarate supported by a device

Returns

Minimum RX datarate

get_minimum_tx_datarate Gets the minimum TX datarate supported by a device

Returns

Minimum TX datarate

Calculates the next datarate to set, when ADR is on or off.

Parameters

restore_channel_mask	A boolean set restore channel mask in case of failure.
dr_out	The calculated datarate for the next TX.
tx_power_out	The TX power for the next TX.
adr_ack_counter	The calculated ADR acknowledgement counter.

Returns

True, if an ADR request should be performed.

Get next lower data rate.

get_next_lower_tx_datarate Gets the next lower datarate

Parameters

datarate

Current TX datarate

Returns

Lower datarate than given one or minimum if lower cannot be found anymore

get_phy_channels Gets PHY channels

Returns

PHY channels

Provides a random number from radio.

Returns a 32-bit random unsigned integer value based upon RSSI measurements.

Returns

a 32-bit long random number

Provides a random number in the range provided.

get_rx_time_on_air(...) calculates the time the received spent on air

Returns

time spent on air in milliseconds

Computes the RX window timeout and the RX window offset.

Puts radio in receive mode.

Requests the radio driver to enter receive mode.

Delegates MAC layer request to transmit packet.

Parameters

buf	a pointer to the data which needs to be transmitted
size	size of the data in bytes

Initialize LoRaPHY.

LoRaMac calls this to initialize LoRaPHY.

Parameters

lora_time

a pointer to LoRaWANTimeHandler object

is_custom_channel_plan_supported Checks if custom channel plan is supported

Returns

True if custom channel plan is supported, false otherwise

Processes a Link ADR Request.

Parameters

[in]	params	A pointer ADR request parameters.
[out]	dr_out	The datarate applied.
[out]	tx_power_out	The TX power applied.
[out]	nb_rep_out	The number of repetitions to apply.
[out]	nb_bytes_parsed	The number of bytes parsed.

Returns

The status of the operation, according to the LoRaMAC specification.

Looks up corresponding band for a frequency.

Returns -1 if not in any band.

Tests if a channel is on or off in the channel mask.

Tests if a channel is on or off in the channel mask.

Tests if a channel is on or off in the channel mask.

Counts the number of active channels in a given channels mask.

Parses the parameter of an LinkAdrRequest.

Puts radio in sleep mode.

Requests the radio driver to enter sleep mode.

Puts radio in standby mode.

Requests the radio driver to enter standby mode.

Removes a channel from the channel list.

Parameters

[in]

channel_id

Index of the channel to be removed

Returns

True, if the channel was removed successfully.

Entertain a new channel request MAC command.

MAC command subsystem processes the new channel request coming form the network server and then MAC layer asks the PHY layer to entertain the request.

Parameters

channel_id	The channel ID.
new_channel	A pointer to the new channel's parameters.

Returns

bit mask, according to the LoRaWAN spec 1.0.2.

reset_to_default_values resets some parameters to default values

Parameters

params	Pointer to MAC protocol parameters which will be reset
init	If true, most of the values will be modified

Enables default channels only.

Falls back to a channel mask where only default channels are enabled, all other channels are disabled.

Configure radio reception.

Parameters

[in]

config

A pointer to the RX configuration.

Returns

True, if the configuration was applied successfully.

Process PHY layer state after a successful transmission.

set_last_tx_done Updates times of the last transmission for the particular channel and band upon which last transmission took place.

Parameters

channel	The channel in use.
joined	Boolean telling if node has joined the network.
last_tx_done_time	The last TX done time.

Searches and sets the next available channel.

If there are multiple channels found available, one of them is selected randomly.

Parameters

[in]	nextChanParams	Parameters for the next channel.
[out]	channel	The next channel to use for TX.
[out]	time	The time to wait for the next transmission according to the duty cycle.
[out]	aggregatedTimeOff	Updates the aggregated time off.

Returns

Function status [1: OK, 0: Unable to find a channel on the current datarate].

Stores a reference to Radio object.

Application is responsible for constructing a 'LoRaRadio' object which is passed down to the PHY layer.

Parameters

radio

a reference to radio driver object

Puts the radio into continuous wave mode.

Parameters

[in]	continuous_wave	A pointer to the function parameters.
[in]	frequency	Frequency to transmit at

Enables/Disables public network mode.

Public and private LoRaWAN network constitute different preambles and Net IDs. This API isused to tell the radio which network mode is in use.

Parameters

set	true or false

Configure radio transmission.

Parameters

[in]	tx_config	Structure containing tx parameters.
[out]	tx_power	The TX power which will be set.
[out]	tx_toa	The time-on-air of the frame.

Returns

True, if the configuration was applied successfully.

Updates the time-offs of the bands.

Verifies, if a value is in a given range.

Verifies, if a datarate is available on an active channel.

verify_duty_cycle Verifies that given cycle is valid

Parameters

cycle

Cycle to check

Returns

True if valid, false otherwise

Verifies, if a frequency is within a given band.

Verifies and updates the datarate, the TX power and the number of repetitions of a LinkAdrRequest.

verify_nb_join_trials Verifies that given number of trials is valid

Parameters

nb_join_trials

Number to check

Returns

True if valid, false otherwise

verify_rx_datarate Verifies that given RX datarate is valid

Parameters

datarate

Datarate to check

Returns

true if given datarate is valid, false otherwise

verify_tx_datarate Verifies that given TX datarate is valid

Parameters

datarate	Datarate to check
use_default	If true validation is done against default value

Returns

true if given datarate is valid, false otherwise

verify_tx_power Verifies that given TX power is valid

Parameters

tx_power

Power to check

Returns

True if valid, false otherwise