Stable version of the mDot library for mbed 5. This version of the library is suitable for deployment scenarios. See lastest commit message for version of mbed-os library that has been tested against.

Dependents:   mdot_two_way unh-hackathon-example unh-hackathon-example-raw TelitSensorToCloud ... more

Fork of libmDot-dev-mbed5-deprecated by MultiTech

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

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.

FOTA

Full FOTA support is only available with mDot, xDot does not have the required external flash. xDot can use the FOTA example to dynamically join a multicast session only. After joining the multicast session the received Fragmentation packets could be handed to a host MCU for processing and at completion the firmware can be loaded into the xDot using the bootloader and y-modem. See xDot Developer Guide.

  • Add the following code to allow Fota to use the Dot instance

main.cpp

    // Initialize FOTA singleton
    Fota::getInstance(dot);
  • Add fragmentation handling the the PacketRx event

RadioEvent.h

    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, bool dupRx) {
        mDotEvent::PacketRx(port, payload, size, rssi, snr, ctrl, slot, retries, address, dupRx);

#if ACTIVE_EXAMPLE == FOTA_EXAMPLE
        if(port == 200 || port == 201 || port == 202) {
            Fota::getInstance()->processCmd(payload, port, size);
        }
#endif
    }

A definition is needed to enable Fragmentation support on mDot and save fragments to flash. This should not be defined for xDot and will result in a compiler error.

mbed_app.json

{
    "macros": [
        "FOTA=1"
    ]
}

The FOTA implementation has a few differences from the LoRaWAN Protocol

  • Fragmentation Indexing starts at 0
  • McKEKey is 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
  • Start Time is a count-down in seconds to start of session
