Meach will / libmDot-mbed5

hello 2

Dependents:   ncu_project

plans/ChannelPlan_RU864.h@72:bb41d95791a4, 2020-01-06 (annotated)

Committer:
meachwill
Date:
Mon Jan 06 04:13:36 2020 +0000
Revision:
72:bb41d95791a4
Parent:
69:e22889c7eaa9 
hello

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 1 /** __ ___ ____ _ ______ __ ____ __ ____
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 2 * / |/ /_ __/ / /_(_)__/_ __/__ ____/ / / __/_ _____ / /____ __ _ ___ / _/__ ____
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 3 * / /|_/ / // / / __/ /___// / / -_) __/ _ \ _\ \/ // (_-</ __/ -_) ' \(_-< _/ // _ \/ __/ __
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 4 * /_/ /_/\_,_/_/\__/_/ /_/ \__/\__/_//_/ /___/\_, /___/\__/\__/_/_/_/___/ /___/_//_/\__/ /_/
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 5 * Copyright (C) 2015 by Multi-Tech Systems /___/
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 6 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 7 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 8 * @author Jason Reiss
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 9 * @date 10-31-2015
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 10 * @brief lora::ChannelPlan provides an interface for LoRaWAN channel schemes
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 11 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 12 * @details
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 13 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 14 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 15
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 16 #ifndef __CHANNEL_PLAN_RU864_H__
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 17 #define __CHANNEL_PLAN_RU864_H__
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 18
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 19 #include "Lora.h"
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 20 #include "SxRadio.h"
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 21 #include <vector>
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 22 #include "ChannelPlan.h"
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 23
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 24 namespace lora {
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 25
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 26 const uint8_t RU864_125K_NUM_CHANS = 16; //!< Number of 125k channels in RU864 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 27 const uint8_t RU864_DEFAULT_NUM_CHANS = 2; //!< Number of defualt channels in RU864 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 28 const uint32_t RU864_125K_FREQ_BASE = 868900000; //!< Frequency base for 125k RU864 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 29 const uint32_t RU864_125K_FREQ_STEP = 200000; //!< Frequency step for 125k RU864 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 30 const uint32_t RU864_RX2_FREQ = 869100000; //!< Frequency default for second rx window in RU864
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 31
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 32 const uint8_t RU864_TX_POWER_MAX = 16; //!< Max power for RU864 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 33
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 34 // 0.1% duty cycle 864-866
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 35 const uint32_t RU864_MILLI_FREQ_MIN = 864000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 36 const uint32_t RU864_MILLI_FREQ_MAX = 865000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 37
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 38
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 39 const uint32_t RU864_FREQ_MIN = 864000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 40 const uint32_t RU864_FREQ_MAX = 870000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 41
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 42 const uint8_t RU864_MIN_DATARATE = (uint8_t) DR_0; //!< Minimum transmit datarate for RU864
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 43 const uint8_t RU864_MAX_DATARATE = (uint8_t) DR_7; //!< Maximum transmit datarate for RU864
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 44
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 45 const uint8_t RU864_MIN_DATARATE_OFFSET = (uint8_t) 0; //!< Minimum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 46 const uint8_t RU864_MAX_DATARATE_OFFSET = (uint8_t) 5; //!< Maximum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 47
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 48 const uint8_t RU864_BEACON_DR = DR_3; //!< Default beacon datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 49 const uint32_t RU864_BEACON_FREQ = 869100000U; //!< Default beacon broadcast frequency
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 50 const uint32_t RU864_PING_SLOT_FREQ = 868900000U; //!< Default ping slot frequency
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 51
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 52 class ChannelPlan_RU864 : public lora::ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 53 public:
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 54 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 55 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 56 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 57 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 58 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 59 ChannelPlan_RU864();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 60 ChannelPlan_RU864(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 61 ChannelPlan_RU864(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 62
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 63 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 64 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 65 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 66 virtual ~ChannelPlan_RU864();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 67
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 68 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 69 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 70 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 71 virtual void Init();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 72
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 73 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 74 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 75 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 76 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 77 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 78 virtual uint8_t GetNextChannel();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 79
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 80 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 81 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 82 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 83 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 84 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 85 virtual uint8_t AddChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 86
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 87 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 88 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 89 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 90 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 91 virtual Channel GetChannel(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 92
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 93 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 94 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 95 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 96 * @param window
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 97 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 98 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 99 virtual RxWindow GetRxWindow(uint8_t window);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 100
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 101 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 102 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 103 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 104 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 105 virtual uint8_t GetJoinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 106
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 107 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 108 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 109 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 110 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 111 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 112 virtual uint8_t CalculateJoinBackoff(uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 113
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 114 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 115 * Get next channel and set the SxRadio tx config with current settings
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 116 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 117 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 118 virtual uint8_t SetTxConfig();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 119
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 120 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 121 * Set the SxRadio rx config provided window
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 122 * @param window to be opened
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 123 * @param continuous keep window open
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 124 * @param wnd_growth factor to increase the rx window by
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 125 * @param pad_ms time in milliseconds to add to computed window size
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 126 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 127 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 128 virtual uint8_t SetRxConfig(uint8_t window,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 129 bool continuous,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 130 uint16_t wnd_growth,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 131 uint16_t pad_ms);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 132
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 133 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 134 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 135 * @param sub_band
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 136 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 137 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 138 virtual uint8_t SetFrequencySubBand(uint8_t sub_band);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 139
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 140 /**
Jenkins@KEILDM1.dc.multitech.prv 69:e22889c7eaa9 141 * Callback for ACK timeout event
Jenkins@KEILDM1.dc.multitech.prv 69:e22889c7eaa9 142 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 69:e22889c7eaa9 143 */
Jenkins@KEILDM1.dc.multitech.prv 69:e22889c7eaa9 144 virtual uint8_t HandleAckTimeout();
Jenkins@KEILDM1.dc.multitech.prv 69:e22889c7eaa9 145
Jenkins@KEILDM1.dc.multitech.prv 69:e22889c7eaa9 146 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 147 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 148 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 149 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 150 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 151
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 152 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 153 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 154 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 155 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 156 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 157 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 158 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 159 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 160 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 161
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 162 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 163 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 164 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 165 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 166 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 167 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 168 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 169 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 170 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 171
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 172 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 173 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 174 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 175 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 176 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 177 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 178 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 179 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 180 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 181
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 182 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 183 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 184 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 185 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 186 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 187 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 188 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 189 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 190 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 191
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 192 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 193 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 194 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 195 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 196 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 197 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 198 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 199 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 200 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 201
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 202 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 203 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 204 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 205 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 206 virtual uint8_t ValidateAdrConfiguration();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 207
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 208 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 209 * Update duty cycle with at given frequency and time on air
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 210 * @param freq frequency
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 211 * @param time_on_air_ms tx time on air
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 212 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 213 virtual void UpdateDutyCycle(uint32_t freq, uint32_t time_on_air_ms);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 214
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 215 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 216 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 217 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 218 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 219 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 220 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 221 virtual uint32_t GetTimeOffAir();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 222
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 223 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 224 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 225 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 226 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 227 virtual std::vector<uint32_t> GetChannels();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 228
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 229 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 230 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 231 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 232 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 233 virtual std::vector<uint8_t> GetChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 234
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 235 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 236 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 237 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 238 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 239 virtual void LogRxWindow(uint8_t wnd);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 240
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 241 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 242 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 243 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 244 virtual void EnableDefaultChannels();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 245
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 246 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 247 * Check if this packet is a beacon and if so extract parameters needed
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 248 * @param payload of potential beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 249 * @param size of the packet
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 250 * @param [out] data extracted from the beacon if this packet was indeed a beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 251 * @return true if this packet is beacon, false if not
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 252 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 253 virtual bool DecodeBeacon(const uint8_t* payload,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 254 size_t size,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 255 BeaconData_t& data);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 256
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 257 protected:
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 258
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 259 static const uint8_t RU864_TX_POWERS[8]; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 260 static const uint8_t RU864_RADIO_POWERS[21]; //!< List of calibrated tx powers
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 261 static const uint8_t RU864_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 262 static const uint8_t RU864_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 263
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 264 typedef struct __attribute__((packed)) {
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 265 uint8_t RFU[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 266 uint8_t Time[4];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 267 uint8_t CRC1[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 268 uint8_t GwSpecific[7];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 269 uint8_t CRC2[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 270 } BCNPayload;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 271 };
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 272 }
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 273
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 274 #endif //__CHANNEL_PLAN_RU864_H__