Meach will / libmDot-mbed5

hello 2

Dependents:   ncu_project

plans/ChannelPlan_AS923.h@65:acc0468b9aec, 2019-04-18 (annotated)

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Thu Apr 18 14:55:19 2019 -0500
Revision:
65:acc0468b9aec
Parent:
64:64982192a2af
Child:
68:5f787643e7d7
mdot-library revision 3.2.0 and mbed-os revision mbed-os-5.11.1

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 * COPYRIGHT 2015 MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 3 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 4 * Redistribution and use in source and binary forms, with or without modification,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 5 * are permitted provided that the following conditions are met:
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 6 * 1. Redistributions of source code must retain the above copyright notice,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 7 * this list of conditions and the following disclaimer.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 8 * 2. Redistributions in binary form must reproduce the above copyright notice,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 9 * this list of conditions and the following disclaimer in the documentation
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 10 * and/or other materials provided with the distribution.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 11 * 3. Neither the name of MULTI-TECH SYSTEMS, INC. nor the names of its contributors
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 12 * may be used to endorse or promote products derived from this software
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 13 * without specific prior written permission.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 14 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 25 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 26 ******************************************************************************
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 27 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 28 * @author Jason Reiss
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 29 * @date 10-31-2015
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 30 * @brief lora::ChannelPlan provides an interface for LoRaWAN channel schemes
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 31 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 32 * @details
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 33 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 34 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 35
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 36 #ifndef __CHANNEL_PLAN_AS923_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 37 #define __CHANNEL_PLAN_AS923_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 38
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 39 #include "Lora.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 40 #include "SxRadio.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 41 #include <vector>
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 42 #include "ChannelPlan.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 43
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 44 namespace lora {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 45
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 46 const uint8_t AS923_125K_NUM_CHANS = 16; //!< Number of 125k channels in AS923 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 47 const uint8_t AS923_DEFAULT_NUM_CHANS = 2; //!< Number of default channels in AS923 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 48 const uint32_t AS923_125K_FREQ_BASE = 923200000; //!< Frequency base for 125k AS923 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 49 const uint32_t AS923_125K_FREQ_STEP = 200000; //!< Frequency step for 125k AS923 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 50 const uint32_t AS923_RX2_FREQ = 923200000; //!< Frequency default for second rx window in AS923
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 51 const uint8_t AS923_BEACON_DR = DR_3; //!< Default beacon datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 52 const uint32_t AS923_BEACON_FREQ = 923400000U; //!< Default beacon broadcast frequency
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 53
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 54 class ChannelPlan_AS923: public lora::ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 55 public:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 56 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 57 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 58 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 59 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 60 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 61 ChannelPlan_AS923();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 62 ChannelPlan_AS923(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 63 ChannelPlan_AS923(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 64
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 65 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 66 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 67 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 68 virtual ~ChannelPlan_AS923();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 69
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 70 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 71 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 72 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 73 virtual void Init();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 74
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 75 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 76 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 77 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 78 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 79 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 80 virtual uint8_t GetNextChannel();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 81
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 82 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 83 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 84 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 85 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 86 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 87 virtual uint8_t AddChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 88
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 89 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 90 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 91 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 92 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 93 virtual Channel GetChannel(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 94
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 95 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 96 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 97 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 98 * @param window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 99 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 100 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 101 virtual RxWindow GetRxWindow(uint8_t window);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 102
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 103 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 104 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 105 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 106 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 107 virtual uint8_t GetJoinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 108
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 109 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 110 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 111 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 112 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 113 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 114 virtual uint8_t CalculateJoinBackoff(uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 115
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 116 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 117 * Get next channel and set the SxRadio tx config with current settings
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 118 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 119 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 120 virtual uint8_t SetTxConfig();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 121
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 122 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 123 * Set the SxRadio rx config provided window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 124 * @param window to be opened
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 125 * @param continuous keep window open
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 126 * @param wnd_growth factor to increase the rx window by
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 127 * @param pad_ms time in milliseconds to add to computed window size
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 128 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 129 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 130 virtual uint8_t SetRxConfig(uint8_t window,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 131 bool continuous,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 132 uint16_t wnd_growth,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 133 uint16_t pad_ms);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 134
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 135 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 136 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 137 * @param sub_band
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 138 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 139 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 140 virtual uint8_t SetFrequencySubBand(uint8_t sub_band);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 141
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 142 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 143 * Callback for ACK timeout event
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 144 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 145 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 146 virtual uint8_t HandleAckTimeout();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 147
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 148 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 149 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 150 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 151 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 152 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 153
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 154 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 155 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 156 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 157 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 158 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 159 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 160 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 161 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 162 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 163
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 164 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 165 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 166 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 167 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 168 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 169 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 170 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 171 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 172 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 173
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 174 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 175 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 176 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 177 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 178 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 179 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 180 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 181 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 182 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 183
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 184 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 185 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 186 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 187 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 188 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 189 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 190 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 191 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 192 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 193
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 194 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 195 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 196 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 197 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 198 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 199 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 200 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 201 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 202 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 203
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 204 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 205 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 206 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 207 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 208 virtual uint8_t ValidateAdrConfiguration();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 209
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 210 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 211 * Update duty cycle with at given frequency and time on air
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 212 * @param freq frequency
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 213 * @param time_on_air_ms tx time on air
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 214 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 215 virtual void UpdateDutyCycle(uint32_t freq, uint32_t time_on_air_ms);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 216
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 217 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 218 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 219 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 220 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 221 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 222 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 223 virtual uint32_t GetTimeOffAir();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 224
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 225 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 226 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 227 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 228 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 229 virtual std::vector<uint32_t> GetChannels();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 230
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 231 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 232 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 233 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 234 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 235 virtual std::vector<uint8_t> GetChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 236
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 237 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 238 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 239 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 240 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 241 virtual void LogRxWindow(uint8_t wnd);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 242
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 243 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 244 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 245 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 246 virtual void EnableDefaultChannels();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 247
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 248 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 249 * Called when MAC layer doesn't know about a command.
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 250 * Use to add custom or new mac command handling
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 251 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 252 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 253 virtual uint8_t HandleMacCommand(uint8_t* payload, uint8_t& index);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 254
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 255 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 256 * Get max payload size for current datarate
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 257 * @return size in bytes
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 258 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 259 virtual uint8_t GetMaxPayloadSize();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 260
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 261 /**
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 262 * Decrements the datarate based on TxDwellTime
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 263 */
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 264 virtual void DecrementDatarate();
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 265
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 266 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 267 * Check if this packet is a beacon and if so extract parameters needed
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 268 * @param payload of potential beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 269 * @param size of the packet
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 270 * @param [out] data extracted from the beacon if this packet was indeed a beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 271 * @return true if this packet is beacon, false if not
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 272 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 273 virtual bool DecodeBeacon(const uint8_t* payload,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 274 size_t size,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 275 BeaconData_t& data);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 276
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 277
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 278 virtual uint8_t GetMinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 279
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 280 protected:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 281
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 282 static const uint8_t AS923_TX_POWERS[8]; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 283 static const uint8_t AS923_RADIO_POWERS[21]; //!< List of calibrated tx powers
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 284 static const uint8_t AS923_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 285 static const uint8_t AS923_MAX_PAYLOAD_SIZE_400[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 286 static const uint8_t AS923_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 287 static const uint8_t AS923_MAX_PAYLOAD_SIZE_REPEATER_400[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 288 static const uint8_t MAX_ERP_VALUES[]; //!< Lookup table for Max EIRP (dBm) codes
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 289 typedef struct __attribute__((packed)) {
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 290 uint8_t RFU[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 291 uint8_t Time[4];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 292 uint8_t CRC1[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 293 uint8_t GwSpecific[7];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 294 uint8_t CRC2[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 295 } BCNPayload;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 296 };
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 297 }
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 298
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 299 #endif //__CHANNEL_PLAN_AS923_H__