SX126x-Arduino/src/mac/region/RegionAS923.h at master · beegee-tokyo/SX126x-Arduino

597 lines (526 loc) · 16.4 KB
 * \file      RegionAS923.h
 * \brief     Region definition for AS923
 * \copyright Revised BSD License, see file LICENSE.
 *              ( (____  _____ ____ _| |_ _____  ____| |__
 *               \____ \| ___ |    (_   _) ___ |/ ___)  _ \
 *               _____) ) ____| | | || |_| ____( (___| | | |
 *              (______/|_____)_|_|_| \__)_____)\____)_| |_|
 *              (C)2013 Semtech
 *               ___ _____ _   ___ _  _____ ___  ___  ___ ___
 *              / __|_   _/_\ / __| |/ / __/ _ \| _ \/ __| __|
 *              \__ \ | |/ _ \ (__| ' <| _| (_) |   / (__| _|
 *              |___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
 *              embedded.connectivity.solutions===============
 * \endcode
 * \author    Miguel Luis ( Semtech )
 * \author    Gregory Cristian ( Semtech )
 * \author    Daniel Jaeckle ( STACKFORCE )
 * \defgroup  REGIONAS923 Region AS923
 *            Implementation according to LoRaWAN Specification v1.0.2.
#ifndef __REGION_AS923_H__
#define __REGION_AS923_H__
 * LoRaMac maximum number of channels
#define AS923_MAX_NB_CHANNELS 16
 * Number of default channels
#define AS923_NUMB_DEFAULT_CHANNELS 8
 * Number of channels to apply for the CF list
/// \todo should be 6
#define AS923_NUMB_CHANNELS_CF_LIST 5
 * Minimal datarate that can be used by the node
#define AS923_TX_MIN_DATARATE DR_0
 * Maximal datarate that can be used by the node
#define AS923_TX_MAX_DATARATE DR_7
 * Minimal datarate that can be used by the node
#define AS923_RX_MIN_DATARATE DR_0
 * Maximal datarate that can be used by the node
#define AS923_RX_MAX_DATARATE DR_7
 * Default datarate used by the node
#define AS923_DEFAULT_DATARATE DR_2
 * The minimum datarate which is used when the
 * dwell time is limited.
#define AS923_DWELL_LIMIT_DATARATE DR_2
 * Minimal Rx1 receive datarate offset
#define AS923_MIN_RX1_DR_OFFSET 0
 * Maximal Rx1 receive datarate offset
#define AS923_MAX_RX1_DR_OFFSET 7
 * Default Rx1 receive datarate offset
#define AS923_DEFAULT_RX1_DR_OFFSET 0
 * Minimal Tx output power that can be used by the node
#define AS923_MIN_TX_POWER TX_POWER_7
 * Maximal Tx output power that can be used by the node
#define AS923_MAX_TX_POWER TX_POWER_0
 * Default Tx output power used by the node
#define AS923_DEFAULT_TX_POWER TX_POWER_0
 * Default uplink dwell time configuration
#define AS923_DEFAULT_UPLINK_DWELL_TIME 1
 * Default downlink dwell time configuration
#define AS923_DEFAULT_DOWNLINK_DWELL_TIME 1
 * Default Max EIRP
#define AS923_DEFAULT_MAX_EIRP 16.0f
 * Default antenna gain
#define AS923_DEFAULT_ANTENNA_GAIN 2.15f
 * ADR Ack limit
#define AS923_ADR_ACK_LIMIT 64
 * ADR Ack delay
#define AS923_ADR_ACK_DELAY 32
 * Enabled or disabled the duty cycle
#define AS923_DUTY_CYCLE_ENABLED 0
 * Maximum RX window duration
#define AS923_MAX_RX_WINDOW 3000
 * Receive delay 1
#define AS923_RECEIVE_DELAY1 1000
 * Receive delay 2
#define AS923_RECEIVE_DELAY2 2000
 * Join accept delay 1
#define AS923_JOIN_ACCEPT_DELAY1 5000
 * Join accept delay 2
#define AS923_JOIN_ACCEPT_DELAY2 6000
 * Maximum frame counter gap
#define AS923_MAX_FCNT_GAP 16384
 * Ack timeout
#define AS923_ACKTIMEOUT 2000
 * Random ack timeout limits
#define AS923_ACK_TIMEOUT_RND 1000
#if (AS923_DEFAULT_DATARATE > DR_5)
#error "A default DR higher than DR_5 may lead to connectivity loss."
 * Second reception window channel datarate definition.
#define AS923_RX_WND_2_DR DR_2
 * Maximum number of bands
#define AS923_MAX_NB_BANDS 1
 * Band 0 definition
 * { DutyCycle, TxMaxPower, LastTxDoneTime, TimeOff }
#define AS923_BAND0                      \
		100, AS923_MAX_TX_POWER, 0, 0, 0 \
	} //  1.0 %
