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