MultiTech / libxDot-Custom

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.

Fork of libxDot-dev-mbed5-deprecated by MultiTech

The Connect example can be used as a starting point for an xDot application.

Import programmDot_LoRa_Connect_Example_CUSTOM_AS923

Example configuration of frequencies and datarates for AS923 channel plan.

Last commit 07 Mar 2017 by MultiTech

Change the libmDot-Custom library to libxDot-Custom after importing the above example.

Change the platform for the project to xDot in upper right corner of the compiler page.

Ensure the mbed-os version matches the with the library commit.

Currently the AT Firmware cannot be built online for the xDot.

Creating new channel plans

Copy EU868 or US915 custom channel plan as a starting point

Import librarymDot_Channel_Plans

Channel plans to enable libmDot-Custom

Last commit 07 Feb 2017 by MultiTech

EU868 provides a framework for a DYNAMIC channel plan with duty-cycle limitations

US915 provides a framework for a FIXED channel plan

RADIO_POWERS are measured output in dBm for each radio tx power setting.

Additional MAC Commands can be implemented by overriding the HandleMacCommand function.

Steps

  1. Setup datarates, duty-cycle bands and channels in ChannelPlan_* constructor
  2. Modify GetJoinDatarate and CalculateJoinBackoff to change join datarates and backoff
  3. Customize HandleJoinAccept datarates
  4. Use GetRxWindow(int) to define how the device open Rx window 1 and 2
  5. GetNextChannel will pick a channel from the enabled channel at the current datarate before each TX

ChannelPlans/CustomChannelPlan_AU915.h@27:9f789acbca4d, 2017-01-18 (annotated)