#if AS923_DEFAULT_UPLINK_DWELL_TIME
 * LoRaMac default channel 1
 * Channel = { Frequency [Hz], RX1 Frequency [Hz], { ( ( DrMax << 4 ) | DrMin ) }, Band }
#define AS923_LC1                               \
		923200000, 0, {((DR_5 << 4) | DR_2)}, 0 \
 * LoRaMac default channel 2
 * Channel = { Frequency [Hz], RX1 Frequency [Hz], { ( ( DrMax << 4 ) | DrMin ) }, Band }
#define AS923_LC2                               \
		923400000, 0, {((DR_5 << 4) | DR_2)}, 0 \
#define AS923_LC3                               \
		923600000, 0, {((DR_5 << 4) | DR_2)}, 0 \
#define AS923_LC4                               \
		923800000, 0, {((DR_5 << 4) | DR_2)}, 0 \
#define AS923_LC5                               \
		924000000, 0, {((DR_5 << 4) | DR_2)}, 0 \
#define AS923_LC6                               \
		924200000, 0, {((DR_5 << 4) | DR_2)}, 0 \
#define AS923_LC7                               \
		924400000, 0, {((DR_5 << 4) | DR_2)}, 0 \
#define AS923_LC8                               \
		924600000, 0, {((DR_5 << 4) | DR_2)}, 0 \
	* LoRaMac default channel 1
	* Channel = { Frequency [Hz], RX1 Frequency [Hz], { ( ( DrMax << 4 ) | DrMin ) }, Band }
#define AS923_LC1                               \
		923200000, 0, {((DR_5 << 4) | DR_0)}, 0 \
	* LoRaMac default channel 2
	* Channel = { Frequency [Hz], RX1 Frequency [Hz], { ( ( DrMax << 4 ) | DrMin ) }, Band }
#define AS923_LC2                               \
		923400000, 0, {((DR_5 << 4) | DR_0)}, 0 \
#define AS923_LC3                               \
		923600000, 0, {((DR_5 << 4) | DR_0)}, 0 \
#define AS923_LC4                               \
		923800000, 0, {((DR_5 << 4) | DR_0)}, 0 \
#define AS923_LC5                               \
		924000000, 0, {((DR_5 << 4) | DR_0)}, 0 \
#define AS923_LC6                               \
		924200000, 0, {((DR_5 << 4) | DR_0)}, 0 \
#define AS923_LC7                               \
		924400000, 0, {((DR_5 << 4) | DR_0)}, 0 \
#define AS923_LC8                               \
		924600000, 0, {((DR_5 << 4) | DR_0)}, 0 \
 * LoRaMac channels which are allowed for the join procedure
#define AS923_JOIN_CHANNELS (uint16_t)(LC(1) | LC(2))
 * RSSI threshold for a free channel [dBm]
#define AS923_RSSI_FREE_TH -85
 * Specifies the time the node performs a carrier sense
#define AS923_CARRIER_SENSE_TIME 6
 * Data rates table definition
static const uint8_t DataratesAS923[] = {12, 11, 10, 9, 8, 7, 7, 50};
 * Bandwidths table definition in Hz
static const uint32_t BandwidthsAS923[] = {125000, 125000, 125000, 125000, 125000, 125000, 250000, 0};
 * Maximum payload with respect to the datarate index. Cannot operate with repeater.
 * The table is valid for the dwell time configuration of 0 for uplinks and downlinks.
