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 65:acc0468b9aec 1 /**********************************************************************
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 2 * COPYRIGHT 2015 MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 3 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 4 * Redistribution and use in source and binary forms, with or without modification,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 5 * are permitted provided that the following conditions are met:
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 6 * 1. Redistributions of source code must retain the above copyright notice,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 7 * this list of conditions and the following disclaimer.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 8 * 2. Redistributions in binary form must reproduce the above copyright notice,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 9 * this list of conditions and the following disclaimer in the documentation
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 10 * and/or other materials provided with the distribution.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 11 * 3. Neither the name of MULTI-TECH SYSTEMS, INC. nor the names of its contributors
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 12 * may be used to endorse or promote products derived from this software
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 13 * without specific prior written permission.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 14 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 25 *
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 26 ******************************************************************************
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 27 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 28 * @author Jason Reiss
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 29 * @date 10-31-2015
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 30 * @brief lora::ChannelPlan provides an interface for LoRaWAN channel schemes
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 31 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 32 * @details
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 33 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 34 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 35
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 36 #ifndef __CHANNEL_PLAN_AS923_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 37 #define __CHANNEL_PLAN_AS923_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 38
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 39 #include "Lora.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 40 #include "SxRadio.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 41 #include <vector>
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 42 #include "ChannelPlan.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 43
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 44 namespace lora {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 45
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 46 const uint8_t AS923_125K_NUM_CHANS = 16; //!< Number of 125k channels in AS923 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 47 const uint8_t AS923_DEFAULT_NUM_CHANS = 2; //!< Number of default channels in AS923 channel plan
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 48 const uint32_t AS923_125K_FREQ_BASE = 923200000; //!< Frequency base for 125k AS923 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 49 const uint32_t AS923_125K_FREQ_STEP = 200000; //!< Frequency step for 125k AS923 uplink channels
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 50 const uint32_t AS923_RX2_FREQ = 923200000; //!< Frequency default for second rx window in AS923
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 51 const uint8_t AS923_BEACON_DR = DR_3; //!< Default beacon datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 52 const uint32_t AS923_BEACON_FREQ = 923400000U; //!< Default beacon broadcast frequency
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 53
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 54 class ChannelPlan_AS923: public lora::ChannelPlan {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 55 public:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 56 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 57 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 58 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 59 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 60 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 61 ChannelPlan_AS923();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 62 ChannelPlan_AS923(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 63 ChannelPlan_AS923(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 64
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 65 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 66 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 67 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 68 virtual ~ChannelPlan_AS923();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 69
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 70 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 71 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 72 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 73 virtual void Init();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 74
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 75 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 76 * Get the next channel to use to transmit
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 77 * @return LORA_OK if channel was found
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 78 * @return LORA_NO_CHANS_ENABLED
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 79 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 80 virtual uint8_t GetNextChannel();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 81
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 82 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 83 * Add a channel to the ChannelPlan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 84 * @param index of channel, use -1 to add to end
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 85 * @param channel settings to add
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 86 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 87 virtual uint8_t AddChannel(int8_t index, Channel channel);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 88
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 89 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 90 * Get channel at index
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 91 * @return Channel
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 92 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 93 virtual Channel GetChannel(int8_t index);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 94
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 95 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 96 * Get rx window settings for requested window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 97 * RX_1, RX_2, RX_BEACON, RX_SLOT
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 98 * @param window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 99 * @return RxWindow
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 100 */
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 101 virtual RxWindow GetRxWindow(uint8_t window, int8_t id = -1);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 102
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 103 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 104 * Get datarate to use on the join request
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 105 * @return datarate index
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 106 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 107 virtual uint8_t GetJoinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 108
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 109 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 110 * Calculate the next time a join request is possible
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 111 * @param size of join frame
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 112 * @returns LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 113 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 114 virtual uint8_t CalculateJoinBackoff(uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 115
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 116 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 117 * Get next channel and set the SxRadio tx config with current settings
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 118 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 119 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 120 virtual uint8_t SetTxConfig();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 121
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 122
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 123 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 124 * Set frequency sub band if supported by plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 125 * @param sub_band
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 126 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 127 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 128 virtual uint8_t SetFrequencySubBand(uint8_t sub_band);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 129
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 130 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 131 * Callback for Join Accept packet to load optional channels
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 132 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 133 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 134 virtual uint8_t HandleJoinAccept(const uint8_t* buffer, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 135
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 136 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 137 * Callback to for rx parameter setup ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 138 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 139 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 140 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 141 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 142 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 143 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 144 virtual uint8_t HandleRxParamSetup(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 145
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 146 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 147 * Callback to for new channel ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 148 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 149 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 150 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 151 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 152 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 153 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 154 virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 155
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 156 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 157 * Callback to for ping slot channel request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 158 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 159 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 160 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 161 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 162 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 163 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 164 virtual uint8_t HandlePingSlotChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 165
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 166 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 167 * Callback to for beacon frequency request ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 168 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 169 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 170 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 171 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 172 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 173 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 174 virtual uint8_t HandleBeaconFrequencyReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 175
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 176 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 177 * Callback to for adaptive datarate ServerCommand
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 178 * @param payload packet data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 179 * @param index of start of command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 180 * @param size number of bytes in command buffer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 181 * @param[out] status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 182 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 183 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 184 virtual uint8_t HandleAdrCommand(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 185
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 186 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 187 * Validate the configuration after multiple ADR commands have been applied
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 188 * @return status to be returned in MoteCommand answer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 189 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 190 virtual uint8_t ValidateAdrConfiguration();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 191
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 192 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 193 * Update duty cycle with at given frequency and time on air
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 194 * @param freq frequency
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 195 * @param time_on_air_ms tx time on air
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 196 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 197 virtual void UpdateDutyCycle(uint32_t freq, uint32_t time_on_air_ms);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 198
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 199 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 200 * Get the time the radio must be off air to comply with regulations
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 201 * Time to wait may be dependent on duty-cycle restrictions per channel
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 202 * Or duty-cycle of join requests if OTAA is being attempted
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 203 * @return ms of time to wait for next tx opportunity
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 204 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 205 virtual uint32_t GetTimeOffAir();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 206
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 207 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 208 * Get the channels in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 209 * @return channel frequencies
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 210 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 211 virtual std::vector<uint32_t> GetChannels();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 212
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 213 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 214 * Get the channel datarate ranges in use by current channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 215 * @return channel datarate ranges
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 216 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 217 virtual std::vector<uint8_t> GetChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 218
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 219 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 220 * Print log message for given rx window
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 221 * @param wnd 1 or 2
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 222 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 223 virtual void LogRxWindow(uint8_t wnd);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 224
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 225 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 226 * Enable the default channels of the channel plan
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 227 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 228 virtual void EnableDefaultChannels();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 229
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 230 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 231 * Called when MAC layer doesn't know about a command.
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 232 * Use to add custom or new mac command handling
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 233 * @return LORA_OK
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 234 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 235 virtual uint8_t HandleMacCommand(uint8_t* payload, uint8_t& index);
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 236
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 237 /**
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 238 * Get max payload size for current datarate
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 239 * @return size in bytes
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 240 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 241 virtual uint8_t GetMaxPayloadSize();
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 242
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 243 /**
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 244 * Get max payload size for given datarate
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 245 * @return size in bytes
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 246 */
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 247 virtual uint8_t GetMaxPayloadSize(uint8_t dr) { return ChannelPlan::GetMaxPayloadSize(dr); }
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 248
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 249 /**
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 250 * Decrements the datarate based on TxDwellTime
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 251 */
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 252 virtual void DecrementDatarate();
Jenkins@KEILDM1.dc.multitech.prv 64:64982192a2af 253
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 254 /**
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 255 * Check if this packet is a beacon and if so extract parameters needed
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 256 * @param payload of potential beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 257 * @param size of the packet
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 258 * @param [out] data extracted from the beacon if this packet was indeed a beacon
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 259 * @return true if this packet is beacon, false if not
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 260 */
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 261 virtual uint8_t DecodeBeacon(const uint8_t* payload,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 262 size_t size,
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 263 BeaconData_t& data);
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 264
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 265
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 266 virtual uint8_t GetMinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 267
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 268 protected:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 269
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 270 static const uint8_t AS923_TX_POWERS[8]; //!< List of available tx powers
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 271 static const uint8_t AS923_RADIO_POWERS[21]; //!< List of calibrated tx powers
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 272 static const uint8_t AS923_MAX_PAYLOAD_SIZE[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 273 static const uint8_t AS923_MAX_PAYLOAD_SIZE_400[]; //!< List of max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 274 static const uint8_t AS923_MAX_PAYLOAD_SIZE_REPEATER[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 275 static const uint8_t AS923_MAX_PAYLOAD_SIZE_REPEATER_400[]; //!< List of repeater compatible max payload sizes for each datarate
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 276 static const uint8_t MAX_ERP_VALUES[]; //!< Lookup table for Max EIRP (dBm) codes
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 277 typedef struct __attribute__((packed)) {
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 278 uint8_t RFU[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 279 uint8_t Time[4];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 280 uint8_t CRC1[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 281 uint8_t GwSpecific[7];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 282 uint8_t CRC2[2];
Jenkins@KEILDM1.dc.multitech.prv 65:acc0468b9aec 283 } BCNPayload;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 284 };
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 285 }
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 286
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 287 #endif //__CHANNEL_PLAN_AS923_H__