Meach will / libmDot-mbed5

hello 2

Dependents:   ncu_project

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