Bleeding edge development version of the xDot library for mbed 5. This version of the library is not guaranteed to be stable or well tested and should not be used in production or deployment scenarios.

Dependents:   Dot-Examples Dot-AT-Firmware Dot-Examples TEST_FF1705 ... more

The Dot library provides a LoRaWan certified stack for LoRa communication using MultiTech mDot and xDot devices. The stack is compatible with mbed 5.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. Channel plans are included with the 3.x.x Dot Library releases. The following code snippet demonstrates how to create a channel plan and inject it into the stack.

#include "mDot.h"
#include "channel_plans.h"

int main() {
    ChannelPlan* plan = new lora::ChannelPlan_US915();
    assert(plan);
    mDot* dot = mDot::getInstance(plan);
    assert(dot);

    // ...
}

Dot devices must not be deployed with software using a different channel plan than the Dot's default plan! This functionality is for development and testing only!

Multicast Sessions

Multicast sessions and packet rx events in library. When in Class C mode Multicast downlinks can be received. Recieved packets should be filtered on address, counter value will be maintained in the session or can be set explicitly depending on Application support to share Multicast Address, Keys and Counters.

mDot.h

        /**
         * Add a multicast session address and keys
         * Downlink counter is set to 0
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastSession(uint8_t index, uint32_t addr, const uint8_t* nsk, const uint8_t* dsk);
 
        /**
         * Set a multicast session counter
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastDownlinkCounter(uint8_t index, uint32_t count);

mDotEvent.h

The address field was added to PacketRx event.

        virtual void PacketRx(uint8_t port, uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr, lora::DownlinkControl ctrl, uint8_t slot, uint8_t retries, uint32_t address);

The name of the repository can be used to determine which device the stack was compiled for and if it's a development or production-ready build:

A changelog for the Dot library can be found here.

The Dot library version and the version of mbed-os it was compiled against can both be found in the commit message for that revision of the Dot library. Building your application with the same version of mbed-os as what was used to build the Dot library is highly recommended!

The Dot-Examples repository demonstrates how to use the Dot library in a custom application.

The mDot and xDot platform pages have lots of platform specific information and document potential issues, gotchas, etc, and provide instructions for getting started with development. Please take a look at the platform page before starting development as they should answer many questions you will have.

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Tue Sep 18 08:25:41 2018 -0500
Revision:
127:db053d511848
xdot-library revision 3.1.0-28-g84dbee8 and mbed-os revision mbed-os-5.9.6

Who changed what in which revision?

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