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