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:
Fri Nov 09 14:56:50 2018 -0600
Revision:
133:4ca51f965419
Parent:
126:c17213d3156d
xdot-library revision 3.1.0-57-g8e84ec6 and mbed-os revision mbed-os-5.10.2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 1 /** __ ___ ____ _ ______ __ ____ __ ____
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 2 * / |/ /_ __/ / /_(_)__/_ __/__ ____/ / / __/_ _____ / /____ __ _ ___ / _/__ ____
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 3 * / /|_/ / // / / __/ /___// / / -_) __/ _ \ _\ \/ // (_-</ __/ -_) ' \(_-< _/ // _ \/ __/ __
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 4 * /_/ /_/\_,_/_/\__/_/ /_/ \__/\__/_//_/ /___/\_, /___/\__/\__/_/_/_/___/ /___/_//_/\__/ /_/
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 5 * Copyright (C) 2015 by Multi-Tech Systems /___/
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 6 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 7 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 8 * @author Jason Reiss
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 9 * @date 10-31-2015
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 10 * @brief lora::ChannelPlan provides an interface for LoRaWAN channel schemes
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 11 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 12 * @details
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 13 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 14 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 15
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 16 #ifndef __CHANNEL_PLAN_US915_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 17 #define __CHANNEL_PLAN_US915_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 18
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 19 #include "Lora.h"
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 20 #include "SxRadio.h"
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 21 #include "ChannelPlan.h"
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 22 #include <vector>
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 23
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 24 namespace lora {
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 25
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 26 const uint8_t US915_125K_NUM_CHANS = 64; //!< Number of 125k channels in US915 channel plan
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 27 const uint8_t US915_500K_NUM_CHANS = 8; //!< Number of 500k channels in US915 channel plan
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 28
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 29 const uint32_t US915_125K_FREQ_BASE = 902300000; //!< Frequency base for 125k US915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 30 const uint32_t US915_125K_FREQ_STEP = 200000; //!< Frequency step for 125k US915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 31
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 32 const uint32_t US915_500K_FREQ_BASE = 903000000; //!< Frequency base for 500k US915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 33 const uint32_t US915_500K_FREQ_STEP = 1600000; //!< Frequency step for 500k US915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 34
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 35 const uint32_t US915_500K_DBASE = 923300000; //!< Frequency base for 500k US915 downlink channels
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 36 const uint32_t US915_500K_DSTEP = 600000; //!< Frequency step for 500k US915 downlink channels
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 37
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 38 const uint32_t US915_FREQ_MIN = 902000000;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 39 const uint32_t US915_FREQ_MAX = 928000000;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 40
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 41 const uint8_t US915_MIN_DATARATE = (uint8_t) DR_0; //!< Minimum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 42 const uint8_t US915_MAX_DATARATE = (uint8_t) DR_4; //!< Maximum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 43
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 44 const uint8_t US915_MIN_DATARATE_OFFSET = (uint8_t) 0; //!< Minimum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 45 const uint8_t US915_MAX_DATARATE_OFFSET = (uint8_t) 3; //!< Maximum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 46
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 47 const uint8_t US915_BEACON_DR = DR_8; //!< Default beacon datarate
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 48 const uint32_t US915_BEACON_FREQ_BASE = 923300000U; //!< Base beacon broadcast frequency
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 49 const uint32_t US915_BEACON_FREQ_STEP = 600000U; //!< Step size for beacon frequencies
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 50 const uint8_t US915_BEACON_CHANNELS = 8U; //!< Number of beacon channels
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 51
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 52 class ChannelPlan_US915 : public lora::ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 53 public:
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 54
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 55 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 56 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 57 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 58 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 59 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 60 ChannelPlan_US915();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 61 ChannelPlan_US915(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 62 ChannelPlan_US915(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 63
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 64 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 65 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 66 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 67 virtual ~ChannelPlan_US915();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 68
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 69 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 70 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 71 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 72 virtual void Init();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 73
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 74 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 75 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 76 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 77 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 78 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 79 virtual uint8_t GetNextChannel();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 80
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 81 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 82 * Set the number of channels in the plan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 83 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 84 virtual void SetNumberOfChannels(uint8_t channels, bool resize = true);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 85
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 86 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 87 * Check if channel is enabled
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 88 * @return true if enabled
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 89 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 90 virtual bool IsChannelEnabled(uint8_t channel);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 91
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 92
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 93 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 94 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 95 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 96 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 97 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 98 virtual uint8_t AddChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 99
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 100 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 101 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 102 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 103 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 104 virtual Channel GetChannel(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 105
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 106 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 107 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 108 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 109 * @param window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 110 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 111 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 112 virtual RxWindow GetRxWindow(uint8_t window);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 113
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 114 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 115 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 116 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 117 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 118 virtual uint8_t GetJoinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 119
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 120 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 121 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 122 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 123 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 124 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 125 virtual uint8_t CalculateJoinBackoff(uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 126
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 127 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 128 * Set the datarate offset used for first receive window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 129 * @param offset
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 130 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 131 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 132 virtual uint8_t SetRx1Offset(uint8_t offset);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 133
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 134 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 135 * Set the frequency for second receive window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 136 * @param freq
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 137 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 138 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 139 virtual uint8_t SetRx2Frequency(uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 140
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 141 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 142 * Set the datarate index used for second receive window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 143 * @param index
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 144 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 145 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 146 virtual uint8_t SetRx2DatarateIndex(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 147
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 148 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 149 * Get next channel and set the SxRadio tx config with current settings
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 150 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 151 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 152 virtual uint8_t SetTxConfig();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 153
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 154 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 155 * Set the SxRadio rx config provided window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 156 * @param window to be opened
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 157 * @param continuous keep window open
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 158 * @param wnd_growth factor to increase the rx window by
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 159 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 160 */
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 161 virtual uint8_t SetRxConfig(uint8_t window, bool continuous, uint16_t wnd_growth);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 162
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 163 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 164 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 165 * @param sub_band
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 166 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 167 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 168 virtual uint8_t SetFrequencySubBand(uint8_t sub_band);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 169
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 170 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 171 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 172 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 173 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 174 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 175
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 176 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 177 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 178 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 179 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 180 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 181 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 182 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 183 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 184 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 185
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 186 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 187 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 188 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 189 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 190 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 191 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 192 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 193 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 194 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 195
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 196 /**
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 197 * Callback to for downlink channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 198 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 199 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 200 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 201 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 202 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 203 */
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 204 virtual uint8_t HandleDownlinkChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 205
Jenkins@KEILDM1.dc.multitech.prv 86:8e7bfa8973b4 206 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 207 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 208 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 209 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 210 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 211 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 212 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 213 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 214 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 215
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 216 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 217 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 218 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 219 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 220 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 221 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 222 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 223 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 224 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 225
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 226 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 227 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 228 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 229 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 230 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 231 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 232 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 233 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 234 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 235
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 236 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 237 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 238 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 239 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 240 virtual uint8_t ValidateAdrConfiguration();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 241
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 242 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 243 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 244 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 245 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 246 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 247 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 248 virtual uint32_t GetTimeOffAir();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 249
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 250 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 251 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 252 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 253 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 254 virtual std::vector<uint32_t> GetChannels();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 255
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 256 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 257 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 258 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 259 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 260 virtual std::vector<uint8_t> GetChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 261
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 262
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 263 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 264 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 265 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 266 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 267 virtual void LogRxWindow(uint8_t wnd);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 268
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 269 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 270 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 271 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 272 virtual void EnableDefaultChannels();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 273
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 274 virtual uint8_t GetMinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 275
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 276 virtual uint8_t GetMaxDatarate();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 277
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 278 /**
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 279 * Check if this packet is a beacon and if so extract parameters needed
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 280 * @param payload of potential beacon
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 281 * @param size of the packet
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 282 * @param [out] data extracted from the beacon if this packet was indeed a beacon
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 283 * @return true if this packet is beacon, false if not
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 284 */
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 285 virtual bool DecodeBeacon(const uint8_t* payload,
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 286 size_t size,
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 287 BeaconData_t& data);
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 288 /**
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 289 * Update class B beacon and ping slot settings if frequency hopping enabled
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 290 * @param time received in the last beacon
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 291 * @param period of the beacon
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 292 * @param devAddr of this end device
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 293 */
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 294 virtual void FrequencyHop(uint32_t time, uint32_t period, uint32_t devAddr);
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 295
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 296 protected:
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 297
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 298 static const uint8_t US915_TX_POWERS[11]; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 299 static const uint8_t US915_RADIO_POWERS[21]; //!< List of calibrated tx powers
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 300 static const uint8_t US915_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 301 static const uint8_t US915_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 302
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 303 typedef struct __attribute__((packed)) {
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 304 uint8_t RFU1[5];
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 305 uint8_t Time[4];
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 306 uint8_t CRC1[2];
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 307 uint8_t GwSpecific[7];
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 308 uint8_t RFU2[3];
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 309 uint8_t CRC2[2];
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 310 } BCNPayload;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 311 };
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 312 }
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 313
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 314 #endif // __CHANNEL_PLAN_US915_H__