Bleeding edge development version of the mDot 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:   mDot-IKS01A1 mDot-IKS01A1 mDot-Examples mDot-IKS01A1-Explora ... more

Fork of libmDot-dev-mbed2-deprecated by MultiTech

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