Thanh Nguyen / libmDot-dev-mbed5

ver1

plans/ChannelPlan_IN865.h@172:7ec44396a51b, 2018-08-30 (annotated)

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Thu Aug 30 09:05:16 2018 -0500
Revision:
172:7ec44396a51b
Parent:
167:09fd17fee0f5 
mdot-library revision 3.1.0-class-b-alpha-1-15-g0c33f0a and mbed-os revision mbed-os-5.7.7

Who changed what in which revision?

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