SafeDetect / serial_to_lora
Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Thu Aug 29 12:21:40 2019 -0500
Revision:
19:aa5b1fcd05be
Parent:
18:d7332302f5f1
xdot-library revision 3.2.1 and mbed-os revision mbed-os-5.13.4

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 1 /** __ ___ ____ _ ______ __ ____ __ ____
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 2 * / |/ /_ __/ / /_(_)__/_ __/__ ____/ / / __/_ _____ / /____ __ _ ___ / _/__ ____
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 3 * / /|_/ / // / / __/ /___// / / -_) __/ _ \ _\ \/ // (_-</ __/ -_) ' \(_-< _/ // _ \/ __/ __
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 4 * /_/ /_/\_,_/_/\__/_/ /_/ \__/\__/_//_/ /___/\_, /___/\__/\__/_/_/_/___/ /___/_//_/\__/ /_/
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 5 * Copyright (C) 2015 by Multi-Tech Systems /___/
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 6 *
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 7 *
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 8 * @author Jason Reiss
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 9 * @date 10-31-2015
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 10 * @brief lora::ChannelPlan provides an interface for LoRaWAN channel schemes
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 11 *
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 12 * @details
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 13 *
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 14 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 15
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 16 #ifndef __CHANNEL_PLAN_AU915_H__
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 17 #define __CHANNEL_PLAN_AU915_H__
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 18
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 19 #include "Lora.h"
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 20 #include "SxRadio.h"
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 21 #include "ChannelPlan.h"
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 22 #include <vector>
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 23
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 24 namespace lora {
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 25
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 26 const uint8_t AU915_125K_NUM_CHANS = 64; //!< Number of 125k channels in AU915 channel plan
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 27 const uint8_t AU915_500K_NUM_CHANS = 8; //!< Number of 500k channels in AU915 channel plan
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 28
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 29 const uint32_t AU915_125K_FREQ_BASE = 915200000; //!< Frequency base for 125k AU915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 30 const uint32_t AU915_125K_FREQ_STEP = 200000; //!< Frequency step for 125k AU915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 31
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 32 const uint32_t AU915_500K_FREQ_BASE = 915900000; //!< Frequency base for 500k AU915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 33 const uint32_t AU915_500K_FREQ_STEP = 1600000; //!< Frequency step for 500k AU915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 34
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 35 const uint32_t AU915_500K_DBASE = 923300000; //!< Frequency base for 500k AU915 downlink channels
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 36 const uint32_t AU915_500K_DSTEP = 600000; //!< Frequency step for 500k AU915 downlink channels
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 37
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 38 const uint32_t AU915_FREQ_MIN = 915000000;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 39 const uint32_t AU915_FREQ_MAX = 928000000;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 40
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 41 const uint8_t AU915_MIN_DATARATE = (uint8_t) DR_0; //!< Minimum transmit datarate for AU915
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 42 const uint8_t AU915_MAX_DATARATE = (uint8_t) DR_6; //!< Maximum transmit datarate for AU915
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 43
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 44 const uint8_t AU915_MIN_DATARATE_OFFSET = (uint8_t) 0; //!< Minimum transmit datarate for AU915
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 45 const uint8_t AU915_MAX_DATARATE_OFFSET = (uint8_t) 5; //!< Maximum transmit datarate for AU915
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 46
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 47 const uint8_t AU915_BEACON_DR = DR_8; //!< Default beacon datarate
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 48 const uint32_t AU915_BEACON_FREQ_BASE = 923300000U; //!< Base beacon broadcast frequency
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 49 const uint32_t AU915_BEACON_FREQ_STEP = 600000U; //!< Step size for beacon frequencies
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 50 const uint8_t AU915_BEACON_CHANNELS = 8U; //!< Number of beacon channels
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 51
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 52 class ChannelPlan_AU915 : public lora::ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 53 public:
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 54
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 55 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 56 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 57 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 58 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 59 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 60 ChannelPlan_AU915();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 61 ChannelPlan_AU915(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 62 ChannelPlan_AU915(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 63
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 64 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 65 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 66 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 67 virtual ~ChannelPlan_AU915();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 68
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 69 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 70 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 71 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 72 virtual void Init();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 73
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 74 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 75 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 76 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 77 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 78 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 79 virtual uint8_t GetNextChannel();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 80
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 81 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 82 * Set the number of channels in the plan
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 83 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 84 virtual void SetNumberOfChannels(uint8_t channels, bool resize = true);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 85
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 86 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 87 * Check if channel is enabled
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 88 * @return true if enabled
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 89 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 90 virtual bool IsChannelEnabled(uint8_t channel);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 91
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 92
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 93 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 94 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 95 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 96 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 97 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 98 virtual uint8_t AddChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 99
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 100 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 101 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 102 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 103 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 104 virtual Channel GetChannel(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 105
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 106 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 107 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 108 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 109 * @param window
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 110 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 111 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 112 virtual RxWindow GetRxWindow(uint8_t window);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 113
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 114 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 115 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 116 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 117 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 118 virtual uint8_t GetJoinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 119
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 120 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 121 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 122 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 123 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 124 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 125 virtual uint8_t CalculateJoinBackoff(uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 126
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 127 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 128 * Set the datarate offset used for first receive window
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 129 * @param offset
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 130 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 131 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 132 virtual uint8_t SetRx1Offset(uint8_t offset);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 133
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 134 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 135 * Set the frequency for second receive window
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 136 * @param freq
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 137 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 138 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 139 virtual uint8_t SetRx2Frequency(uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 140
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 141 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 142 * Set the datarate index used for second receive window
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 143 * @param index
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 144 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 145 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 146 virtual uint8_t SetRx2DatarateIndex(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 147
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 148 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 149 * Get next channel and set the SxRadio tx config with current settings
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 150 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 151 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 152 virtual uint8_t SetTxConfig();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 153
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 154 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 155 * Set the SxRadio rx config provided window
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 156 * @param window to be opened
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 157 * @param continuous keep window open
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 158 * @param wnd_growth factor to increase the rx window by
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 159 * @param pad_ms time in milliseconds to add to computed window size
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 160 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 161 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 162 virtual uint8_t SetRxConfig(uint8_t window,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 163 bool continuous,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 164 uint16_t wnd_growth,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 165 uint16_t pad_ms);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 166
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 167 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 168 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 169 * @param sub_band
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 170 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 171 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 172 virtual uint8_t SetFrequencySubBand(uint8_t sub_band);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 173
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 174 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 175 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 176 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 177 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 178 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 179
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 180 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 181 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 182 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 183 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 184 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 185 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 186 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 187 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 188 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 189
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 190 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 191 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 192 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 193 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 194 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 195 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 196 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 197 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 198 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 199
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 200 /**
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 201 * Callback to for downlink channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 202 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 203 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 204 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 205 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 206 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 207 */
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 208 virtual uint8_t HandleDownlinkChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 209
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 210 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 211 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 212 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 213 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 214 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 215 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 216 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 217 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 218 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 219
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 220 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 221 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 222 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 223 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 224 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 225 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 226 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 227 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 228 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 229
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 230 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 231 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 232 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 233 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 234 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 235 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 236 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 237 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 238 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 239
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 240 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 241 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 242 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 243 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 244 virtual uint8_t ValidateAdrConfiguration();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 245
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 246 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 247 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 248 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 249 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 250 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 251 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 252 virtual uint32_t GetTimeOffAir();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 253
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 254 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 255 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 256 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 257 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 258 virtual std::vector<uint32_t> GetChannels();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 259
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 260 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 261 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 262 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 263 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 264 virtual std::vector<uint8_t> GetChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 265
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 266
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 267 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 268 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 269 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 270 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 271 virtual void LogRxWindow(uint8_t wnd);
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 272
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 273 /**
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 274 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 275 */
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 276 virtual void EnableDefaultChannels();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 277
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 278 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 279 * Called when MAC layer doesn't know about a command.
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 280 * Use to add custom or new mac command handling
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 281 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 282 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 283 virtual uint8_t HandleMacCommand(uint8_t* payload, uint8_t& index);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 284
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 285 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 286 * Get max payload size for current datarate
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 287 * @return size in bytes
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 288 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 289 virtual uint8_t GetMaxPayloadSize();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 290
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 291 virtual uint8_t GetMinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 292
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 293 virtual uint8_t GetMaxDatarate();
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 294
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 295 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 296 * Check if this packet is a beacon and if so extract parameters needed
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 297 * @param payload of potential beacon
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 298 * @param size of the packet
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 299 * @param [out] data extracted from the beacon if this packet was indeed a beacon
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 300 * @return true if this packet is beacon, false if not
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 301 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 302 virtual bool DecodeBeacon(const uint8_t* payload,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 303 size_t size,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 304 BeaconData_t& data);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 305
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 306 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 307 * Update class B beacon and ping slot settings if frequency hopping enabled
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 308 * @param time received in the last beacon
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 309 * @param period of the beacon
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 310 * @param devAddr of this end device
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 311 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 312 virtual void FrequencyHop(uint32_t time, uint32_t period, uint32_t devAddr);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 313
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 314 protected:
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 315
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 316 static const uint8_t AU915_TX_POWERS[11]; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 317 static const uint8_t AU915_RADIO_POWERS[21]; //!< List of calibrated tx powers
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 318 static const uint8_t AU915_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 319 static const uint8_t AU915_MAX_PAYLOAD_SIZE_400[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 320 static const uint8_t AU915_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 321 static const uint8_t AU915_MAX_PAYLOAD_SIZE_REPEATER_400[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 322 static const uint8_t MAX_ERP_VALUES[]; //!< Lookup table for Max EIRP (dBm) codes
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 323
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 324 typedef struct __attribute__((packed)) {
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 325 uint8_t RFU1[3];
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 326 uint8_t Time[4];
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 327 uint8_t CRC1[2];
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 328 uint8_t GwSpecific[7];
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 329 uint8_t RFU2[1];
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 330 uint8_t CRC2[2];
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 331 } BCNPayload;
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 332 };
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 333 }
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 334
Jenkins@KEILDM1.dc.multitech.prv 11:be2a6466d680 335 #endif // __CHANNEL_PLAN_AU915_H__