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:
Mon Jun 19 16:03:40 2017 -0500
Revision:
82:0f5a742a08cd
Child:
84:29648b580369
mdot-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 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_STRATEGY_H__
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 17 #define __CHANNEL_STRATEGY_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
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 23 namespace lora {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 24
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 25 class ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 26 public:
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 27
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 28 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 29 * Descriptions for channel plans & region information.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 30 * Bits 0-2 represent the plan type (fixed or dynamic)
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 31 * 0b000 cannot be used as plans may line up with old definitions and cause much badness
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 32 * 0b001 fixed channel plans
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 33 * 0b010 dynamic channel plans
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 34 * 0b011 - 0b111 RFU
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 35 * Bits 3-7 represent the specific channel plan/region within the plan type
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 36 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 37 enum PlanType {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 38 FIXED = 0x20,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 39 DYNAMIC = 0x40,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 40 };
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 41
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 42 enum Plan {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 43 EU868_OLD = 0x00,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 44 US915_OLD = 0x01,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 45 AU915_OLD = 0x02,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 46
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 47 US915 = FIXED | 0x00,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 48 AU915 = FIXED | 0x01,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 49
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 50 EU868 = DYNAMIC | 0x00,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 51 IN865 = DYNAMIC | 0x01,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 52 AS923 = DYNAMIC | 0x02,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 53 KR920 = DYNAMIC | 0x03,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 54 AS923_JAPAN = DYNAMIC | 0x04,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 55
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 56 NONE = 0xFF,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 57 };
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 58
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 59 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 60 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 61 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 62 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 63 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 64 ChannelPlan(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 65
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 66 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 67 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 68 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 69 virtual ~ChannelPlan();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 70
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 71 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 72 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 73 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 74 virtual void Init() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 75
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 76 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 77 * Set SxRadio object to be used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 78 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 79 virtual void SetRadio(SxRadio* radio);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 80
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 81 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 82 * Set Settings object
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 83 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 84 virtual void SetSettings(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 85
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 86 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 87 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 88 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 89 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 90 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 91 virtual uint8_t GetNextChannel() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 92
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 93 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 94 * Set the number of channels in the plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 95 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 96 virtual void SetNumberOfChannels(uint8_t channels, bool resize = true);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 97
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 98 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 99 * Get the number of channels in the plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 100 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 101 virtual uint8_t GetNumberOfChannels();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 102
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 103 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 104 * Check if channel is enabled
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 105 * @return true if enabled
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 106 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 107 virtual bool IsChannelEnabled(uint8_t channel);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 108
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 109 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 110 * Set a 16 bit channel mask with offset
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 111 * @param index of mask to set 0:0-15, 1:16-31 ...
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 112 * @param mask 16 bit mask of enabled channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 113 * @return true
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 114 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 115 virtual bool SetChannelMask(uint8_t index, uint16_t mask);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 116
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 117 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 118 * Get the channel mask of currently enabled channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 119 * @return vector containing channel bit masks
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 120 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 121 virtual std::vector<uint16_t> GetChannelMask();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 122
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 123 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 124 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 125 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 126 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 127 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 128 virtual uint8_t AddChannel(int8_t index, Channel channel) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 129
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 130 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 131 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 132 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 133 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 134 virtual Channel GetChannel(int8_t index) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 135
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 136 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 137 * Add a downlink channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 138 * Set to 0 to use the default uplink channel frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 139 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 140 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 141 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 142 virtual uint8_t AddDownlinkChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 143
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 144 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 145 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 146 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 147 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 148 virtual Channel GetDownlinkChannel(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 149
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 150 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 151 * Set number of datarates in ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 152 * @param datarates
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 153 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 154 virtual void SetNumberOfDatarates(uint8_t datarates);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 155
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 156 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 157 * Add a datarate to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 158 * @param index of datarate, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 159 * @param datarate settings to add
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 160 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 161 virtual uint8_t AddDatarate(int8_t index, Datarate datarate);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 162
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 163 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 164 * Get datarate at index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 165 * @return Datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 166 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 167 virtual Datarate GetDatarate(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 168
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 169 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 170 * Get max payload size for current datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 171 * @return size in bytes
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 172 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 173 virtual uint8_t GetMaxPayloadSize();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 174
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 175 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 176 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 177 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 178 * @param window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 179 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 180 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 181 virtual RxWindow GetRxWindow(uint8_t window) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 182
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 183 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 184 * Get current channel to use for transmitting
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 185 * @param channel index of channel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 186 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 187 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 188 virtual uint8_t SetTxChannel(uint8_t channel);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 189
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 190 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 191 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 192 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 193 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 194 virtual uint8_t GetJoinDatarate() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 195
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 196 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 197 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 198 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 199 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 200 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 201 virtual uint8_t CalculateJoinBackoff(uint8_t size) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 202
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 203 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 204 * Get the current datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 205 * @return Datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 206 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 207 virtual Datarate GetTxDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 208
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 209 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 210 * Set the current datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 211 * @param index of datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 212 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 213 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 214 virtual uint8_t SetTxDatarate(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 215
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 216 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 217 * Set the datarate offset used for first receive window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 218 * @param offset
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 219 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 220 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 221 virtual uint8_t SetRx1Offset(uint8_t offset);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 222
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 223 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 224 * Set the frequency for second receive window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 225 * @param freq
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 226 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 227 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 228 virtual uint8_t SetRx2Frequency(uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 229
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 230 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 231 * Set the datarate index used for second receive window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 232 * @param index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 233 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 234 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 235 virtual uint8_t SetRx2DatarateIndex(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 236
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 237 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 238 * Get next channel and set the SxRadio tx config with current settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 239 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 240 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 241 virtual uint8_t SetTxConfig() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 242
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 243 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 244 * Set the SxRadio rx config provided window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 245 * @param window to be opened
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 246 * @param continuous keep window open
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 247 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 248 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 249 virtual uint8_t SetRxConfig(uint8_t window, bool continuous) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 250
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 251 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 252 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 253 * @param sub_band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 254 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 255 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 256 virtual uint8_t SetFrequencySubBand(uint8_t group) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 257
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 258 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 259 * Get frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 260 * @return sub band 0-8 or 0 if not supported
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 261 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 262 virtual uint8_t GetFrequencySubBand();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 263
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 264 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 265 * Reset the ack counter used to lower datarate if ACK's are missed
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 266 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 267 virtual void ResetAckCounter();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 268
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 269 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 270 * Callback for radio to request channel change when frequency hopping
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 271 * @param currentChannel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 272 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 273 virtual void FhssChangeChannel(uint8_t currentChannel);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 274
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 275 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 276 * Callback for ACK timeout event
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 277 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 278 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 279 virtual uint8_t HandleAckTimeout();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 280
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 281 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 282 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 283 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 284 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 285 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 286
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 287 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 288 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 289 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 290 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 291 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 292 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 293 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 294 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 295 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 296
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 297 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 298 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 299 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 300 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 301 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 302 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 303 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 304 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 305 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 306
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 307 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 308 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 309 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 310 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 311 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 312 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 313 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 314 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 315 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 316
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 317 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 318 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 319 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 320 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 321 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 322 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 323 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 324 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 325 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 326
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 327 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 328 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 329 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 330 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 331 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 332 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 333 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 334 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 335 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 336
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 337 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 338 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 339 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 340 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 341 virtual uint8_t ValidateAdrConfiguration() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 342
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 343 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 344 * Check that Rf Frequency is within channel plan range
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 345 * @param freq frequency in Hz
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 346 * @return true if valid frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 347 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 348 virtual bool CheckRfFrequency(uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 349
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 350 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 351 * Flag for ADR
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 352 * @return true if ADR is enable in settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 353 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 354 virtual bool IsAdrEnabled();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 355
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 356 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 357 * Flag if ADR ACK should be sent in next packet
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 358 * @return true when flag should be set
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 359 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 360 virtual bool AdrAckReq();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 361
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 362 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 363 * Increment the ADR counter to track when ADR ACK request should be sent
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 364 * @return current value
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 365 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 366 virtual uint8_t IncAdrCounter();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 367
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 368 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 369 * Reset the ADR counter when valid downlink is received from network server
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 370 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 371 virtual void ResetAdrCounter();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 372
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 373 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 374 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 375 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 376 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 377 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 378 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 379 virtual uint32_t GetTimeOffAir() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 380
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 381 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 382 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 383 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 384 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 385 virtual std::vector<uint32_t> GetChannels() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 386
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 387 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 388 * Get the downlink channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 389 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 390 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 391 virtual std::vector<uint32_t> GetDownlinkChannels();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 392
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 393 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 394 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 395 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 396 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 397 virtual std::vector<uint8_t> GetChannelRanges() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 398
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 399 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 400 * Set the time off air for the given duty band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 401 * @param band index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 402 * @param time off air in ms
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 403 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 404 virtual void SetDutyBandTimeOff(uint8_t band, uint32_t timeoff);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 405
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 406 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 407 * Get the time off air for the given duty band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 408 * @param band index
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 409 * @return time off air in ms
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 410 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 411 virtual uint32_t GetDutyBandTimeOff(uint8_t band);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 412
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 413 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 414 * Get the number of duty bands in the current channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 415 * @return number of bands
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 416 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 417 virtual uint8_t GetNumDutyBands();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 418
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 419 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 420 * Get the duty band index for the given frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 421 * @param freq frequency in Hz
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 422 * @return index of duty band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 423 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 424 virtual int8_t GetDutyBand(uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 425
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 426 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 427 * Add duty band
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 428 * @param index of duty band or -1 to append
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 429 * @param band DutyBand definition
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 430 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 431 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 432 virtual uint8_t AddDutyBand(int8_t index, DutyBand band);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 433
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 434 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 435 * Update duty cycle with current settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 436 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 437 virtual void UpdateDutyCycle(uint8_t bytes);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 438
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 439 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 440 * Update duty cycle with at given frequency and time on air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 441 * @param freq frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 442 * @param time_on_air_ms tx time on air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 443 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 444 virtual void UpdateDutyCycle(uint32_t freq, uint32_t time_on_air_ms);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 445
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 446 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 447 * Get time on air with current settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 448 * @param bytes number of bytes to be sent
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 449 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 450 virtual uint32_t GetTimeOnAir(uint8_t bytes);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 451
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 452 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 453 * Reset the duty timers with the current time off air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 454 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 455 virtual void ResetDutyCycleTimer();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 456
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 457 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 458 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 459 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 460 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 461 virtual void LogRxWindow(uint8_t wnd) = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 462
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 463 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 464 * Indicator of P2P mode
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 465 * @return true if enabled
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 466 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 467 virtual bool P2PEnabled();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 468
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 469 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 470 * Ack timeout for P2P mode
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 471 * @return timeout in ms
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 472 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 473 virtual uint16_t P2PTimeout();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 474
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 475 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 476 * Ack backoff for P2P mode
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 477 * @return backoff in ms
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 478 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 479 virtual uint16_t P2PBackoff();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 480
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 481 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 482 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 483 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 484 virtual void EnableDefaultChannels() = 0;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 485
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 486 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 487 * Callback for radio thread to signal
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 488 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 489 virtual void MacEvent();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 490
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 491 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 492 * Called when MAC layer doesn't know about a command.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 493 * Use to add custom or new mac command handling
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 494 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 495 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 496 virtual uint8_t HandleMacCommand(uint8_t* payload, uint8_t& index);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 497
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 498 virtual void DecrementDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 499 virtual void IncrementDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 500
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 501 virtual std::string GetPlanName();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 502 virtual uint8_t GetPlan();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 503 virtual bool IsPlanFixed();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 504 virtual bool IsPlanDynamic();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 505 static bool IsPlanFixed(uint8_t plan);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 506 static bool IsPlanDynamic(uint8_t plan);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 507 virtual uint32_t GetMinFrequency();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 508 virtual uint32_t GetMaxFrequency();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 509
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 510 virtual uint8_t GetMinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 511 virtual uint8_t GetMaxDatarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 512 virtual uint8_t GetMinDatarateOffset();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 513 virtual uint8_t GetMaxDatarateOffset();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 514
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 515 virtual uint8_t GetMinRx2Datarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 516 virtual uint8_t GetMaxRx2Datarate();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 517 virtual uint8_t GetMaxTxPower();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 518 virtual uint8_t GetMinTxPower();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 519
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 520 virtual uint16_t GetLBT_TimeUs();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 521 virtual void SetLBT_TimeUs(uint16_t us);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 522
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 523 virtual int8_t GetLBT_Threshold();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 524 virtual void SetLBT_Threshold(int8_t rssi);
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 525
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 526 /**
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 527 * Set LBT time and threshold to defaults
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 528 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 529 virtual void DefaultLBT();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 530
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 531 virtual bool ListenBeforeTalk();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 532
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 533 protected:
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 534
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 535 SxRadio* GetRadio(); //!< Get pointer to the SxRadio object or assert if it is null
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 536 Settings* GetSettings(); //!< Get pointer to the settings object or assert if it is null
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 537
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 538 uint8_t _txChannel; //!< Current channel for transmit
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 539 uint8_t _txFrequencySubBand; //!< Current frequency sub band for hybrid operation
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 540
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 541 std::vector<Datarate> _datarates; //!< List of datarates
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 542
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 543 std::vector<Channel> _channels; //!< List of channels for transmit
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 544 std::vector<Channel> _dlChannels; //!< List of channels for receive if changed from default
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 545
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 546 std::vector<DutyBand> _dutyBands; //!< List of duty bands to limit radio time on air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 547
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 548 uint8_t _maxTxPower; //!< Max Tx power for channel Plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 549 uint8_t _minTxPower;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 550
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 551 uint32_t _minFrequency; //!< Minimum Frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 552 uint32_t _maxFrequency; //!< Maximum Frequency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 553
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 554 Channel _beaconChannel; //!< Beacon window settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 555 Channel _beaconRxChannel; //!< Beacon slot rx window settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 556
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 557 uint8_t _minDatarate; //!< Minimum datarate to accept in ADR request
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 558 uint8_t _maxDatarate; //!< Maximum datarate to accept in ADR request
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 559
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 560 uint8_t _minRx2Datarate; //!< Minimum datarate to accept in for Rx2
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 561 uint8_t _maxRx2Datarate; //!< Maximum datarate to accept in for Rx2
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 562 uint8_t _minDatarateOffset; //!< Minimum datarate offset to accept
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 563 uint8_t _maxDatarateOffset; //!< Maximum datarate offset to accept
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 564
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 565 uint32_t _freqUBase125k; //!< Start of 125K uplink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 566 uint32_t _freqUStep125k; //!< Step between 125K uplink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 567 uint32_t _freqUBase500k; //!< Start of 500K uplink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 568 uint32_t _freqUStep500k; //!< Step between 500K uplink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 569 uint32_t _freqDBase500k; //!< Start of 500K downlink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 570 uint32_t _freqDStep500k; //!< Step between 500K downlink channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 571
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 572 uint8_t _numChans; //!< Number of total channels in plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 573 uint8_t _numChans125k; //!< Number of 125K channels in plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 574 uint8_t _numChans500k; //!< Number of 500K channels in plan
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 575
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 576 uint16_t _LBT_TimeUs; //!< Sample time in us for LBT
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 577 int8_t _LBT_Threshold; //!< Threshold in dBm for LBT
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 578
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 579 std::vector<uint16_t> _channelMask; //!< Bit mask for currently enabled channels
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 580
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 581 Timer _dutyCycleTimer; //!< Timer for tracking time-off-air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 582 RtosTimer _txDutyTimer; //!< Event timer for expiration of time-off-air
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 583
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 584 bool _txDutyCyclePending; //!< Flag for pending duty cycle event
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 585
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 586 static void OnTxDutyCycleEvent(const void* arg); //!< Rtos callback for duty cycle event
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 587 void OnTxDutyCycleEventBottom(); //!< Callback for duty cycle event
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 588
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 589 static const uint8_t* TX_POWERS; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 590 static const uint8_t* RADIO_POWERS; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 591 static const uint8_t* MAX_PAYLOAD_SIZE; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 592 static const uint8_t* MAX_PAYLOAD_SIZE_REPEATER; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 593
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 594 uint8_t _plan;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 595 std::string _planName;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 596
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 597 private:
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 598
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 599 SxRadio* _radio; //!< Injected SxRadio dependency
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 600 Settings* _settings; //!< Current settings
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 601 };
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 602 }
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 603
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 604 #endif