nguyen hoang / libmDot-dev-mbed5

khang_91

ChannelPlan.h@167:09fd17fee0f5, 2018-07-20 (annotated)

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Fri Jul 20 11:05:53 2018 -0500
Revision:
167:09fd17fee0f5
Parent:
153:7c00843e4bba
Child:
169:83e934fbe81a
mdot-library revision 3.1.0-rc6-2-g3cad58a 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_STRATEGY_H__
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 17 #define __CHANNEL_STRATEGY_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
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 23 namespace lora {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 24
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 25 class ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 26 public:
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 27
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 28 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 29 * Descriptions for channel plans & region information.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 30 * Bits 0-2 represent the plan type (fixed or dynamic)
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 31 * 0b000 cannot be used as plans may line up with old definitions and cause much badness
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 32 * 0b001 fixed channel plans
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 33 * 0b010 dynamic channel plans
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 34 * 0b011 - 0b111 RFU
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 35 * Bits 3-7 represent the specific channel plan/region within the plan type
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 36 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 37 enum PlanType {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 38 FIXED = 0x20,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 39 DYNAMIC = 0x40,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 40 };
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 41
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 42 enum Plan {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 43 EU868_OLD = 0x00,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 44 US915_OLD = 0x01,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 45 AU915_OLD = 0x02,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 46
Jenkins@KEILDM1.dc.multitech.prv 84:29648b580369 47 FB_EU868 = 0x00,
Jenkins@KEILDM1.dc.multitech.prv 84:29648b580369 48 FB_US915 = 0x01,
Jenkins@KEILDM1.dc.multitech.prv 84:29648b580369 49 FB_AU915 = 0x02,
Jenkins@KEILDM1.dc.multitech.prv 84:29648b580369 50
Jenkins@KEILDM1.dc.multitech.prv 84:29648b580369 51 FB_868 = 0x00,
Jenkins@KEILDM1.dc.multitech.prv 84:29648b580369 52 FB_915 = 0x01,
Jenkins@KEILDM1.dc.multitech.prv 84:29648b580369 53
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 54 US915 = FIXED | 0x00,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 55 AU915 = FIXED | 0x01,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 56
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 57 EU868 = DYNAMIC | 0x00,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 58 IN865 = DYNAMIC | 0x01,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 59 AS923 = DYNAMIC | 0x02,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 60 KR920 = DYNAMIC | 0x03,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 61 AS923_JAPAN = DYNAMIC | 0x04,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 62
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 63 NONE = 0xFF,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 64 };
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 65
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 66 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 67 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 68 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 69 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 70 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 71 ChannelPlan(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 72
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 73 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 74 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 75 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 76 virtual ~ChannelPlan();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 77
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 78 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 79 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 80 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 81 virtual void Init() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 82
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 83 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 84 * Set SxRadio object to be used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 85 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 86 virtual void SetRadio(SxRadio* radio);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 87
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 88 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 89 * Set Settings object
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 90 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 91 virtual void SetSettings(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 92
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 93 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 94 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 95 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 96 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 97 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 98 virtual uint8_t GetNextChannel() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 99
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 100 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 101 * Set the number of channels in the plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 102 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 103 virtual void SetNumberOfChannels(uint8_t channels, bool resize = true);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 104
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 105 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 106 * Get the number of channels in the plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 107 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 108 virtual uint8_t GetNumberOfChannels();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 109
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 110 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 111 * Check if channel is enabled
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 112 * @return true if enabled
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 113 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 114 virtual bool IsChannelEnabled(uint8_t channel);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 115
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 116 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 117 * Set a 16 bit channel mask with offset
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 118 * @param index of mask to set 0:0-15, 1:16-31 ...
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 119 * @param mask 16 bit mask of enabled channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 120 * @return true
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 121 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 122 virtual bool SetChannelMask(uint8_t index, uint16_t mask);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 123
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 124 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 125 * Get the channel mask of currently enabled channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 126 * @return vector containing channel bit masks
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 127 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 128 virtual std::vector<uint16_t> GetChannelMask();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 129
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 130 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 131 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 132 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 133 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 134 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 135 virtual uint8_t AddChannel(int8_t index, Channel channel) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 136
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 137 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 138 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 139 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 140 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 141 virtual Channel GetChannel(int8_t index) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 142
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 143 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 144 * Add a downlink channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 145 * Set to 0 to use the default uplink channel frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 146 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 147 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 148 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 149 virtual uint8_t AddDownlinkChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 150
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 151 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 152 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 153 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 154 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 155 virtual Channel GetDownlinkChannel(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 156
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 157 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 158 * Set number of datarates in ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 159 * @param datarates
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 160 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 161 virtual void SetNumberOfDatarates(uint8_t datarates);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 162
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 163 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 164 * Add a datarate to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 165 * @param index of datarate, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 166 * @param datarate settings to add
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 167 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 168 virtual uint8_t AddDatarate(int8_t index, Datarate datarate);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 169
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 170 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 171 * Get datarate at index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 172 * @return Datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 173 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 174 virtual Datarate GetDatarate(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 175
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 176 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 177 * Get max payload size for current datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 178 * @return size in bytes
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 179 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 180 virtual uint8_t GetMaxPayloadSize();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 181
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 182 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 183 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 184 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 185 * @param window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 186 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 187 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 188 virtual RxWindow GetRxWindow(uint8_t window) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 189
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 190 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 191 * Get current channel to use for transmitting
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 192 * @param channel index of channel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 193 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 194 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 195 virtual uint8_t SetTxChannel(uint8_t channel);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 196
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 197 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 198 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 199 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 200 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 201 virtual uint8_t GetJoinDatarate() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 202
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 203 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 204 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 205 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 206 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 207 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 208 virtual uint8_t CalculateJoinBackoff(uint8_t size) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 209
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 210 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 211 * Get the current datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 212 * @return Datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 213 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 214 virtual Datarate GetTxDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 215
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 216 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 217 * Set the current datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 218 * @param index of datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 219 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 220 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 221 virtual uint8_t SetTxDatarate(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 222
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 223 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 224 * Set the datarate offset used for first receive window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 225 * @param offset
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 226 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 227 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 228 virtual uint8_t SetRx1Offset(uint8_t offset);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 229
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 230 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 231 * Set the frequency for second receive window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 232 * @param freq
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 233 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 234 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 235 virtual uint8_t SetRx2Frequency(uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 236
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 237 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 238 * Set the datarate index used for second receive window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 239 * @param index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 240 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 241 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 242 virtual uint8_t SetRx2DatarateIndex(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 243
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 244 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 245 * Get next channel and set the SxRadio tx config with current settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 246 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 247 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 248 virtual uint8_t SetTxConfig() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 249
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 250 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 251 * Set the SxRadio rx config provided window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 252 * @param window to be opened
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 253 * @param continuous keep window open
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 254 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 255 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 256 virtual uint8_t SetRxConfig(uint8_t window, bool continuous) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 257
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 258 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 259 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 260 * @param sub_band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 261 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 262 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 263 virtual uint8_t SetFrequencySubBand(uint8_t group) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 264
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 265 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 266 * Get frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 267 * @return sub band 0-8 or 0 if not supported
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 268 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 269 virtual uint8_t GetFrequencySubBand();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 270
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 271 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 272 * Reset the ack counter used to lower datarate if ACK's are missed
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 273 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 274 virtual void ResetAckCounter();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 275
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 276 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 277 * Callback for radio to request channel change when frequency hopping
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 278 * @param currentChannel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 279 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 280 virtual void FhssChangeChannel(uint8_t currentChannel);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 281
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 282 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 283 * Callback for ACK timeout event
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 284 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 285 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 286 virtual uint8_t HandleAckTimeout();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 287
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 288 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 289 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 290 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 291 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 292 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 293
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 294 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 295 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 296 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 297 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 298 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 299 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 300 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 301 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 302 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 303
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 304 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 305 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 306 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 307 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 308 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 309 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 310 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 311 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 312 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 313
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 314 /**
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 315 * Callback to for downlink channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 316 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 317 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 318 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 319 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 320 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 321 */
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 322 virtual uint8_t HandleDownlinkChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 323
Jenkins@KEILDM1.dc.multitech.prv 139:b2e9d643eef9 324 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 325 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 326 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 327 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 328 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 329 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 330 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 331 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 332 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 333
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 334 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 335 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 336 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 337 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 338 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 339 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 340 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 341 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 342 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 343
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 344 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 345 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 346 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 347 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 348 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 349 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 350 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 351 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 352 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 353
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 354 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 355 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 356 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 357 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 358 virtual uint8_t ValidateAdrConfiguration() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 359
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 360 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 361 * Check that Rf Frequency is within channel plan range
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 362 * @param freq frequency in Hz
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 363 * @return true if valid frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 364 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 365 virtual bool CheckRfFrequency(uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 366
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 367 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 368 * Flag for ADR
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 369 * @return true if ADR is enable in settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 370 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 371 virtual bool IsAdrEnabled();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 372
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 373 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 374 * Flag if ADR ACK should be sent in next packet
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 375 * @return true when flag should be set
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 376 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 377 virtual bool AdrAckReq();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 378
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 379 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 380 * Increment the ADR counter to track when ADR ACK request should be sent
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 381 * @return current value
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 382 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 383 virtual uint8_t IncAdrCounter();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 384
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 385 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 386 * Reset the ADR counter when valid downlink is received from network server
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 387 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 388 virtual void ResetAdrCounter();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 389
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 390 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 391 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 392 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 393 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 394 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 395 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 396 virtual uint32_t GetTimeOffAir() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 397
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 398 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 399 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 400 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 401 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 402 virtual std::vector<uint32_t> GetChannels() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 403
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 404 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 405 * Get the downlink channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 406 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 407 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 408 virtual std::vector<uint32_t> GetDownlinkChannels();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 409
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 410 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 411 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 412 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 413 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 414 virtual std::vector<uint8_t> GetChannelRanges() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 415
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 416 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 417 * Set the time off air for the given duty band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 418 * @param band index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 419 * @param time off air in ms
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 420 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 421 virtual void SetDutyBandTimeOff(uint8_t band, uint32_t timeoff);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 422
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 423 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 424 * Get the time off air for the given duty band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 425 * @param band index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 426 * @return time off air in ms
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 427 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 428 virtual uint32_t GetDutyBandTimeOff(uint8_t band);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 429
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 430 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 431 * Get the number of duty bands in the current channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 432 * @return number of bands
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 433 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 434 virtual uint8_t GetNumDutyBands();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 435
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 436 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 437 * Get the duty band index for the given frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 438 * @param freq frequency in Hz
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 439 * @return index of duty band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 440 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 441 virtual int8_t GetDutyBand(uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 442
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 443 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 444 * Add duty band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 445 * @param index of duty band or -1 to append
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 446 * @param band DutyBand definition
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 447 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 448 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 449 virtual uint8_t AddDutyBand(int8_t index, DutyBand band);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 450
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 451 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 452 * Update duty cycle with current settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 453 */
Jenkins@KEILDM1.dc.multitech.prv 167:09fd17fee0f5 454 void UpdateDutyCycle(uint8_t bytes);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 455
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 456 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 457 * Update duty cycle with at given frequency and time on air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 458 * @param freq frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 459 * @param time_on_air_ms tx time on air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 460 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 461 virtual void UpdateDutyCycle(uint32_t freq, uint32_t time_on_air_ms);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 462
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 463 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 464 * Get time on air with current settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 465 * @param bytes number of bytes to be sent
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 466 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 467 virtual uint32_t GetTimeOnAir(uint8_t bytes);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 468
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 469 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 470 * Reset the duty timers with the current time off air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 471 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 472 virtual void ResetDutyCycleTimer();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 473
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 474 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 475 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 476 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 477 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 478 virtual void LogRxWindow(uint8_t wnd) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 479
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 480 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 481 * Indicator of P2P mode
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 482 * @return true if enabled
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 483 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 484 virtual bool P2PEnabled();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 485
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 486 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 487 * Ack timeout for P2P mode
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 488 * @return timeout in ms
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 489 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 490 virtual uint16_t P2PTimeout();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 491
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 492 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 493 * Ack backoff for P2P mode
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 494 * @return backoff in ms
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 495 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 496 virtual uint16_t P2PBackoff();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 497
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 498 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 499 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 500 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 501 virtual void EnableDefaultChannels() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 502
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 503 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 504 * Callback for radio thread to signal
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 505 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 506 virtual void MacEvent();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 507
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 508 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 509 * Called when MAC layer doesn't know about a command.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 510 * Use to add custom or new mac command handling
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 511 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 512 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 513 virtual uint8_t HandleMacCommand(uint8_t* payload, uint8_t& index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 514
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 515 virtual void DecrementDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 516 virtual void IncrementDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 517
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 518 virtual std::string GetPlanName();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 519 virtual uint8_t GetPlan();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 520 virtual bool IsPlanFixed();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 521 virtual bool IsPlanDynamic();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 522 static bool IsPlanFixed(uint8_t plan);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 523 static bool IsPlanDynamic(uint8_t plan);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 524 virtual uint32_t GetMinFrequency();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 525 virtual uint32_t GetMaxFrequency();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 526
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 527 virtual uint8_t GetMinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 528 virtual uint8_t GetMaxDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 529 virtual uint8_t GetMinDatarateOffset();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 530 virtual uint8_t GetMaxDatarateOffset();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 531
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 532 virtual uint8_t GetMinRx2Datarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 533 virtual uint8_t GetMaxRx2Datarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 534 virtual uint8_t GetMaxTxPower();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 535 virtual uint8_t GetMinTxPower();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 536
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 537 virtual uint16_t GetLBT_TimeUs();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 538 virtual void SetLBT_TimeUs(uint16_t us);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 539
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 540 virtual int8_t GetLBT_Threshold();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 541 virtual void SetLBT_Threshold(int8_t rssi);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 542
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 543 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 544 * Set LBT time and threshold to defaults
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 545 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 546 virtual void DefaultLBT();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 547
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 548 virtual bool ListenBeforeTalk();
Jenkins@KEILDM1.dc.multitech.prv 153:7c00843e4bba 549
Jenkins@KEILDM1.dc.multitech.prv 153:7c00843e4bba 550 /**
Jenkins@KEILDM1.dc.multitech.prv 153:7c00843e4bba 551 * use to clear downlink channels on join
Jenkins@KEILDM1.dc.multitech.prv 153:7c00843e4bba 552 */
Jenkins@KEILDM1.dc.multitech.prv 153:7c00843e4bba 553 virtual void ClearChannels();
Jenkins@KEILDM1.dc.multitech.prv 153:7c00843e4bba 554
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 555 protected:
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 556
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 557 SxRadio* GetRadio(); //!< Get pointer to the SxRadio object or assert if it is null
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 558 Settings* GetSettings(); //!< Get pointer to the settings object or assert if it is null
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 559
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 560 uint8_t _txChannel; //!< Current channel for transmit
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 561 uint8_t _txFrequencySubBand; //!< Current frequency sub band for hybrid operation
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 562
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 563 std::vector<Datarate> _datarates; //!< List of datarates
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 564
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 565 std::vector<Channel> _channels; //!< List of channels for transmit
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 566 std::vector<Channel> _dlChannels; //!< List of channels for receive if changed from default
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 567
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 568 std::vector<DutyBand> _dutyBands; //!< List of duty bands to limit radio time on air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 569
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 570 uint8_t _maxTxPower; //!< Max Tx power for channel Plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 571 uint8_t _minTxPower;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 572
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 573 uint32_t _minFrequency; //!< Minimum Frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 574 uint32_t _maxFrequency; //!< Maximum Frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 575
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 576 Channel _beaconChannel; //!< Beacon window settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 577 Channel _beaconRxChannel; //!< Beacon slot rx window settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 578
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 579 uint8_t _minDatarate; //!< Minimum datarate to accept in ADR request
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 580 uint8_t _maxDatarate; //!< Maximum datarate to accept in ADR request
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 581
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 582 uint8_t _minRx2Datarate; //!< Minimum datarate to accept in for Rx2
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 583 uint8_t _maxRx2Datarate; //!< Maximum datarate to accept in for Rx2
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 584 uint8_t _minDatarateOffset; //!< Minimum datarate offset to accept
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 585 uint8_t _maxDatarateOffset; //!< Maximum datarate offset to accept
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 586
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 587 uint32_t _freqUBase125k; //!< Start of 125K uplink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 588 uint32_t _freqUStep125k; //!< Step between 125K uplink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 589 uint32_t _freqUBase500k; //!< Start of 500K uplink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 590 uint32_t _freqUStep500k; //!< Step between 500K uplink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 591 uint32_t _freqDBase500k; //!< Start of 500K downlink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 592 uint32_t _freqDStep500k; //!< Step between 500K downlink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 593
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 594 uint8_t _numChans; //!< Number of total channels in plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 595 uint8_t _numChans125k; //!< Number of 125K channels in plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 596 uint8_t _numChans500k; //!< Number of 500K channels in plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 597
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 598 uint16_t _LBT_TimeUs; //!< Sample time in us for LBT
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 599 int8_t _LBT_Threshold; //!< Threshold in dBm for LBT
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 600
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 601 std::vector<uint16_t> _channelMask; //!< Bit mask for currently enabled channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 602
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 603 Timer _dutyCycleTimer; //!< Timer for tracking time-off-air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 604 RtosTimer _txDutyTimer; //!< Event timer for expiration of time-off-air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 605
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 606 bool _txDutyCyclePending; //!< Flag for pending duty cycle event
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 607
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 608 static void OnTxDutyCycleEvent(const void* arg); //!< Rtos callback for duty cycle event
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 609 void OnTxDutyCycleEventBottom(); //!< Callback for duty cycle event
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 610
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 611 static const uint8_t* TX_POWERS; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 612 static const uint8_t* RADIO_POWERS; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 613 static const uint8_t* MAX_PAYLOAD_SIZE; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 614 static const uint8_t* MAX_PAYLOAD_SIZE_REPEATER; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 615
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 616 uint8_t _plan;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 617 std::string _planName;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 618
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 619 private:
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 620
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 621 SxRadio* _radio; //!< Injected SxRadio dependency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 622 Settings* _settings; //!< Current settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 623 };
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 624 }
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 625
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 626 #endif