Aidan Wynn / libmDot-mbed5

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Cloudtracker

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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 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_EU868_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 17 #define __CHANNEL_PLAN_EU868_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 EU868_125K_NUM_CHANS = 16; //!< Number of 125k channels in EU868 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 27 const uint8_t EU868_DEFAULT_NUM_CHANS = 3; //!< Number of defualt channels in EU868 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 28 const uint32_t EU868_125K_FREQ_BASE = 868100000; //!< Frequency base for 125k EU868 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 29 const uint32_t EU868_125K_FREQ_STEP = 200000; //!< Frequency step for 125k EU868 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 30 const uint32_t EU868_RX2_FREQ = 869525000; //!< Frequency default for second rx window in EU868
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 31
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 32 const uint8_t EU868_TX_POWER_MAX = 14; //!< Max power for EU868 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 33
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 34 // 0.1% duty cycle 863-868
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 35 // Limiting to 865-868 allows for 1% duty cycle
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 36 const uint32_t EU868_MILLI_FREQ_MIN = 865000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 37 const uint32_t EU868_MILLI_FREQ_MAX = 868000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 38
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 39 const uint32_t EU868_MILLI_1_FREQ_MIN = 868700000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 40 const uint32_t EU868_MILLI_1_FREQ_MAX = 869200000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 41
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 42 // 1% duty cycle
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 43 const uint32_t EU868_CENTI_FREQ_MIN = 868000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 44 const uint32_t EU868_CENTI_FREQ_MAX = 868600000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 45
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 46 // 10% duty cycle
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 47 const uint32_t EU868_DECI_FREQ_MIN = 869400000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 48 const uint32_t EU868_DECI_FREQ_MAX = 869650000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 49
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 50 // Below 7dBm there is no duty cycle for these frequencies
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 51 // Up to 14dBm there is 1% duty cycle
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 52 const uint32_t EU868_VAR_FREQ_MIN = 869700000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 53 const uint32_t EU868_VAR_FREQ_MAX = 870000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 54
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 55 const uint32_t EU868_FREQ_MIN = 863000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 56 const uint32_t EU868_FREQ_MAX = 870000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 57
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 58 const uint8_t EU868_MIN_DATARATE = (uint8_t) DR_0; //!< Minimum transmit datarate for EU868
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 59 const uint8_t EU868_MAX_DATARATE = (uint8_t) DR_7; //!< Maximum transmit datarate for EU868
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 60
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 61 const uint8_t EU868_MIN_DATARATE_OFFSET = (uint8_t) 0; //!< Minimum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 62 const uint8_t EU868_MAX_DATARATE_OFFSET = (uint8_t) 5; //!< Maximum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 63
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 64 const uint8_t EU868_BEACON_DR = DR_3; //!< Default beacon datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 65 const uint32_t EU868_BEACON_FREQ = 869525000U; //!< Default beacon broadcast frequency
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 66
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 67 class ChannelPlan_EU868 : public lora::ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 68 public:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 69 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 70 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 71 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 72 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 73 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 74 ChannelPlan_EU868();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 75 ChannelPlan_EU868(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 76 ChannelPlan_EU868(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 77
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 78 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 79 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 80 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 81 virtual ~ChannelPlan_EU868();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 82
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 83 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 84 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 85 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 86 virtual void Init();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 87
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 88 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 89 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 90 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 91 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 92 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 93 virtual uint8_t GetNextChannel();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 94
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 95 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 96 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 97 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 98 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 99 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 100 virtual uint8_t AddChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 101
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 102 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 103 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 104 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 105 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 106 virtual Channel GetChannel(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 107
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 108 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 109 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 110 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 111 * @param window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 112 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 113 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 114 virtual RxWindow GetRxWindow(uint8_t window);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 115
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 116 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 117 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 118 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 119 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 120 virtual uint8_t GetJoinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 121
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 122 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 123 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 124 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 125 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 126 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 127 virtual uint8_t CalculateJoinBackoff(uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 128
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 129 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 130 * Get next channel and set the SxRadio tx config with current settings
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 SetTxConfig();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 134
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 135 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 136 * Set the SxRadio rx config provided window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 137 * @param window to be opened
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 138 * @param continuous keep window open
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 139 * @param wnd_growth factor to increase the rx window by
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 140 * @param pad_ms time in milliseconds to add to computed window size
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 141 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 142 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 143 virtual uint8_t SetRxConfig(uint8_t window,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 144 bool continuous,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 145 uint16_t wnd_growth,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 146 uint16_t pad_ms);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 147
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 148 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 149 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 150 * @param sub_band
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 SetFrequencySubBand(uint8_t sub_band);
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 for ACK timeout event
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 157 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 158 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 159 virtual uint8_t HandleAckTimeout();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 160
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 161 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 162 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 163 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 164 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 165 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 166
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 167 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 168 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 169 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 170 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 171 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 172 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 173 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 174 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 175 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 176
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 177 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 178 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 179 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 180 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 181 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 182 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 183 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 184 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 185 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 186
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 187 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 188 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 189 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 190 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 191 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 192 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 193 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 194 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 195 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 196
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 197 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 198 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 199 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 200 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 201 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 202 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 203 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 204 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 205 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 206
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 207 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 208 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 209 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 210 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 211 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 212 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 213 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 214 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 215 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 216
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 217 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 218 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 219 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 220 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 221 virtual uint8_t ValidateAdrConfiguration();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 222
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 223 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 224 * Update duty cycle with at given frequency and time on air
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 225 * @param freq frequency
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 226 * @param time_on_air_ms tx time on air
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 227 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 228 virtual void UpdateDutyCycle(uint32_t freq, uint32_t time_on_air_ms);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 229
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 230 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 231 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 232 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 233 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 234 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 235 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 236 virtual uint32_t GetTimeOffAir();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 237
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 238 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 239 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 240 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 241 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 242 virtual std::vector<uint32_t> GetChannels();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 243
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 244 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 245 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 246 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 247 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 248 virtual std::vector<uint8_t> GetChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 249
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 250 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 251 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 252 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 253 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 254 virtual void LogRxWindow(uint8_t wnd);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 255
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 256 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 257 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 258 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 259 virtual void EnableDefaultChannels();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 260
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 261 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 262 * Check if this packet is a beacon and if so extract parameters needed
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 263 * @param payload of potential beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 264 * @param size of the packet
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 265 * @param [out] data extracted from the beacon if this packet was indeed a beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 266 * @return true if this packet is beacon, false if not
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 267 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 268 virtual bool DecodeBeacon(const uint8_t* payload,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 269 size_t size,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 270 BeaconData_t& data);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 271
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 272 protected:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 273
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 274 static const uint8_t EU868_TX_POWERS[8]; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 275 static const uint8_t EU868_RADIO_POWERS[21]; //!< List of calibrated tx powers
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 276 static const uint8_t EU868_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 277 static const uint8_t EU868_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 278
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 279 typedef struct __attribute__((packed)) {
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 280 uint8_t RFU[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 281 uint8_t Time[4];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 282 uint8_t CRC1[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 283 uint8_t GwSpecific[7];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 284 uint8_t CRC2[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 285 } BCNPayload;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 286 };
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 287 }
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 288
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 289 #endif //__CHANNEL_PLAN_EU868_H__