Committer:
jreiss
Date:
Wed Jan 18 16:14:28 2017 +0000
Revision:
27:9f789acbca4d
Update to mbed-os 5.3.3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jreiss 27:9f789acbca4d 1 /** __ ___ ____ _ ______ __ ____ __ ____
jreiss 27:9f789acbca4d 2 * / |/ /_ __/ / /_(_)__/_ __/__ ____/ / / __/_ _____ / /____ __ _ ___ / _/__ ____
jreiss 27:9f789acbca4d 3 * / /|_/ / // / / __/ /___// / / -_) __/ _ \ _\ \/ // (_-</ __/ -_) ' \(_-< _/ // _ \/ __/ __
jreiss 27:9f789acbca4d 4 * /_/ /_/\_,_/_/\__/_/ /_/ \__/\__/_//_/ /___/\_, /___/\__/\__/_/_/_/___/ /___/_//_/\__/ /_/
jreiss 27:9f789acbca4d 5 * Copyright (C) 2015 by Multi-Tech Systems /___/
jreiss 27:9f789acbca4d 6 *
jreiss 27:9f789acbca4d 7 *
jreiss 27:9f789acbca4d 8 * @author Jason Reiss
jreiss 27:9f789acbca4d 9 * @date 10-31-2015
jreiss 27:9f789acbca4d 10 * @brief lora::ChannelPlan provides an interface for LoRaWAN channel schemes
jreiss 27:9f789acbca4d 11 *
jreiss 27:9f789acbca4d 12 * @details
jreiss 27:9f789acbca4d 13 *
jreiss 27:9f789acbca4d 14 */
jreiss 27:9f789acbca4d 15
jreiss 27:9f789acbca4d 16 #ifndef __CUSTOM_CHANNEL_PLAN_AU915_H__
jreiss 27:9f789acbca4d 17 #define __CUSTOM_CHANNEL_PLAN_AU915_H__
jreiss 27:9f789acbca4d 18
jreiss 27:9f789acbca4d 19 #include "Lora.h"
jreiss 27:9f789acbca4d 20 #include "SxRadio.h"
jreiss 27:9f789acbca4d 21 #include "ChannelPlan.h"
jreiss 27:9f789acbca4d 22 #include <vector>
jreiss 27:9f789acbca4d 23
jreiss 27:9f789acbca4d 24 namespace lora {
jreiss 27:9f789acbca4d 25
jreiss 27:9f789acbca4d 26 class CustomChannelPlan_AU915 : public lora::ChannelPlan {
jreiss 27:9f789acbca4d 27 public:
jreiss 27:9f789acbca4d 28
jreiss 27:9f789acbca4d 29 /**
jreiss 27:9f789acbca4d 30 * ChannelPlan constructor
jreiss 27:9f789acbca4d 31 * @param radio SxRadio object used to set Tx/Rx config
jreiss 27:9f789acbca4d 32 * @param settings Settings object
jreiss 27:9f789acbca4d 33 */
jreiss 27:9f789acbca4d 34 CustomChannelPlan_AU915(SxRadio& radio, Settings& settings);
jreiss 27:9f789acbca4d 35
jreiss 27:9f789acbca4d 36 /**
jreiss 27:9f789acbca4d 37 * ChannelPlan destructor
jreiss 27:9f789acbca4d 38 */
jreiss 27:9f789acbca4d 39 virtual ~CustomChannelPlan_AU915();
jreiss 27:9f789acbca4d 40
jreiss 27:9f789acbca4d 41 /**
jreiss 27:9f789acbca4d 42 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
jreiss 27:9f789acbca4d 43 */
jreiss 27:9f789acbca4d 44 virtual void Init();
jreiss 27:9f789acbca4d 45
jreiss 27:9f789acbca4d 46 /**
jreiss 27:9f789acbca4d 47 * Get the next channel to use to transmit
jreiss 27:9f789acbca4d 48 * @return LORA_OK if channel was found
jreiss 27:9f789acbca4d 49 * @return LORA_NO_CHANS_ENABLED
jreiss 27:9f789acbca4d 50 */
jreiss 27:9f789acbca4d 51 virtual uint8_t GetNextChannel();
jreiss 27:9f789acbca4d 52
jreiss 27:9f789acbca4d 53 /**
jreiss 27:9f789acbca4d 54 * Set the number of channels in the plan
jreiss 27:9f789acbca4d 55 */
jreiss 27:9f789acbca4d 56 virtual void SetNumberOfChannels(uint8_t channels, bool resize = true);
jreiss 27:9f789acbca4d 57
jreiss 27:9f789acbca4d 58 /**
jreiss 27:9f789acbca4d 59 * Check if channel is enabled
jreiss 27:9f789acbca4d 60 * @return true if enabled
jreiss 27:9f789acbca4d 61 */
jreiss 27:9f789acbca4d 62 virtual bool IsChannelEnabled(uint8_t channel);
jreiss 27:9f789acbca4d 63
jreiss 27:9f789acbca4d 64
jreiss 27:9f789acbca4d 65 /**
jreiss 27:9f789acbca4d 66 * Add a channel to the ChannelPlan
jreiss 27:9f789acbca4d 67 * @param index of channel, use -1 to add to end
jreiss 27:9f789acbca4d 68 * @param channel settings to add
jreiss 27:9f789acbca4d 69 */
jreiss 27:9f789acbca4d 70 virtual uint8_t AddChannel(int8_t index, Channel channel);
jreiss 27:9f789acbca4d 71
jreiss 27:9f789acbca4d 72 /**
jreiss 27:9f789acbca4d 73 * Get channel at index
jreiss 27:9f789acbca4d 74 * @return Channel
jreiss 27:9f789acbca4d 75 */
jreiss 27:9f789acbca4d 76 virtual Channel GetChannel(int8_t index);
jreiss 27:9f789acbca4d 77
jreiss 27:9f789acbca4d 78 /**
jreiss 27:9f789acbca4d 79 * Get rx window settings for requested window
jreiss 27:9f789acbca4d 80 * RX_1, RX_2, RX_BEACON, RX_SLOT
jreiss 27:9f789acbca4d 81 * @param window
jreiss 27:9f789acbca4d 82 * @return RxWindow
jreiss 27:9f789acbca4d 83 */
jreiss 27:9f789acbca4d 84 virtual RxWindow GetRxWindow(uint8_t window);
jreiss 27:9f789acbca4d 85
jreiss 27:9f789acbca4d 86 /**
jreiss 27:9f789acbca4d 87 * Get datarate to use on the join request
jreiss 27:9f789acbca4d 88 * @return datarate index
jreiss 27:9f789acbca4d 89 */
jreiss 27:9f789acbca4d 90 virtual uint8_t GetJoinDatarate();
jreiss 27:9f789acbca4d 91
jreiss 27:9f789acbca4d 92 /**
jreiss 27:9f789acbca4d 93 * Calculate the next time a join request is possible
jreiss 27:9f789acbca4d 94 * @param size of join frame
jreiss 27:9f789acbca4d 95 * @returns LORA_OK
jreiss 27:9f789acbca4d 96 */
jreiss 27:9f789acbca4d 97 virtual uint8_t CalculateJoinBackoff(uint8_t size);
jreiss 27:9f789acbca4d 98
jreiss 27:9f789acbca4d 99 /**
jreiss 27:9f789acbca4d 100 * Set the datarate offset used for first receive window
jreiss 27:9f789acbca4d 101 * @param offset
jreiss 27:9f789acbca4d 102 * @return LORA_OK
jreiss 27:9f789acbca4d 103 */
jreiss 27:9f789acbca4d 104 virtual uint8_t SetRx1Offset(uint8_t offset);
jreiss 27:9f789acbca4d 105
jreiss 27:9f789acbca4d 106 /**
jreiss 27:9f789acbca4d 107 * Set the frequency for second receive window
jreiss 27:9f789acbca4d 108 * @param freq
jreiss 27:9f789acbca4d 109 * @return LORA_OK
jreiss 27:9f789acbca4d 110 */
jreiss 27:9f789acbca4d 111 virtual uint8_t SetRx2Frequency(uint32_t freq);
jreiss 27:9f789acbca4d 112
jreiss 27:9f789acbca4d 113 /**
jreiss 27:9f789acbca4d 114 * Set the datarate index used for second receive window
jreiss 27:9f789acbca4d 115 * @param index
jreiss 27:9f789acbca4d 116 * @return LORA_OK
jreiss 27:9f789acbca4d 117 */
jreiss 27:9f789acbca4d 118 virtual uint8_t SetRx2DatarateIndex(uint8_t index);
jreiss 27:9f789acbca4d 119
jreiss 27:9f789acbca4d 120 /**
jreiss 27:9f789acbca4d 121 * Get next channel and set the SxRadio tx config with current settings
jreiss 27:9f789acbca4d 122 * @return LORA_OK
jreiss 27:9f789acbca4d 123 */
jreiss 27:9f789acbca4d 124 virtual uint8_t SetTxConfig();
jreiss 27:9f789acbca4d 125
jreiss 27:9f789acbca4d 126 /**
jreiss 27:9f789acbca4d 127 * Set the SxRadio rx config provided window
jreiss 27:9f789acbca4d 128 * @param window to be opened
jreiss 27:9f789acbca4d 129 * @param continuous keep window open
jreiss 27:9f789acbca4d 130 * @return LORA_OK
jreiss 27:9f789acbca4d 131 */
jreiss 27:9f789acbca4d 132 virtual uint8_t SetRxConfig(uint8_t window, bool continuous);
jreiss 27:9f789acbca4d 133
jreiss 27:9f789acbca4d 134 /**
jreiss 27:9f789acbca4d 135 * Set channel group if supported by plan
jreiss 27:9f789acbca4d 136 * @param group
jreiss 27:9f789acbca4d 137 * @return LORA_OK
jreiss 27:9f789acbca4d 138 */
jreiss 27:9f789acbca4d 139 virtual uint8_t SetChannelGroup(uint8_t group);
jreiss 27:9f789acbca4d 140
jreiss 27:9f789acbca4d 141 /**
jreiss 27:9f789acbca4d 142 * Callback for Join Accept packet to load optional channels
jreiss 27:9f789acbca4d 143 * @return LORA_OK
jreiss 27:9f789acbca4d 144 */
jreiss 27:9f789acbca4d 145 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size);
jreiss 27:9f789acbca4d 146
jreiss 27:9f789acbca4d 147 /**
jreiss 27:9f789acbca4d 148 * Callback to for rx parameter setup ServerCommand
jreiss 27:9f789acbca4d 149 * @param payload packet data
jreiss 27:9f789acbca4d 150 * @param index of start of command buffer
jreiss 27:9f789acbca4d 151 * @param size number of bytes in command buffer
jreiss 27:9f789acbca4d 152 * @param[out] status to be returned in MoteCommand answer
jreiss 27:9f789acbca4d 153 * @return LORA_OK
jreiss 27:9f789acbca4d 154 */
jreiss 27:9f789acbca4d 155 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
jreiss 27:9f789acbca4d 156
jreiss 27:9f789acbca4d 157 /**
jreiss 27:9f789acbca4d 158 * Callback to for new channel ServerCommand
jreiss 27:9f789acbca4d 159 * @param payload packet data
jreiss 27:9f789acbca4d 160 * @param index of start of command buffer
jreiss 27:9f789acbca4d 161 * @param size number of bytes in command buffer
jreiss 27:9f789acbca4d 162 * @param[out] status to be returned in MoteCommand answer
jreiss 27:9f789acbca4d 163 * @return LORA_OK
jreiss 27:9f789acbca4d 164 */
jreiss 27:9f789acbca4d 165 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
jreiss 27:9f789acbca4d 166
jreiss 27:9f789acbca4d 167 /**
jreiss 27:9f789acbca4d 168 * Callback to for ping slot channel request ServerCommand
jreiss 27:9f789acbca4d 169 * @param payload packet data
jreiss 27:9f789acbca4d 170 * @param index of start of command buffer
jreiss 27:9f789acbca4d 171 * @param size number of bytes in command buffer
jreiss 27:9f789acbca4d 172 * @param[out] status to be returned in MoteCommand answer
jreiss 27:9f789acbca4d 173 * @return LORA_OK
jreiss 27:9f789acbca4d 174 */
jreiss 27:9f789acbca4d 175 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
jreiss 27:9f789acbca4d 176
jreiss 27:9f789acbca4d 177 /**
jreiss 27:9f789acbca4d 178 * Callback to for beacon frequency request ServerCommand
jreiss 27:9f789acbca4d 179 * @param payload packet data
jreiss 27:9f789acbca4d 180 * @param index of start of command buffer
jreiss 27:9f789acbca4d 181 * @param size number of bytes in command buffer
jreiss 27:9f789acbca4d 182 * @param[out] status to be returned in MoteCommand answer
jreiss 27:9f789acbca4d 183 * @return LORA_OK
jreiss 27:9f789acbca4d 184 */
jreiss 27:9f789acbca4d 185 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
jreiss 27:9f789acbca4d 186
jreiss 27:9f789acbca4d 187 /**
jreiss 27:9f789acbca4d 188 * Callback to for adaptive datarate ServerCommand
jreiss 27:9f789acbca4d 189 * @param payload packet data
jreiss 27:9f789acbca4d 190 * @param index of start of command buffer
jreiss 27:9f789acbca4d 191 * @param size number of bytes in command buffer
jreiss 27:9f789acbca4d 192 * @param[out] status to be returned in MoteCommand answer
jreiss 27:9f789acbca4d 193 * @return LORA_OK
jreiss 27:9f789acbca4d 194 */
jreiss 27:9f789acbca4d 195 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
jreiss 27:9f789acbca4d 196
jreiss 27:9f789acbca4d 197 /**
jreiss 27:9f789acbca4d 198 * Flag if ADR ACK should be sent in next packet
jreiss 27:9f789acbca4d 199 * @return true when flag should be set
jreiss 27:9f789acbca4d 200 */
jreiss 27:9f789acbca4d 201 virtual bool AdrAckReq();
jreiss 27:9f789acbca4d 202
jreiss 27:9f789acbca4d 203 /**
jreiss 27:9f789acbca4d 204 * Get the time the radio must be off air to comply with regulations
jreiss 27:9f789acbca4d 205 * Time to wait may be dependent on duty-cycle restrictions per channel
jreiss 27:9f789acbca4d 206 * Or duty-cycle of join requests if OTAA is being attempted
jreiss 27:9f789acbca4d 207 * @return ms of time to wait for next tx opportunity
jreiss 27:9f789acbca4d 208 */
jreiss 27:9f789acbca4d 209 virtual uint32_t GetTimeOffAir();
jreiss 27:9f789acbca4d 210
jreiss 27:9f789acbca4d 211 /**
jreiss 27:9f789acbca4d 212 * Get the channels in use by current channel plan
jreiss 27:9f789acbca4d 213 * @return channel frequencies
jreiss 27:9f789acbca4d 214 */
jreiss 27:9f789acbca4d 215 virtual std::vector<uint32_t> GetChannels();
jreiss 27:9f789acbca4d 216
jreiss 27:9f789acbca4d 217 /**
jreiss 27:9f789acbca4d 218 * Get the channel datarate ranges in use by current channel plan
jreiss 27:9f789acbca4d 219 * @return channel datarate ranges
jreiss 27:9f789acbca4d 220 */
jreiss 27:9f789acbca4d 221 virtual std::vector<uint8_t> GetChannelRanges();
jreiss 27:9f789acbca4d 222
jreiss 27:9f789acbca4d 223
jreiss 27:9f789acbca4d 224 /**
jreiss 27:9f789acbca4d 225 * Print log message for given rx window
jreiss 27:9f789acbca4d 226 * @param wnd 1 or 2
jreiss 27:9f789acbca4d 227 */
jreiss 27:9f789acbca4d 228 virtual void LogRxWindow(uint8_t wnd);
jreiss 27:9f789acbca4d 229
jreiss 27:9f789acbca4d 230 /**
jreiss 27:9f789acbca4d 231 * Enable the default channels of the channel plan
jreiss 27:9f789acbca4d 232 */
jreiss 27:9f789acbca4d 233 virtual void EnableDefaultChannels();
jreiss 27:9f789acbca4d 234
jreiss 27:9f789acbca4d 235 virtual uint8_t GetMinDatarate();
jreiss 27:9f789acbca4d 236
jreiss 27:9f789acbca4d 237 virtual uint8_t GetMaxDatarate();
jreiss 27:9f789acbca4d 238
jreiss 27:9f789acbca4d 239 protected:
jreiss 27:9f789acbca4d 240
jreiss 27:9f789acbca4d 241 static const uint8_t AU915_TX_POWERS[11]; //!< List of available tx powers
jreiss 27:9f789acbca4d 242 static const uint8_t AU915_RADIO_POWERS[21]; //!< List of calibrated tx powers
jreiss 27:9f789acbca4d 243 static const uint8_t AU915_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate
jreiss 27:9f789acbca4d 244 static const uint8_t AU915_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate
jreiss 27:9f789acbca4d 245
jreiss 27:9f789acbca4d 246 };
jreiss 27:9f789acbca4d 247 }
jreiss 27:9f789acbca4d 248
jreiss 27:9f789acbca4d 249 #endif // __CUSTOM_CHANNEL_PLAN_AU915_H__
jreiss 27:9f789acbca4d 250