Meach will / libmDot-mbed5

hello 2

Dependents:   ncu_project

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