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:
Mon Jun 19 16:03:56 2017 -0500
Revision:
36:bf7b1b13d7da
Child:
121:b7c80d8c4eb2
xdot-library revision 3.0.0-rc7-1-ga5165ae and mbed-os revision mbed-os-5.4.7

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_KR920_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 17 #define __CHANNEL_PLAN_KR920_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 36:bf7b1b13d7da 26 class ChannelPlan_KR920 : public lora::ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 27 public:
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 28 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 29 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 30 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 31 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 32 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 33 ChannelPlan_KR920();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 34 ChannelPlan_KR920(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 35 ChannelPlan_KR920(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 36
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 37 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 38 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 39 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 40 virtual ~ChannelPlan_KR920();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 41
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 42 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 43 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 44 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 45 virtual void Init();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 46
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 47 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 48 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 49 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 50 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 51 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 52 virtual uint8_t GetNextChannel();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 53
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 54 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 55 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 56 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 57 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 58 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 59 virtual uint8_t AddChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 60
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 61 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 62 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 63 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 64 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 65 virtual Channel GetChannel(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 66
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 67 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 68 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 69 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 70 * @param window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 71 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 72 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 73 virtual RxWindow GetRxWindow(uint8_t window);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 74
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 75 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 76 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 77 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 78 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 79 virtual uint8_t GetJoinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 80
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 81 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 82 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 83 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 84 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 85 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 86 virtual uint8_t CalculateJoinBackoff(uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 87
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 88 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 89 * Get next channel and set the SxRadio tx config with current settings
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 90 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 91 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 92 virtual uint8_t SetTxConfig();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 93
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 94 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 95 * Set the SxRadio rx config provided window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 96 * @param window to be opened
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 97 * @param continuous keep window open
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 98 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 99 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 100 virtual uint8_t SetRxConfig(uint8_t window, bool continuous);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 101
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 102 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 103 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 104 * @param sub_band
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 105 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 106 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 107 virtual uint8_t SetFrequencySubBand(uint8_t sub_band);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 108
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 109 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 110 * Callback for ACK timeout event
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 111 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 112 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 113 virtual uint8_t HandleAckTimeout();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 114
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 115 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 116 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 117 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 118 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 119 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 120
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 121 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 122 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 123 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 124 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 125 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 126 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 127 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 128 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 129 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 130
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 131 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 132 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 133 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 134 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 135 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 136 * @param[out] status to be returned in MoteCommand answer
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 HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 140
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 141 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 142 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 143 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 144 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 145 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 146 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 147 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 148 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 149 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 150
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 151 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 152 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 153 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 154 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 155 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 156 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 157 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 158 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 159 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 160
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 161 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 162 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 163 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 164 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 165 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 166 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 167 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 168 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 169 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 170
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 171 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 172 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 173 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 174 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 175 virtual uint8_t ValidateAdrConfiguration();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 176
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 177 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 178 * Update duty cycle with at given frequency and time on air
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 179 * @param freq frequency
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 180 * @param time_on_air_ms tx time on air
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 181 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 182 virtual void UpdateDutyCycle(uint32_t freq, uint32_t time_on_air_ms);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 183
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 184 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 185 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 186 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 187 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 188 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 189 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 190 virtual uint32_t GetTimeOffAir();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 191
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 192 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 193 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 194 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 195 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 196 virtual std::vector<uint32_t> GetChannels();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 197
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 198 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 199 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 200 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 201 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 202 virtual std::vector<uint8_t> GetChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 203
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 204 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 205 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 206 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 207 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 208 virtual void LogRxWindow(uint8_t wnd);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 209
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 210 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 211 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 212 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 213 virtual void EnableDefaultChannels();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 214
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 215 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 216 * Called when MAC layer doesn't know about a command.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 217 * Use to add custom or new mac command handling
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 218 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 219 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 220 virtual uint8_t HandleMacCommand(uint8_t* payload, uint8_t& index);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 221
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 222 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 223 * Set LBT time and threshold to defaults
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 224 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 225 virtual void DefaultLBT();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 226
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 227 protected:
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 228
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 229 static const uint8_t KR920_TX_POWERS[8]; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 230 static const uint8_t KR920_RADIO_POWERS[21]; //!< List of calibrated tx powers
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 231 static const uint8_t KR920_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 232 static const uint8_t KR920_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 233 };
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 234 }
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 235
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 236 #endif //__CHANNEL_PLAN_KR920_H__