// static const uint8_t MaxPayloadOfDatarateDwell0AS923[] = { 51, 51, 51, 115, 242, 242, 242, 242 };
static const uint8_t MaxPayloadOfDatarateDwell0AS923[] = {59, 59, 59, 123, 230, 230, 230, 230};
 * Maximum payload with respect to the datarate index. Can operate with repeater.
 * The table is valid for the dwell time configuration of 0 for uplinks and downlinks. The table provides
 * repeater support.
// static const uint8_t MaxPayloadOfDatarateRepeaterDwell0AS923[] = { 51, 51, 51, 115, 222, 222, 222, 222 };
static const uint8_t MaxPayloadOfDatarateRepeaterDwell0AS923[] = {59, 59, 59, 123, 250, 250, 250, 250};
 * Maximum payload with respect to the datarate index. Can operate with and without repeater.
 * The table proides repeater support. The table is only valid for uplinks.
// static const uint8_t MaxPayloadOfDatarateDwell1UpAS923[] = { 0, 0, 11, 53, 125, 242, 242, 242 };
static const uint8_t MaxPayloadOfDatarateDwell1UpAS923[] = {0, 0, 19, 61, 133, 250, 250, 250};
 * Maximum payload with respect to the datarate index. Can operate with and without repeater.
 * The table proides repeater support. The table is only valid for downlinks.
// static const uint8_t MaxPayloadOfDatarateDwell1DownAS923[] = { 0, 0, 11, 53, 126, 242, 242, 242 };
static const uint8_t MaxPayloadOfDatarateDwell1DownAS923[] = {0, 0, 19, 61, 133, 250, 250, 250};
 * Effective datarate offsets for receive window 1.
static const int8_t EffectiveRx1DrOffsetAS923[] = {0, 1, 2, 3, 4, 5, -1, -2};
 * \brief The function gets a value of a specific phy attribute.
 * \param  getPhy Pointer to the function parameters.
 * \retval Returns a structure containing the PHY parameter.
PhyParam_t RegionAS923GetPhyParam(GetPhyParams_t *getPhy);
 * \brief Updates the last TX done parameters of the current channel.
 * \param  txDone Pointer to the function parameters.
void RegionAS923SetBandTxDone(SetBandTxDoneParams_t *txDone);
 * \brief Initializes the channels masks and the channels.
 * \param  type Sets the initialization type.
void RegionAS923InitDefaults(InitType_t type);
 * \brief Verifies a parameter.
 * \param  verify Pointer to the function parameters.
 * \param  phyAttribute Sets the initialization type.
 * \retval Returns true, if the parameter is valid.
bool RegionAS923Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute);
 * \brief The function parses the input buffer and sets up the channels of the
 *        CF list.
 * \param  applyCFList Pointer to the function parameters.
void RegionAS923ApplyCFList(ApplyCFListParams_t *applyCFList);
 * \brief Sets a channels mask.
 * \param  chanMaskSet Pointer to the function parameters.
 * \retval Returns true, if the channels mask could be set.
bool RegionAS923ChanMaskSet(ChanMaskSetParams_t *chanMaskSet);
 * \brief Calculates the next datarate to set, when ADR is on or off.
 * \param  adrNext Pointer to the function parameters.
 * \param  drOut The calculated datarate for the next TX.
 * \param  txPowOut The TX power for the next TX.
 * \param  adrAckCounter The calculated ADR acknowledgement counter.
 * \retval Returns true, if an ADR request should be performed.
bool RegionAS923AdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter);
 * Computes the Rx window timeout and offset.
 * \param  datarate     Rx window datarate index to be used
 * \param  minRxSymbols Minimum required number of symbols to detect an Rx frame.
 * \param  rxError      System maximum timing error of the receiver. In milliseconds
 *                          The receiver will turn on in a [-rxError : +rxError] ms
 *                          interval around RxOffset
 * \param rxConfigParams Returns updated WindowTimeout and WindowOffset fields.
void RegionAS923ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams);
 * \brief Configuration of the RX windows.
 * \param  rxConfig Pointer to the function parameters.
 * \param  datarate The datarate index which was set.
 * \retval Returns true, if the configuration was applied successfully.