Committer:
jreiss
Date:
Wed Mar 25 17:06:41 2020 +0000
Revision:
74:8b02b1a9a1b6
Parent:
72:b1e07ec1c30d
Remove old ARMCC archive, only ARMC6 is available.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 1 /** __ ___ ____ _ ______ __ ____ __ ____
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 2 * / |/ /_ __/ / /_(_)__/_ __/__ ____/ / / __/_ _____ / /____ __ _ ___ / _/__ ____
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 3 * / /|_/ / // / / __/ /___// / / -_) __/ _ \ _\ \/ // (_-</ __/ -_) ' \(_-< _/ // _ \/ __/ __
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 4 * /_/ /_/\_,_/_/\__/_/ /_/ \__/\__/_//_/ /___/\_, /___/\__/\__/_/_/_/___/ /___/_//_/\__/ /_/
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 5 * Copyright (C) 2015 by Multi-Tech Systems /___/
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 6 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 7 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 8 * @author Jason Reiss
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 9 * @date 10-31-2015
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 10 * @brief lora::ChannelPlan provides an interface for LoRaWAN channel schemes
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 11 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 12 * @details
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 13 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 14 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 15
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 16 #ifndef __CHANNEL_PLAN_US915_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 17 #define __CHANNEL_PLAN_US915_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 18
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 19 #include "Lora.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 20 #include "SxRadio.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 21 #include "ChannelPlan.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 22 #include <vector>
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 23
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 24 namespace lora {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 25
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 26 const uint8_t US915_125K_NUM_CHANS = 64; //!< Number of 125k channels in US915 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 27 const uint8_t US915_500K_NUM_CHANS = 8; //!< Number of 500k channels in US915 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 28
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 29 const uint32_t US915_125K_FREQ_BASE = 902300000; //!< Frequency base for 125k US915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 30 const uint32_t US915_125K_FREQ_STEP = 200000; //!< Frequency step for 125k US915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 31
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 32 const uint32_t US915_500K_FREQ_BASE = 903000000; //!< Frequency base for 500k US915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 33 const uint32_t US915_500K_FREQ_STEP = 1600000; //!< Frequency step for 500k US915 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 34
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 35 const uint32_t US915_500K_DBASE = 923300000; //!< Frequency base for 500k US915 downlink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 36 const uint32_t US915_500K_DSTEP = 600000; //!< Frequency step for 500k US915 downlink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 37
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 38 const uint32_t US915_FREQ_MIN = 902000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 39 const uint32_t US915_FREQ_MAX = 928000000;
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 40
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 41 const uint8_t US915_MIN_DATARATE = (uint8_t) DR_0; //!< Minimum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 42 const uint8_t US915_MAX_DATARATE = (uint8_t) DR_4; //!< Maximum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 43
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 44 const uint8_t US915_MIN_DATARATE_OFFSET = (uint8_t) 0; //!< Minimum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 45 const uint8_t US915_MAX_DATARATE_OFFSET = (uint8_t) 3; //!< Maximum transmit datarate for US915
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 46
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 47 const uint8_t US915_BEACON_DR = DR_8; //!< Default beacon datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 48 const uint32_t US915_BEACON_FREQ_BASE = 923300000U; //!< Base beacon broadcast frequency
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 49 const uint32_t US915_BEACON_FREQ_STEP = 600000U; //!< Step size for beacon frequencies
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 50 const uint8_t US915_BEACON_CHANNELS = 8U; //!< Number of beacon channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 51
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 52 class ChannelPlan_US915 : public lora::ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 53 public:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 54
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 55 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 56 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 57 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 58 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 59 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 60 ChannelPlan_US915();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 61 ChannelPlan_US915(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 62 ChannelPlan_US915(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 63
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 64 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 65 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 66 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 67 virtual ~ChannelPlan_US915();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 68
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 69 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 70 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 71 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 72 virtual void Init();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 73
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 74 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 75 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 76 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 77 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 78 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 79 virtual uint8_t GetNextChannel();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 80
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 81 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 82 * Set the number of channels in the plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 83 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 84 virtual void SetNumberOfChannels(uint8_t channels, bool resize = true);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 85
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 86 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 87 * Check if channel is enabled
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 88 * @return true if enabled
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 89 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 90 virtual bool IsChannelEnabled(uint8_t channel);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 91
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 92
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 93 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 94 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 95 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 96 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 97 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 98 virtual uint8_t AddChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 99
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 100 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 101 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 102 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 103 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 104 virtual Channel GetChannel(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 105
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 106 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 107 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 108 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 109 * @param window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 110 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 111 */
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 112 virtual RxWindow GetRxWindow(uint8_t window, int8_t id = 0);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 113
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 114 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 115 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 116 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 117 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 118 virtual uint8_t GetJoinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 119
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 120 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 121 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 122 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 123 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 124 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 125 virtual uint8_t CalculateJoinBackoff(uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 126
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 127 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 128 * Set the datarate offset used for first receive window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 129 * @param offset
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 130 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 131 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 132 virtual uint8_t SetRx1Offset(uint8_t offset);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 133
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 134 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 135 * Set the frequency for second receive window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 136 * @param freq
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 137 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 138 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 139 virtual uint8_t SetRx2Frequency(uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 140
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 141 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 142 * Set the datarate index used for second receive window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 143 * @param index
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 144 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 145 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 146 virtual uint8_t SetRx2DatarateIndex(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 147
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 148 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 149 * Get next channel and set the SxRadio tx config with current settings
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 150 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 151 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 152 virtual uint8_t SetTxConfig();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 153
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 154 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 155 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 156 * @param sub_band
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 157 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 158 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 159 virtual uint8_t SetFrequencySubBand(uint8_t sub_band);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 160
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 161 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 162 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 163 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 164 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 165 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 166
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 167 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 168 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 169 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 170 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 171 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 172 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 173 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 174 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 175 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 176
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 177 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 178 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 179 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 180 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 181 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 182 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 183 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 184 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 185 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 186
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 187 /**
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 188 * Callback to for downlink channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 189 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 190 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 191 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 192 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 193 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 194 */
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 195 virtual uint8_t HandleDownlinkChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 196
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 197 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 198 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 199 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 200 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 201 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 202 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 203 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 204 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 205 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 206
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 207 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 208 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 209 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 210 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 211 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 212 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 213 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 214 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 215 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 216
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 217 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 218 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 219 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 220 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 221 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 222 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 223 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 224 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 225 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 226
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 227 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 228 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 229 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 230 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 231 virtual uint8_t ValidateAdrConfiguration();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 232
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 233 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 234 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 235 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 236 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 237 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 238 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 239 virtual uint32_t GetTimeOffAir();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 240
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 241 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 242 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 243 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 244 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 245 virtual std::vector<uint32_t> GetChannels();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 246
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 247 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 248 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 249 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 250 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 251 virtual std::vector<uint8_t> GetChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 252
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 253
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 254 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 255 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 256 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 257 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 258 virtual void LogRxWindow(uint8_t wnd);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 259
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 260 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 261 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 262 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 263 virtual void EnableDefaultChannels();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 264
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 265 virtual uint8_t GetMinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 266
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 267 virtual uint8_t GetMaxDatarate();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 268
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 269 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 270 * Check if this packet is a beacon and if so extract parameters needed
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 271 * @param payload of potential beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 272 * @param size of the packet
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 273 * @param [out] data extracted from the beacon if this packet was indeed a beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 274 * @return true if this packet is beacon, false if not
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 275 */
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 276 virtual uint8_t DecodeBeacon(const uint8_t* payload,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 277 size_t size,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 278 BeaconData_t& data);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 279 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 280 * Update class B beacon and ping slot settings if frequency hopping enabled
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 281 * @param time received in the last beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 282 * @param period of the beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 283 * @param devAddr of this end device
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 284 */
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 285 virtual void FrequencyHop(uint32_t time, uint32_t period, uint32_t devAddr);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 286
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 287 protected:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 288
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 289 static const uint8_t US915_TX_POWERS[11]; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 290 static const uint8_t US915_RADIO_POWERS[21]; //!< List of calibrated tx powers
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 291 static const uint8_t US915_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 292 static const uint8_t US915_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 293
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 294 typedef struct __attribute__((packed)) {
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 295 uint8_t RFU1[5];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 296 uint8_t Time[4];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 297 uint8_t CRC1[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 298 uint8_t GwSpecific[7];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 299 uint8_t RFU2[3];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 300 uint8_t CRC2[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 301 } BCNPayload;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 302 };
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 303 }
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 304
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 305 #endif // __CHANNEL_PLAN_US915_H__