The Modified Dot Library for SX1272
Embed:
(wiki syntax)
Show/hide line numbers
ChannelPlan_EU868.h
00001 /** __ ___ ____ _ ______ __ ____ __ ____ 00002 * / |/ /_ __/ / /_(_)__/_ __/__ ____/ / / __/_ _____ / /____ __ _ ___ / _/__ ____ 00003 * / /|_/ / // / / __/ /___// / / -_) __/ _ \ _\ \/ // (_-</ __/ -_) ' \(_-< _/ // _ \/ __/ __ 00004 * /_/ /_/\_,_/_/\__/_/ /_/ \__/\__/_//_/ /___/\_, /___/\__/\__/_/_/_/___/ /___/_//_/\__/ /_/ 00005 * Copyright (C) 2015 by Multi-Tech Systems /___/ 00006 * 00007 * 00008 * @author Jason Reiss 00009 * @date 10-31-2015 00010 * @brief lora::ChannelPlan provides an interface for LoRaWAN channel schemes 00011 * 00012 * @details 00013 * 00014 */ 00015 00016 #ifndef __CHANNEL_PLAN_EU868_H__ 00017 #define __CHANNEL_PLAN_EU868_H__ 00018 00019 #include "Lora.h" 00020 #include "SxRadio.h" 00021 #include <vector> 00022 #include "ChannelPlan.h" 00023 00024 namespace lora { 00025 00026 const uint8_t EU868_125K_NUM_CHANS = 16; //!< Number of 125k channels in EU868 channel plan 00027 const uint8_t EU868_DEFAULT_NUM_CHANS = 3; //!< Number of defualt channels in EU868 channel plan 00028 const uint32_t EU868_125K_FREQ_BASE = 868100000; //!< Frequency base for 125k EU868 uplink channels 00029 const uint32_t EU868_125K_FREQ_STEP = 200000; //!< Frequency step for 125k EU868 uplink channels 00030 const uint32_t EU868_RX2_FREQ = 869525000; //!< Frequency default for second rx window in EU868 00031 00032 const uint8_t EU868_TX_POWER_MAX = 14; //!< Max power for EU868 channel plan 00033 00034 // 0.1% duty cycle 863-868 00035 // Limiting to 865-868 allows for 1% duty cycle 00036 const uint32_t EU868_MILLI_FREQ_MIN = 865000000; 00037 const uint32_t EU868_MILLI_FREQ_MAX = 868000000; 00038 00039 const uint32_t EU868_MILLI_1_FREQ_MIN = 868700000; 00040 const uint32_t EU868_MILLI_1_FREQ_MAX = 869200000; 00041 00042 // 1% duty cycle 00043 const uint32_t EU868_CENTI_FREQ_MIN = 868000000; 00044 const uint32_t EU868_CENTI_FREQ_MAX = 868600000; 00045 00046 // 10% duty cycle 00047 const uint32_t EU868_DECI_FREQ_MIN = 869400000; 00048 const uint32_t EU868_DECI_FREQ_MAX = 869650000; 00049 00050 // Below 7dBm there is no duty cycle for these frequencies 00051 // Up to 14dBm there is 1% duty cycle 00052 const uint32_t EU868_VAR_FREQ_MIN = 869700000; 00053 const uint32_t EU868_VAR_FREQ_MAX = 870000000; 00054 00055 const uint32_t EU868_FREQ_MIN = 863000000; 00056 const uint32_t EU868_FREQ_MAX = 870000000; 00057 00058 const uint8_t EU868_MIN_DATARATE = (uint8_t) DR_0; //!< Minimum transmit datarate for EU868 00059 const uint8_t EU868_MAX_DATARATE = (uint8_t) DR_7; //!< Maximum transmit datarate for EU868 00060 00061 const uint8_t EU868_MIN_DATARATE_OFFSET = (uint8_t) 0; //!< Minimum transmit datarate for US915 00062 const uint8_t EU868_MAX_DATARATE_OFFSET = (uint8_t) 5; //!< Maximum transmit datarate for US915 00063 00064 const uint8_t EU868_BEACON_DR = DR_3; //!< Default beacon datarate 00065 const uint32_t EU868_BEACON_FREQ = 869525000U; //!< Default beacon broadcast frequency 00066 00067 class ChannelPlan_EU868 : public lora::ChannelPlan { 00068 public: 00069 /** 00070 * ChannelPlan constructor 00071 * @param radio SxRadio object used to set Tx/Rx config 00072 * @param settings Settings object 00073 */ 00074 ChannelPlan_EU868(); 00075 ChannelPlan_EU868(Settings* settings); 00076 ChannelPlan_EU868(SxRadio* radio, Settings* settings); 00077 00078 /** 00079 * ChannelPlan destructor 00080 */ 00081 virtual ~ChannelPlan_EU868(); 00082 00083 /** 00084 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings 00085 */ 00086 virtual void Init(); 00087 00088 /** 00089 * Get the next channel to use to transmit 00090 * @return LORA_OK if channel was found 00091 * @return LORA_NO_CHANS_ENABLED 00092 */ 00093 virtual uint8_t GetNextChannel(); 00094 00095 /** 00096 * Add a channel to the ChannelPlan 00097 * @param index of channel, use -1 to add to end 00098 * @param channel settings to add 00099 */ 00100 virtual uint8_t AddChannel(int8_t index, Channel channel); 00101 00102 /** 00103 * Get channel at index 00104 * @return Channel 00105 */ 00106 virtual Channel GetChannel(int8_t index); 00107 00108 /** 00109 * Get rx window settings for requested window 00110 * RX_1, RX_2, RX_BEACON, RX_SLOT 00111 * @param window 00112 * @return RxWindow 00113 */ 00114 virtual RxWindow GetRxWindow(uint8_t window); 00115 00116 /** 00117 * Get datarate to use on the join request 00118 * @return datarate index 00119 */ 00120 virtual uint8_t GetJoinDatarate(); 00121 00122 /** 00123 * Calculate the next time a join request is possible 00124 * @param size of join frame 00125 * @returns LORA_OK 00126 */ 00127 virtual uint8_t CalculateJoinBackoff(uint8_t size); 00128 00129 /** 00130 * Get next channel and set the SxRadio tx config with current settings 00131 * @return LORA_OK 00132 */ 00133 virtual uint8_t SetTxConfig(); 00134 00135 /** 00136 * Set the SxRadio rx config provided window 00137 * @param window to be opened 00138 * @param continuous keep window open 00139 * @param wnd_growth factor to increase the rx window by 00140 * @param pad_ms time in milliseconds to add to computed window size 00141 * @return LORA_OK 00142 */ 00143 virtual uint8_t SetRxConfig(uint8_t window, 00144 bool continuous, 00145 uint16_t wnd_growth, 00146 uint16_t pad_ms); 00147 00148 /** 00149 * Set frequency sub band if supported by plan 00150 * @param sub_band 00151 * @return LORA_OK 00152 */ 00153 virtual uint8_t SetFrequencySubBand(uint8_t sub_band); 00154 00155 /** 00156 * Callback for ACK timeout event 00157 * @return LORA_OK 00158 */ 00159 virtual uint8_t HandleAckTimeout(); 00160 00161 /** 00162 * Callback for Join Accept packet to load optional channels 00163 * @return LORA_OK 00164 */ 00165 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size); 00166 00167 /** 00168 * Callback to for rx parameter setup ServerCommand 00169 * @param payload packet data 00170 * @param index of start of command buffer 00171 * @param size number of bytes in command buffer 00172 * @param[out] status to be returned in MoteCommand answer 00173 * @return LORA_OK 00174 */ 00175 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status); 00176 00177 /** 00178 * Callback to for new channel ServerCommand 00179 * @param payload packet data 00180 * @param index of start of command buffer 00181 * @param size number of bytes in command buffer 00182 * @param[out] status to be returned in MoteCommand answer 00183 * @return LORA_OK 00184 */ 00185 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status); 00186 00187 /** 00188 * Callback to for ping slot channel request ServerCommand 00189 * @param payload packet data 00190 * @param index of start of command buffer 00191 * @param size number of bytes in command buffer 00192 * @param[out] status to be returned in MoteCommand answer 00193 * @return LORA_OK 00194 */ 00195 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status); 00196 00197 /** 00198 * Callback to for beacon frequency request ServerCommand 00199 * @param payload packet data 00200 * @param index of start of command buffer 00201 * @param size number of bytes in command buffer 00202 * @param[out] status to be returned in MoteCommand answer 00203 * @return LORA_OK 00204 */ 00205 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status); 00206 00207 /** 00208 * Callback to for adaptive datarate ServerCommand 00209 * @param payload packet data 00210 * @param index of start of command buffer 00211 * @param size number of bytes in command buffer 00212 * @param[out] status to be returned in MoteCommand answer 00213 * @return LORA_OK 00214 */ 00215 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status); 00216 00217 /** 00218 * Validate the configuration after multiple ADR commands have been applied 00219 * @return status to be returned in MoteCommand answer 00220 */ 00221 virtual uint8_t ValidateAdrConfiguration(); 00222 00223 /** 00224 * Update duty cycle with at given frequency and time on air 00225 * @param freq frequency 00226 * @param time_on_air_ms tx time on air 00227 */ 00228 virtual void UpdateDutyCycle(uint32_t freq, uint32_t time_on_air_ms); 00229 00230 /** 00231 * Get the time the radio must be off air to comply with regulations 00232 * Time to wait may be dependent on duty-cycle restrictions per channel 00233 * Or duty-cycle of join requests if OTAA is being attempted 00234 * @return ms of time to wait for next tx opportunity 00235 */ 00236 virtual uint32_t GetTimeOffAir(); 00237 00238 /** 00239 * Get the channels in use by current channel plan 00240 * @return channel frequencies 00241 */ 00242 virtual std::vector<uint32_t> GetChannels(); 00243 00244 /** 00245 * Get the channel datarate ranges in use by current channel plan 00246 * @return channel datarate ranges 00247 */ 00248 virtual std::vector<uint8_t> GetChannelRanges(); 00249 00250 /** 00251 * Print log message for given rx window 00252 * @param wnd 1 or 2 00253 */ 00254 virtual void LogRxWindow(uint8_t wnd); 00255 00256 /** 00257 * Enable the default channels of the channel plan 00258 */ 00259 virtual void EnableDefaultChannels(); 00260 00261 /** 00262 * Check if this packet is a beacon and if so extract parameters needed 00263 * @param payload of potential beacon 00264 * @param size of the packet 00265 * @param [out] data extracted from the beacon if this packet was indeed a beacon 00266 * @return true if this packet is beacon, false if not 00267 */ 00268 virtual bool DecodeBeacon(const uint8_t* payload, 00269 size_t size, 00270 BeaconData_t& data); 00271 00272 protected: 00273 00274 static const uint8_t EU868_TX_POWERS[8]; //!< List of available tx powers 00275 static const uint8_t EU868_RADIO_POWERS[21]; //!< List of calibrated tx powers 00276 static const uint8_t EU868_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate 00277 static const uint8_t EU868_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate 00278 00279 typedef struct __attribute__((packed)) { 00280 uint8_t RFU[2]; 00281 uint8_t Time[4]; 00282 uint8_t CRC1[2]; 00283 uint8_t GwSpecific[7]; 00284 uint8_t CRC2[2]; 00285 } BCNPayload; 00286 }; 00287 } 00288 00289 #endif //__CHANNEL_PLAN_EU868_H__
Generated on Wed Jul 13 2022 16:42:53 by 1.7.2