bool RegionAS923RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate);
 * \brief TX configuration.
 * \param  txConfig Pointer to the function parameters.
 * \param  txPower The tx power index which was set.
 * \param  txTimeOnAir The time-on-air of the frame.
 * \retval Returns true, if the configuration was applied successfully.
bool RegionAS923TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir);
 * \brief The function processes a Link ADR Request.
 * \param  linkAdrReq Pointer to the function parameters.
 * \param  drOut Data rate.
 * \param  txPowOut TX power.
 * \param  nbRepOut Number of repeats.
 * \param  nbBytesParsed Number of parsed bytes.
 * \retval Returns the status of the operation, according to the LoRaMAC specification.
uint8_t RegionAS923LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed);
 * \brief The function processes a RX Parameter Setup Request.
 * \param  rxParamSetupReq Pointer to the function parameters.
 * \retval Returns the status of the operation, according to the LoRaMAC specification.
uint8_t RegionAS923RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq);
 * \brief The function processes a Channel Request.
 * \param  newChannelReq Pointer to the function parameters.
 * \retval Returns the status of the operation, according to the LoRaMAC specification.
uint8_t RegionAS923NewChannelReq(NewChannelReqParams_t *newChannelReq);
 * \brief The function processes a TX ParamSetup Request.
 * \param  txParamSetupReq Pointer to the function parameters.
 * \retval Returns the status of the operation, according to the LoRaMAC specification.
 *         Returns -1, if the functionality is not implemented. In this case, the end node
 *         shall not process the command.
int8_t RegionAS923TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq);
 * \brief The function processes a DlChannel Request.
 * \param  dlChannelReq Pointer to the function parameters.
 * \retval Returns the status of the operation, according to the LoRaMAC specification.
uint8_t RegionAS923DlChannelReq(DlChannelReqParams_t *dlChannelReq);
 * \brief Alternates the datarate of the channel for the join request.
 * \param  alternateDr Pointer to the function parameters.
 * \retval Datarate to apply.
int8_t RegionAS923AlternateDr(AlternateDrParams_t *alternateDr);
 * \brief Calculates the back-off time.
 * \param  calcBackOff Pointer to the function parameters.
void RegionAS923CalcBackOff(CalcBackOffParams_t *calcBackOff);
 * \brief Searches and set the next random available channel
 * \param  nextChanParams Parameters of next channel to use for TX.
 * \param  channel Next channel to use for TX.
 * \param  time Time to wait for the next transmission according to the duty
 *              cycle.
 * \param  aggregatedTimeOff Updates the aggregated time off.
 * \retval Function status [1: OK, 0: Unable to find a channel on the current datarate]
bool RegionAS923NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff);
 * \brief Adds a channel.
 * \param  channelAdd Pointer to the function parameters.
 * \retval Status of the operation.
LoRaMacStatus_t RegionAS923ChannelAdd(ChannelAddParams_t *channelAdd);
 * \brief Removes a channel.
 * \param  channelRemove Pointer to the function parameters.
 * \retval Returns true, if the channel was removed successfully.
bool RegionAS923ChannelsRemove(ChannelRemoveParams_t *channelRemove);
 * \brief Sets the radio into continuous wave mode.
 * \param  continuousWave Pointer to the function parameters.
void RegionAS923SetContinuousWave(ContinuousWaveParams_t *continuousWave);
 * \brief Computes new datarate according to the given offset
 * \param  downlinkDwellTime Downlink dwell time configuration. 0: No limit, 1: 400ms
 * \param  dr Current datarate
 * \param  drOffset Offset to be applied
 * \retval newDr Computed datarate.
uint8_t RegionAS923ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset);
 * \brief Adjust frequency band to AS923-1, AS923-2, AS923-3
 * \param version 1 => use default frequencies (AS923-1)
 *                2 => adjust frequencies by substracting 1.8MHz (AS923-2)
 *                3 => adjust frequencies by substracting 6.6MHz (AS923-3)
 *                4 => adjust frequencies by substracting 5.9MHz (AS923-4), only lower 8 channels supported
bool RegionAS923SetVersion(uint8_t version);
#endif // __REGION_AS923_H__
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

FilesExpand file tree

RegionAS923.h

Latest commit

History

RegionAS923.h

File metadata and controls
