Bleeding edge development version of the xDot library for mbed 5. This version of the library is not guaranteed to be stable or well tested and should not be used in production or deployment scenarios.

Dependents:   Dot-Examples Dot-AT-Firmware Dot-Examples TEST_FF1705 ... more

The Dot library provides a LoRaWan certified stack for LoRa communication using MultiTech mDot and xDot devices. The stack is compatible with mbed 5.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. Channel plans are included with the 3.x.x Dot Library releases. The following code snippet demonstrates how to create a channel plan and inject it into the stack.

#include "mDot.h"
#include "channel_plans.h"

int main() {
    ChannelPlan* plan = new lora::ChannelPlan_US915();
    assert(plan);
    mDot* dot = mDot::getInstance(plan);
    assert(dot);

    // ...
}

Dot devices must not be deployed with software using a different channel plan than the Dot's default plan! This functionality is for development and testing only!

Multicast Sessions

Multicast sessions and packet rx events in library. When in Class C mode Multicast downlinks can be received. Recieved packets should be filtered on address, counter value will be maintained in the session or can be set explicitly depending on Application support to share Multicast Address, Keys and Counters.

mDot.h

        /**
         * Add a multicast session address and keys
         * Downlink counter is set to 0
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastSession(uint8_t index, uint32_t addr, const uint8_t* nsk, const uint8_t* dsk);
 
        /**
         * Set a multicast session counter
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastDownlinkCounter(uint8_t index, uint32_t count);

mDotEvent.h

The address field was added to PacketRx event.

        virtual void PacketRx(uint8_t port, uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr, lora::DownlinkControl ctrl, uint8_t slot, uint8_t retries, uint32_t address);

The name of the repository can be used to determine which device the stack was compiled for and if it's a development or production-ready build:

A changelog for the Dot library can be found here.

The Dot library version and the version of mbed-os it was compiled against can both be found in the commit message for that revision of the Dot library. Building your application with the same version of mbed-os as what was used to build the Dot library is highly recommended!

The Dot-Examples repository demonstrates how to use the Dot library in a custom application.

The mDot and xDot platform pages have lots of platform specific information and document potential issues, gotchas, etc, and provide instructions for getting started with development. Please take a look at the platform page before starting development as they should answer many questions you will have.

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Fri Nov 09 14:56:50 2018 -0600
Revision:
133:4ca51f965419
Parent:
132:42d19971dfa9
xdot-library revision 3.1.0-57-g8e84ec6 and mbed-os revision mbed-os-5.10.2

Who changed what in which revision?

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