Stable version of the xDot library for mbed 5. This version of the library is suitable for deployment scenarios.

Dependents:   Dot-Examples XDOT-Devicewise Dot-Examples-delujoc Dot-Examples_receive ... more

Fork of libxDot-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

examples/src/fota_example.cpp

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

examples/inc/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
    }

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:08:50 2020 +0000
Revision:
27:fd99405121d8
Parent:
25:3101c522ae11
Remove old ARMCC archive, only ARMC6 is available

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1 /**********************************************************************
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 2 * COPYRIGHT 2015 MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 3 *
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 4 * Redistribution and use in source and binary forms, with or without modification,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 5 * are permitted provided that the following conditions are met:
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 6 * 1. Redistributions of source code must retain the above copyright notice,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 7 * this list of conditions and the following disclaimer.
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 8 * 2. Redistributions in binary form must reproduce the above copyright notice,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 9 * this list of conditions and the following disclaimer in the documentation
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 10 * and/or other materials provided with the distribution.
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 11 * 3. Neither the name of MULTI-TECH SYSTEMS, INC. nor the names of its contributors
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 12 * may be used to endorse or promote products derived from this software
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 13 * without specific prior written permission.
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 14 *
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 25 *
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 26 ******************************************************************************
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 27 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 28
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 29 #ifndef MDOT_H
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 30 #define MDOT_H
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 31
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 32 #include "mbed.h"
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 33 #include "rtos.h"
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 34 #include "Mote.h"
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 35 #include <vector>
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 36 #include <map>
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 37 #include <string>
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 38
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 39 class mDotEvent;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 40 class LoRaConfig;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 41
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 42
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 43 class mDot {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 44 friend class mDotEvent;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 45
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 46 private:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 47
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 48 mDot(lora::ChannelPlan* plan);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 49 ~mDot();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 50
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 51 void initLora();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 52
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 53 void setLastError(const std::string& str);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 54
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 55 static bool validateBaudRate(const uint32_t& baud);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 56 static bool validateFrequencySubBand(const uint8_t& band);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 57 bool validateDataRate(const uint8_t& dr);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 58
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 59 int32_t joinBase(const uint32_t& retries);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 60 int32_t sendBase(const std::vector<uint8_t>& data, const bool& confirmed = false, const bool& blocking = true, const bool& highBw = false);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 61 void waitForPacket();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 62 void waitForLinkCheck();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 63
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 64 mDot(const mDot&);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 65 mDot& operator=(const mDot&);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 66
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 67 uint32_t RTC_ReadBackupRegister(uint32_t RTC_BKP_DR);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 68 void RTC_WriteBackupRegister(uint32_t RTC_BKP_DR, uint32_t Data);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 69
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 70 void RTC_DisableWakeupTimer();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 71 void RTC_EnableWakeupTimer();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 72
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 73 void enterStopMode(const uint32_t& interval, const uint8_t& wakeup_mode = RTC_ALARM);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 74 void enterStandbyMode(const uint32_t& interval, const uint8_t& wakeup_mode = RTC_ALARM);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 75
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 76 static mDot* _instance;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 77
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 78 lora::Mote* _mote;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 79 LoRaConfig* _config;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 80 lora::Settings _settings;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 81 mDotEvent* _events;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 82
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 83 std::string _last_error;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 84 static const uint32_t _baud_rates[];
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 85
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 86 uint8_t _linkFailCount;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 87 uint8_t _class;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 88 InterruptIn* _wakeup;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 89 PinName _wakeup_pin;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 90
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 91 typedef enum {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 92 OFF,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 93 ON,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 94 BLINK,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 95 } state;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 96
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 97 public:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 98
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 99 #if defined(TARGET_MTS_MDOT_F411RE)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 100 typedef enum {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 101 FM_APPEND = (1 << 0),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 102 FM_TRUNC = (1 << 1),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 103 FM_CREAT = (1 << 2),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 104 FM_RDONLY = (1 << 3),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 105 FM_WRONLY = (1 << 4),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 106 FM_RDWR = (FM_RDONLY | FM_WRONLY),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 107 FM_DIRECT = (1 << 5)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 108 } FileMode;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 109 #endif /* TARGET_MTS_MDOT_F411RE */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 110
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 111 typedef enum {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 112 MDOT_OK = 0,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 113 MDOT_INVALID_PARAM = -1,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 114 MDOT_TX_ERROR = -2,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 115 MDOT_RX_ERROR = -3,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 116 MDOT_JOIN_ERROR = -4,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 117 MDOT_TIMEOUT = -5,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 118 MDOT_NOT_JOINED = -6,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 119 MDOT_ENCRYPTION_DISABLED = -7,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 120 MDOT_NO_FREE_CHAN = -8,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 121 MDOT_TEST_MODE = -9,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 122 MDOT_NO_ENABLED_CHAN = -10,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 123 MDOT_AGGREGATED_DUTY_CYCLE = -11,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 124 MDOT_MAX_PAYLOAD_EXCEEDED = -12,
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 125 MDOT_LBT_CHANNEL_BUSY = -13,
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 126 MDOT_NOT_IDLE = -14,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 127 MDOT_ERROR = -1024,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 128 } mdot_ret_code;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 129
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 130 enum JoinMode {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 131 MANUAL = 0,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 132 OTA,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 133 AUTO_OTA,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 134 PEER_TO_PEER
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 135 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 136
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 137 enum Mode {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 138 COMMAND_MODE,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 139 SERIAL_MODE
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 140 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 141
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 142 enum RX_Output {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 143 HEXADECIMAL,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 144 BINARY,
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 145 EXTENDED,
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 146 EXTENDED_HEX
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 147 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 148
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 149 enum DataRates {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 150 DR0,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 151 DR1,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 152 DR2,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 153 DR3,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 154 DR4,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 155 DR5,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 156 DR6,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 157 DR7,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 158 DR8,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 159 DR9,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 160 DR10,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 161 DR11,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 162 DR12,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 163 DR13,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 164 DR14,
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 165 DR15
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 166 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 167
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 168 enum FrequencySubBands {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 169 FSB_ALL,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 170 FSB_1,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 171 FSB_2,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 172 FSB_3,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 173 FSB_4,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 174 FSB_5,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 175 FSB_6,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 176 FSB_7,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 177 FSB_8
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 178 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 179
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 180 enum wakeup_mode {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 181 RTC_ALARM,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 182 INTERRUPT,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 183 RTC_ALARM_OR_INTERRUPT
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 184 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 185
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 186 enum UserBackupRegs {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 187 UBR0,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 188 UBR1,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 189 UBR2,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 190 UBR3,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 191 UBR4,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 192 UBR5,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 193 UBR6,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 194 UBR7,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 195 UBR8,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 196 UBR9
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 197 #if defined (TARGET_XDOT_L151CC)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 198 ,UBR10,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 199 UBR11,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 200 UBR12,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 201 UBR13,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 202 UBR14,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 203 UBR15,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 204 UBR16,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 205 UBR17,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 206 UBR18,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 207 UBR19,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 208 UBR20,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 209 UBR21
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 210 #endif /* TARGET_XDOT_L151CC */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 211 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 212
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 213 #if defined(TARGET_MTS_MDOT_F411RE)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 214 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 215 int16_t fd;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 216 char name[33];
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 217 uint32_t size;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 218 } mdot_file;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 219 #endif /* TARGET_MTS_MDOT_F411RE */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 220
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 221 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 222 uint32_t Up;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 223 uint32_t Down;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 224 uint32_t Joins;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 225 uint32_t JoinFails;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 226 uint32_t MissedAcks;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 227 uint32_t CRCErrors;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 228 } mdot_stats;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 229
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 230 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 231 int16_t last;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 232 int16_t min;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 233 int16_t max;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 234 int16_t avg;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 235 } rssi_stats;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 236
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 237 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 238 int16_t last;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 239 int16_t min;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 240 int16_t max;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 241 int16_t avg;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 242 } snr_stats;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 243
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 244 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 245 bool status;
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 246 uint8_t dBm;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 247 uint32_t gateways;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 248 std::vector<uint8_t> payload;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 249 } link_check;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 250
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 251 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 252 int32_t status;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 253 int16_t rssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 254 int16_t snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 255 } ping_response;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 256
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 257 static std::string JoinModeStr(uint8_t mode);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 258 static std::string ModeStr(uint8_t mode);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 259 static std::string RxOutputStr(uint8_t format);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 260 static std::string DataRateStr(uint8_t rate);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 261 static std::string FrequencyBandStr(uint8_t band);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 262 static std::string FrequencySubBandStr(uint8_t band);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 263
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 264 #if defined(TARGET_MTS_MDOT_F411RE)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 265 uint32_t UserRegisters[10];
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 266 #else
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 267 uint32_t UserRegisters[22];
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 268 #endif /* TARGET_MTS_MDOT_F411RE */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 269
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 270 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 271 * Get a handle to the singleton object
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 272 * @param plan the channel plan to use
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 273 * @returns pointer to mDot object
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 274 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 275 static mDot* getInstance(lora::ChannelPlan* plan);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 276
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 277 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 278 * Can only be used after a dot has
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 279 * configured with a plan
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 280 * @returns pointer to mDot object
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 281 */
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 282 static mDot* getInstance();
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 283
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 284 void setEvents(mDotEvent* events);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 285
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 286 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 287 *
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 288 * Get library version information
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 289 * @returns string containing library version information
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 290 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 291 std::string getId();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 292
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 293 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 294 * Get MTS LoRa version information
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 295 * @returns string containing MTS LoRa version information
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 296 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 297 std::string getMtsLoraId();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 298
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 299
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 300 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 301 * MAC version
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 302 *
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 303 * @return string containing version information of supported LoRaWAN MAC Version
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 304 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 305 const char* getMACVersion();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 306
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 307 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 308 * Perform a soft reset of the system
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 309 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 310 void resetCpu();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 311
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 312 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 313 * Reset config to factory default
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 314 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 315 void resetConfig();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 316
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 317 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 318 * Save config data to non volatile memory
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 319 * @returns true if success, false if failure
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 320 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 321 bool saveConfig();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 322
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 323 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 324 * Set the log level for the library
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 325 * options are:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 326 * NONE_LEVEL - logging is off at this level
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 327 * FATAL_LEVEL - only critical errors will be reported
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 328 * ERROR_LEVEL
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 329 * WARNING_LEVEL
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 330 * INFO_LEVEL
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 331 * DEBUG_LEVEL
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 332 * TRACE_LEVEL - every detail will be reported
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 333 * @param level the level to log at
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 334 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 335 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 336 int32_t setLogLevel(const uint8_t& level);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 337
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 338 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 339 * Get the current log level for the library
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 340 * @returns current log level
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 341 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 342 uint8_t getLogLevel();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 343
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 344 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 345 * Seed pseudo RNG in LoRaMac layer, uses random value from radio RSSI reading by default
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 346 * @param seed for RNG
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 347 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 348 void seedRandom(uint32_t seed);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 349
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 350 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 351 * @returns true if MAC command answers are ready to be sent
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 352 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 353 bool hasMacCommands();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 354
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 355
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 356 uint8_t setChannelPlan(lora::ChannelPlan* plan);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 357
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 358 lora::Settings* getSettings();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 359
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 360 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 361 * Returns boolean indicative of start-up from standby mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 362 * @returns true if dot woke from standby
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 363 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 364 bool getStandbyFlag();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 365
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 366 std::vector<uint16_t> getChannelMask();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 367
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 368 int32_t setChannelMask(uint8_t offset, uint16_t mask);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 369
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 370 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 371 * Add a channel
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 372 * @returns MDOT_OK
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 373 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 374 int32_t addChannel(uint8_t index, uint32_t frequency, uint8_t datarateRange);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 375
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 376 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 377 * Add a downlink channel
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 378 * @returns MDOT_OK
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 379 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 380 int32_t addDownlinkChannel(uint8_t index, uint32_t frequency);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 381
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 382 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 383 * Get list of channel frequencies currently in use
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 384 * @returns vector of channels currently in use
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 385 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 386 std::vector<uint32_t> getChannels();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 387
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 388 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 389 * Get list of downlink channel frequencies currently in use
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 390 * @returns vector of channels currently in use
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 391 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 392 std::vector<uint32_t> getDownlinkChannels();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 393
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 394 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 395 * Get list of channel datarate ranges currently in use
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 396 * @returns vector of datarate ranges currently in use
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 397 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 398 std::vector<uint8_t> getChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 399
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 400 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 401 * Get list of channel frequencies in config file to be used as session defaults
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 402 * @returns vector of channels in config file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 403 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 404 std::vector<uint32_t> getConfigChannels();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 405
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 406 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 407 * Get list of channel datarate ranges in config file to be used as session defaults
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 408 * @returns vector of datarate ranges in config file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 409 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 410 std::vector<uint8_t> getConfigChannelRanges();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 411
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 412 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 413 * Get default frequency band
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 414 * @returns frequency band the device was manufactured for
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 415 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 416 uint8_t getDefaultFrequencyBand();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 417
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 418 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 419 * Set frequency sub band
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 420 * only applicable if frequency band is set for United States (FB_915)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 421 * sub band 0 will allow the radio to use all 64 channels
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 422 * sub band 1 - 8 will allow the radio to use the 8 channels in that sub band
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 423 * for use with Conduit gateway and MTAC_LORA, use sub bands 1 - 8, not sub band 0
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 424 * @param band the sub band to use (0 - 8)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 425 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 426 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 427 int32_t setFrequencySubBand(const uint8_t& band);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 428
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 429 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 430 * Get frequency sub band
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 431 * @returns frequency sub band currently in use
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 432 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 433 uint8_t getFrequencySubBand();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 434
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 435 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 436 * Get frequency band
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 437 * @returns frequency band (channel plan) currently in use
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 438 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 439 uint8_t getFrequencyBand();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 440
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 441 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 442 * Get channel plan name
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 443 * @returns name of channel plan currently in use
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 444 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 445 std::string getChannelPlanName();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 446
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 447 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 448 * Get the datarate currently in use within the MAC layer
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 449 * returns 0-15
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 450 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 451 uint8_t getSessionDataRate();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 452
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 453
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 454 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 455 * Get the current max EIRP used in the channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 456 * May be changed by the network server
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 457 * returns 0-36
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 458 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 459 uint8_t getSessionMaxEIRP();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 460
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 461 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 462 * Set the current max EIRP used in the channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 463 * May be changed by the network server
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 464 * accepts 0-36
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 465 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 466 void setSessionMaxEIRP(uint8_t max);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 467
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 468 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 469 * Get the current downlink dwell time used in the channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 470 * May be changed by the network server
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 471 * returns 0-1
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 472 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 473 uint8_t getSessionDownlinkDwelltime();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 474
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 475 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 476 * Set the current downlink dwell time used in the channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 477 * May be changed by the network server
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 478 * accepts 0-1
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 479 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 480 void setSessionDownlinkDwelltime(uint8_t dwell);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 481
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 482 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 483 * Get the current uplink dwell time used in the channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 484 * May be changed by the network server
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 485 * returns 0-1
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 486 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 487 uint8_t getSessionUplinkDwelltime();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 488
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 489 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 490 * Set the current uplink dwell time used in the channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 491 * May be changed by the network server
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 492 * accepts 0-1
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 493 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 494 void setSessionUplinkDwelltime(uint8_t dwell);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 495
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 496 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 497 * Set the current downlink dwell time used in the channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 498 * May be changed by the network server
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 499 * accepts 0-1
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 500 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 501 uint32_t getListenBeforeTalkTime(uint8_t ms);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 502
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 503 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 504 * Set the current downlink dwell time used in the channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 505 * May be changed by the network server
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 506 * accepts 0-1
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 507 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 508 void setListenBeforeTalkTime(uint32_t ms);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 509
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 510 /**
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 511 * Set public network mode
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 512 * 0:PRIVATE_MTS, 1:PUBLIC_LORAWAN, 2:PRIVATE_LORAWAN
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 513 * PRIVATE_MTS - Sync Word 0x12, US/AU Downlink frequencies per Frequency Sub Band
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 514 * PUBLIC_LORAWAN - Sync Word 0x34
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 515 * PRIVATE_LORAWAN - Sync Word 0x12
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 516 *
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 517 * The default Join Delay is 5 seconds
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 518 * The default Join Delay for PRIVATE_MTS was 1 second in the previous release
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 519 * The Join Delay must be changed independently of Public Network setting
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 520 *
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 521 * @see lora::NetworkType
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 522 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 523 */
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 524 int32_t setPublicNetwork(const uint8_t& val);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 525
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 526 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 527 * Get public network mode
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 528 *
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 529 * The default Join Delay is 5 seconds
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 530 * The default Join Delay for PRIVATE_MTS was 1 second in the previous release
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 531 * The Join Delay must be changed independently of Public Network setting
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 532 *
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 533 * @see lora:NetworkType
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 534 * @returns 0:PRIVATE_MTS, 1:PUBLIC_LORAWAN, 2:PRIVATE_LORAWAN
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 535 */
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 536 uint8_t getPublicNetwork();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 537
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 538 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 539 * Get the device ID
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 540 * @returns vector containing the device ID (size 8)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 541 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 542 std::vector<uint8_t> getDeviceId();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 543
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 544 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 545 * Get the device port to be used for lora application data (1-223)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 546 * @returns port
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 547 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 548 uint8_t getAppPort();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 549
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 550 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 551 * Set the device port to be used for lora application data (1-223)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 552 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 553 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 554 int32_t setAppPort(uint8_t port);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 555
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 556 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 557 * Set the device class A, B or C
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 558 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 559 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 560 int32_t setClass(std::string newClass);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 561
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 562 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 563 * Get the device class A, B or C
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 564 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 565 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 566 std::string getClass();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 567
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 568 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 569 * Get the max packet length with current settings
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 570 * @returns max packet length
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 571 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 572 uint8_t getMaxPacketLength();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 573
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 574 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 575 * Set network address
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 576 * for use with MANUAL network join mode, will be assigned in OTA & AUTO_OTA modes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 577 * @param addr a vector of 4 bytes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 578 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 579 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 580 int32_t setNetworkAddress(const std::vector<uint8_t>& addr);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 581
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 582 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 583 * Get network address
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 584 * @returns vector containing network address (size 4)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 585 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 586 std::vector<uint8_t> getNetworkAddress();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 587
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 588 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 589 * Set network session key
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 590 * for use with MANUAL network join mode, will be assigned in OTA & AUTO_OTA modes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 591 * @param key a vector of 16 bytes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 592 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 593 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 594 int32_t setNetworkSessionKey(const std::vector<uint8_t>& key);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 595
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 596 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 597 * Get network session key
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 598 * @returns vector containing network session key (size 16)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 599 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 600 std::vector<uint8_t> getNetworkSessionKey();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 601
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 602 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 603 * Set data session key
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 604 * for use with MANUAL network join mode, will be assigned in OTA & AUTO_OTA modes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 605 * @param key a vector of 16 bytes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 606 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 607 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 608 int32_t setDataSessionKey(const std::vector<uint8_t>& key);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 609
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 610 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 611 * Get data session key
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 612 * @returns vector containing data session key (size 16)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 613 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 614 std::vector<uint8_t> getDataSessionKey();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 615
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 616 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 617 * Set network name
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 618 * for use with OTA & AUTO_OTA network join modes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 619 * generates network ID (crc64 of name) automatically
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 620 * @param name a string of of at least 8 bytes and no more than 128 bytes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 621 * @return MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 622 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 623 int32_t setNetworkName(const std::string& name);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 624
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 625 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 626 * Get network name
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 627 * @return string containing network name (size 8 to 128)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 628 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 629 std::string getNetworkName();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 630
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 631 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 632 * Set network ID
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 633 * for use with OTA & AUTO_OTA network join modes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 634 * setting network ID via this function sets network name to empty
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 635 * @param id a vector of 8 bytes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 636 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 637 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 638 int32_t setNetworkId(const std::vector<uint8_t>& id);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 639
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 640 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 641 * Get network ID
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 642 * @returns vector containing network ID (size 8)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 643 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 644 std::vector<uint8_t> getNetworkId();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 645
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 646 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 647 * Set network passphrase
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 648 * for use with OTA & AUTO_OTA network join modes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 649 * generates network key (cmac of passphrase) automatically
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 650 * @param name a string of of at least 8 bytes and no more than 128 bytes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 651 * @return MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 652 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 653 int32_t setNetworkPassphrase(const std::string& passphrase);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 654
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 655 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 656 * Get network passphrase
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 657 * @return string containing network passphrase (size 8 to 128)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 658 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 659 std::string getNetworkPassphrase();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 660
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 661 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 662 * Set network key
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 663 * for use with OTA & AUTO_OTA network join modes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 664 * setting network key via this function sets network passphrase to empty
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 665 * @param id a vector of 16 bytes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 666 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 667 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 668 int32_t setNetworkKey(const std::vector<uint8_t>& id);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 669
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 670 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 671 * Get generic app key
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 672 * @returns a vector containing key (size 16)
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 673 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 674 std::vector<uint8_t> getGenAppKey();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 675
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 676 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 677 * Set generic app key
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 678 * for use with Multicast key exchange
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 679 * @param id a vector of 16 bytes
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 680 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 681 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 682 int32_t setGenAppKey(const std::vector<uint8_t>& id);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 683
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 684 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 685 * Get network key
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 686 * @returns a vector containing network key (size 16)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 687 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 688 std::vector<uint8_t> getNetworkKey();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 689
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 690 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 691 * Set lorawan application EUI
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 692 * equivalent to setNetworkId
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 693 * @param eui application EUI (size 8)
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 694 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 695 int32_t setAppEUI(const uint8_t* eui);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 696
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 697 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 698 * Get lorawan application EUI
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 699 * equivalent to getNetworkId
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 700 * @returns vector containing application EUI (size 8)
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 701 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 702 const uint8_t* getAppEUI();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 703
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 704 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 705 * Set lorawan application key
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 706 * equivalent to setNetworkKey
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 707 * @param eui application key (size 16)
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 708 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 709 int32_t setAppKey(const uint8_t* key);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 710
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 711 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 712 * Set lorawan application key
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 713 * equivalent to getNetworkKey
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 714 * @returns eui application key (size 16)
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 715 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 716 const uint8_t* getAppKey();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 717
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 718 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 719 * Set device nonce counter incremented with each Join Request
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 720 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 721 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 722 int32_t setDevNonce(const uint16_t& nonce);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 723
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 724 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 725 * Get device nonce counter incremented with each Join Request
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 726 * @returns join nonce
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 727 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 728 uint16_t getDevNonce();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 729
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 730 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 731 * Set app nonce counter incremented with each Join Accept
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 732 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 733 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 734 int32_t setAppNonce(const uint32_t& nonce);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 735
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 736 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 737 * Get app nonce counter incremented with each Join Accept
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 738 * @returns app nonce
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 739 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 740 uint32_t getAppNonce();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 741
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 742 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 743 * Enable/disable Join Nonce validation for App Nonce in Join Accept
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 744 * Default is enabled
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 745 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 746 int32_t setJoinNonceValidation(bool enable);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 747 bool getJoinNonceValidation();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 748
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 749 /**
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 750 * Add a multicast session address and keys
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 751 * Downlink counter is set to 0
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 752 * Up to 8 MULTICAST_SESSIONS can be set
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 753 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 754 int32_t setMulticastSession(uint8_t index, uint32_t addr, const uint8_t* nsk, const uint8_t* ask);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 755
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 756 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 757 * Set multicast session info
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 758 * Up to 8 MULTICAST_SESSIONS
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 759 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 760 int32_t setMulticastAddress(uint8_t index, uint32_t addr);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 761 int32_t setMulticastNetworkSessionKey(uint8_t index, const uint8_t* nsk);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 762 int32_t setMulticastApplicationSessionKey(uint8_t index, const uint8_t* ask);
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 763
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 764 /**
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 765 * Set a multicast session counter
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 766 * Up to 8 MULTICAST_SESSIONS
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 767 */
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 768 int32_t setMulticastDownlinkCounter(uint8_t index, uint32_t count);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 769 int32_t setMulticastPeriodicity(uint8_t index, int8_t period);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 770 int32_t setMulticastFrequency(uint8_t index, uint32_t freq);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 771 int32_t setMulticastDatarate(uint8_t index, uint8_t dr);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 772
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 773 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 774 * Get multicast session info
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 775 * Up to 8 MULTICAST_SESSIONS
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 776 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 777 uint32_t getMulticastAddress(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 778 int32_t getMulticastNetworkSessionKey(uint8_t index, uint8_t* nsk);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 779 int32_t getMulticastApplicationSessionKey(uint8_t index, uint8_t* ask);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 780 uint32_t getMulticastDownlinkCounter(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 781 int8_t getMulticastPeriodicity(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 782 uint32_t getMulticastFrequency(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 783 uint8_t getMulticastDatarate(uint8_t index);
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 784
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 785 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 786 * Attempt to join network
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 787 * each attempt will be made with a random datarate up to the configured datarate
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 788 * JoinRequest backoff between tries is enforced to 1% for 1st hour, 0.1% for 1-10 hours and 0.01% after 10 hours
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 789 * Check getNextTxMs() for time until next join attempt can be made
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 790 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 791 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 792 int32_t joinNetwork();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 793
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 794 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 795 * Attempts to join network once
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 796 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 797 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 798 int32_t joinNetworkOnce();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 799
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 800 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 801 * Resets current network session, essentially disconnecting from the network
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 802 * has no effect for MANUAL network join mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 803 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 804 void resetNetworkSession();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 805
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 806 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 807 * Restore saved network session from flash
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 808 * has no effect for MANUAL network join mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 809 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 810 void restoreNetworkSession();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 811
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 812 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 813 * Save current network session to flash
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 814 * has no effect for MANUAL network join mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 815 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 816 void saveNetworkSession();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 817
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 818 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 819 * Set number of times joining will retry each sub-band before changing
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 820 * to the next subband in US915 and AU915
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 821 * @param retries must be between 0 - 255
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 822 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 823 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 824 int32_t setJoinRetries(const uint8_t& retries);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 825
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 826 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 827 * Get number of times joining will retry each sub-band
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 828 * @returns join retries (0 - 255)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 829 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 830 uint8_t getJoinRetries();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 831
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 832 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 833 * Set network join mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 834 * MANUAL: set network address and session keys manually
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 835 * OTA: User sets network name and passphrase, then attempts to join
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 836 * AUTO_OTA: same as OTA, but network sessions can be saved and restored
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 837 * @param mode MANUAL, OTA, or AUTO_OTA
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 838 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 839 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 840 int32_t setJoinMode(const uint8_t& mode);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 841
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 842 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 843 * Get network join mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 844 * @returns MANUAL, OTA, or AUTO_OTA
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 845 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 846 uint8_t getJoinMode();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 847
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 848 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 849 * Get network join status
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 850 * @returns true if currently joined to network
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 851 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 852 bool getNetworkJoinStatus();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 853
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 854 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 855 * Do a network link check
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 856 * application data may be returned in response to a network link check command
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 857 * @returns link_check structure containing success, dBm above noise floor, gateways in range, and packet payload
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 858 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 859 link_check networkLinkCheck();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 860
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 861 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 862 * Set network link check count to perform automatic link checks every count packets
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 863 * only applicable if ACKs are disabled
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 864 * @param count must be between 0 - 255
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 865 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 866 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 867 int32_t setLinkCheckCount(const uint8_t& count);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 868
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 869 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 870 * Get network link check count
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 871 * @returns count (0 - 255)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 872 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 873 uint8_t getLinkCheckCount();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 874
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 875 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 876 * Set network link check threshold, number of link check failures or missed acks to tolerate
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 877 * before considering network connection lost
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 878 * @pararm count must be between 0 - 255
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 879 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 880 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 881 int32_t setLinkCheckThreshold(const uint8_t& count);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 882
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 883 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 884 * Get network link check threshold
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 885 * @returns threshold (0 - 255)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 886 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 887 uint8_t getLinkCheckThreshold();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 888
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 889 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 890 * Get/set number of failed link checks in the current session
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 891 * @returns count (0 - 255)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 892 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 893 uint8_t getLinkFailCount();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 894 int32_t setLinkFailCount(uint8_t count);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 895
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 896 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 897 * Set UpLinkCounter number of packets sent to the gateway during this network session (sequence number)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 898 * @returns MDOT_OK
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 899 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 900 int32_t setUpLinkCounter(uint32_t count);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 901
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 902 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 903 * Get UpLinkCounter
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 904 * @returns number of packets sent to the gateway during this network session (sequence number)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 905 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 906 uint32_t getUpLinkCounter();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 907
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 908 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 909 * Set UpLinkCounter number of packets sent by the gateway during this network session (sequence number)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 910 * @returns MDOT_OK
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 911 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 912 int32_t setDownLinkCounter(uint32_t count);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 913
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 914 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 915 * Get DownLinkCounter
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 916 * @returns number of packets sent by the gateway during this network session (sequence number)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 917 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 918 uint32_t getDownLinkCounter();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 919
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 920 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 921 * Enable/disable AES encryption
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 922 * AES encryption must be enabled for use with Conduit gateway and MTAC_LORA card
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 923 * @param on true for AES encryption to be enabled
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 924 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 925 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 926 int32_t setAesEncryption(const bool& on);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 927
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 928 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 929 * Get AES encryption
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 930 * @returns true if AES encryption is enabled
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 931 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 932 bool getAesEncryption();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 933
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 934 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 935 * Get RSSI stats
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 936 * @returns rssi_stats struct containing last, min, max, and avg RSSI in dB
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 937 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 938 rssi_stats getRssiStats();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 939
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 940 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 941 * Get SNR stats
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 942 * @returns snr_stats struct containing last, min, max, and avg SNR in cB
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 943 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 944 snr_stats getSnrStats();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 945
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 946 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 947 * Get ms until next free channel
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 948 * only applicable for European models, US models return 0
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 949 * @returns time (ms) until a channel is free to use for transmitting
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 950 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 951 uint32_t getNextTxMs();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 952
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 953 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 954 * Get available bytes for payload
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 955 * @returns bytes
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 956 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 957 uint8_t getNextTxMaxSize();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 958
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 959 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 960 * Get join delay in seconds
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 961 * Defaults to 5 seconds
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 962 * Must match join delay setting of the network server
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 963 *
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 964 * The default Join Delay is 5 seconds
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 965 * The default Join Delay for PRIVATE_MTS was 1 second in the previous release
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 966 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 967 * @returns number of seconds before join accept message is expected
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 968 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 969 uint8_t getJoinDelay();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 970
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 971 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 972 * Set join delay in seconds
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 973 * Defaults to 5 seconds
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 974 * Must match join delay setting of the network server
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 975 *
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 976 * The default Join Delay is 5 seconds
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 977 * The default Join Delay for PRIVATE_MTS was 1 second in the previous release
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 978 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 979 * @param delay number of seconds before join accept message is expected
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 980 * @return MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 981 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 982 uint32_t setJoinDelay(uint8_t delay);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 983
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 984 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 985 * Get join Rx1 datarate offset
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 986 * defaults to 0
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 987 * @returns offset
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 988 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 989 uint8_t getJoinRx1DataRateOffset();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 990
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 991 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 992 * Set join Rx1 datarate offset
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 993 * @param offset for datarate
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 994 * @return MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 995 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 996 uint32_t setJoinRx1DataRateOffset(uint8_t offset);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 997
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 998 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 999 * Get join Rx2 datarate
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1000 * defaults to US:DR8, AU:DR8, EU:DR0
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1001 * @returns datarate
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1002 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1003 uint8_t getJoinRx2DataRate();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1004
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1005 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1006 * Set join Rx2 datarate
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1007 * @param datarate
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1008 * @return MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1009 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1010 uint32_t setJoinRx2DataRate(uint8_t datarate);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1011
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1012 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1013 * Get join Rx2 frequency
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1014 * defaults US:923.3, AU:923.3, EU:869.525
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1015 * @returns frequency
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1016 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1017 uint32_t getJoinRx2Frequency();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1018
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1019 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1020 * Set join Rx2 frequency
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1021 * @param frequency
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1022 * @return MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1023 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1024 uint32_t setJoinRx2Frequency(uint32_t frequency);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1025
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1026 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1027 * Get rx delay in seconds
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1028 * Defaults to 1 second
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1029 * @returns number of seconds before response message is expected
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1030 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1031 uint8_t getRxDelay();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1032
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1033 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1034 * Set rx delay in seconds
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1035 * Defaults to 1 second
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1036 * @param delay number of seconds before response message is expected
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1037 * @return MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1038 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1039 uint32_t setRxDelay(uint8_t delay);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1040
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1041 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1042 * Get preserve session to save network session info through reset or power down in AUTO_OTA mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1043 * Defaults to off
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1044 * @returns true if enabled
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1045 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1046 bool getPreserveSession();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1047
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1048 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1049 * Set preserve session to save network session info through reset or power down in AUTO_OTA mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1050 * Defaults to off
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1051 * @param enable
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1052 * @return MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1053 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1054 uint32_t setPreserveSession(bool enable);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1055
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1056 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1057 * Get data pending
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1058 * only valid after sending data to the gateway
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1059 * @returns true if server has available packet(s)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1060 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1061 bool getDataPending();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1062
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1063 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1064 * Get ack requested
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1065 * only valid after sending data to the gateway
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1066 * @returns true if server has requested ack
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1067 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1068 bool getAckRequested();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1069
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1070 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1071 * Get is transmitting indicator
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1072 * @returns true if currently transmitting
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1073 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1074 bool getIsTransmitting();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1075
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1076 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1077 * Get is idle indicator
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1078 * @returns true if not currently transmitting, waiting or receiving
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1079 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1080 bool getIsIdle();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1081
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1082 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1083 * Set TX data rate
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1084 * data rates affect maximum payload size
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1085 * @param dr DR0-DR7 for Europe, DR0-DR4 for United States
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1086 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1087 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1088 int32_t setTxDataRate(const uint8_t& dr);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1089
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1090 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1091 * Get TX data rate
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1092 * @returns current TX data rate (DR0-DR15)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1093 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1094 uint8_t getTxDataRate();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1095
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1096 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1097 * Get a random value from the radio based on RSSI
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1098 * @returns randome value
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1099 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1100 uint32_t getRadioRandom();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1101
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1102 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1103 * Get data rate spreading factor and bandwidth
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1104 * EU868 Datarates
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1105 * ---------------
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1106 * DR0 - SF12BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1107 * DR1 - SF11BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1108 * DR2 - SF10BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1109 * DR3 - SF9BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1110 * DR4 - SF8BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1111 * DR5 - SF7BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1112 * DR6 - SF7BW250
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1113 * DR7 - FSK
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1114 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1115 * US915 Datarates
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1116 * ---------------
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1117 * DR0 - SF10BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1118 * DR1 - SF9BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1119 * DR2 - SF8BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1120 * DR3 - SF7BW125
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1121 * DR4 - SF8BW500
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1122 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1123 * AU915 Datarates
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1124 * ---------------
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1125 * DR0 - SF12BW125
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1126 * DR1 - SF11BW125
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1127 * DR2 - SF10BW125
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1128 * DR3 - SF9BW125
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1129 * DR4 - SF8BW125
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1130 * DR5 - SF7BW125
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1131 * DR6 - SF8BW500
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1132 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1133 * @returns spreading factor and bandwidth
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1134 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1135 std::string getDataRateDetails(uint8_t rate);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1136
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1137 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1138 * Set TX power output of radio before antenna gain, default: 14 dBm
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1139 * actual output power may be limited by local regulations for the chosen frequency
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1140 * power affects maximum range
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1141 * @param power 2 dBm - 20 dBm
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1142 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1143 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1144 int32_t setTxPower(const uint32_t& power);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1145
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1146 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1147 * Get TX power
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1148 * @returns TX power (2 dBm - 20 dBm)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1149 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1150 uint32_t getTxPower();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1151
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1152 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1153 * Get configured gain of installed antenna, default: +3 dBi
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1154 * @returns gain of antenna in dBi
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1155 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1156 int8_t getAntennaGain();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1157
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1158 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1159 * Set configured gain of installed antenna, default: +3 dBi
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1160 * @param gain -127 dBi - 128 dBi
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1161 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1162 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1163 int32_t setAntennaGain(int8_t gain);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1164
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1165 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1166 * Enable/disable TX waiting for rx windows
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1167 * when enabled, send calls will block until a packet is received or RX timeout
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1168 * @param enable set to true if expecting responses to transmitted packets
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1169 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1170 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1171 int32_t setTxWait(const bool& enable);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1172
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1173 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1174 * Get TX wait
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1175 * @returns true if TX wait is enabled
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1176 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1177 bool getTxWait();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1178
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1179 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1180 * Cancel pending rx windows
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1181 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1182 void cancelRxWindow();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1183
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1184 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1185 * Get time on air
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1186 * @returns the amount of time (in ms) it would take to send bytes bytes based on current configuration
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1187 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1188 uint32_t getTimeOnAir(uint8_t bytes);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1189
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1190 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1191 * Get min frequency
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1192 * @returns minimum frequency based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1193 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1194 uint32_t getMinFrequency();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1195
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1196 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1197 * Get max frequency
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1198 * @returns maximum frequency based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1199 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1200 uint32_t getMaxFrequency();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1201
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1202 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1203 * Get min datarate
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1204 * @returns minimum datarate based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1205 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1206 uint8_t getMinDatarate();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1207
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1208 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1209 * Get max datarate
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1210 * @returns maximum datarate based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1211 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1212 uint8_t getMaxDatarate();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1213
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1214 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1215 * Get min datarate offset
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1216 * @returns minimum datarate offset based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1217 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1218 uint8_t getMinDatarateOffset();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1219
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1220 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1221 * Get max datarate offset
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1222 * @returns maximum datarate based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1223 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1224 uint8_t getMaxDatarateOffset();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1225
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1226 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1227 * Get min datarate
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1228 * @returns minimum datarate based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1229 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1230 uint8_t getMinRx2Datarate();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1231
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1232 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1233 * Get max rx2 datarate
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1234 * @returns maximum rx2 datarate based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1235 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1236 uint8_t getMaxRx2Datarate();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1237
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1238 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1239 * Get max tx power
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1240 * @returns maximum tx power based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1241 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1242 uint8_t getMaxTxPower();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1243
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1244 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1245 * Get min tx power
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1246 * @returns minimum tx power based on current channel plan
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1247 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1248 uint8_t getMinTxPower();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1249
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1250 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1251 * Set ping slot periodicity
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1252 * Specify the the number of ping slots in a given beacon interval
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1253 * Note: Must switch back to class A for the change to take effect
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1254 * @param exp - number_of_pings = 2^(7 - exp) where 0 <= exp <= 7
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1255 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1256 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1257 uint32_t setPingPeriodicity(uint8_t exp);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1258
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1259 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1260 * Get ping slot periodicity
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1261 * @returns exp = 7 - log2(number_of_pings)
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1262 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1263 uint8_t getPingPeriodicity();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1264
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1265 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1266 *
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1267 * get/set adaptive data rate
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1268 * configure data rates and power levels based on signal to noise of packets received at gateway
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1269 * true == adaptive data rate is on
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1270 * set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1271 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1272 int32_t setAdr(const bool& on);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1273 bool getAdr();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1274
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1275 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1276 * Set the ADR ACK Limit
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1277 * @param limit - ADR ACK limit
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1278 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1279 */
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1280 int32_t setAdrAckLimit(uint8_t limit);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1281
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1282 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1283 * Get the ADR ACK Limit
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1284 * @returns ADR ACK limit
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1285 */
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1286 uint8_t getAdrAckLimit();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1287
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1288 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1289 * Set the ADR ACK Delay
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1290 * @param delay - ADR ACK delay
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1291 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1292 */
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1293 int32_t setAdrAckDelay(uint8_t delay);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1294
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1295 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1296 * Get the ADR ACK Delay
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1297 * @returns ADR ACK delay
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1298 */
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1299 uint8_t getAdrAckDelay();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1300
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1301 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1302 * Enable/disable CRC checking of packets
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1303 * CRC checking must be enabled for use with Conduit gateway and MTAC_LORA card
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1304 * @param on set to true to enable CRC checking
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1305 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1306 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1307 int32_t setCrc(const bool& on);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1308
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1309 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1310 * Get CRC checking
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1311 * @returns true if CRC checking is enabled
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1312 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1313 bool getCrc();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1314
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1315 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1316 * Set ack
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1317 * @param retries 0 to disable acks, otherwise 1 - 8
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1318 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1319 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1320 int32_t setAck(const uint8_t& retries);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1321
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1322 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1323 * Get ack
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1324 * @returns 0 if acks are disabled, otherwise retries (1 - 8)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1325 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1326 uint8_t getAck();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1327
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1328 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1329 * Set number of packet repeats for unconfirmed frames
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1330 * @param repeat 0 or 1 for no repeats, otherwise 2-15
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1331 * @returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1332 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1333 int32_t setRepeat(const uint8_t& repeat);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1334
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1335 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1336 * Get number of packet repeats for unconfirmed frames
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1337 * @returns 0 or 1 if no repeats, otherwise 2-15
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1338 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1339 uint8_t getRepeat();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1340
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1341 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1342 * Send data to the gateway
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1343 * validates data size (based on spreading factor)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1344 * @param data a vector of up to 242 bytes (may be less based on spreading factor)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1345 * @returns MDOT_OK if packet was sent successfully (ACKs disabled), or if an ACK was received (ACKs enabled)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1346 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1347 int32_t send(const std::vector<uint8_t>& data, const bool& blocking = true, const bool& highBw = false);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1348
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1349 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1350 * Inject mac command
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1351 * @param data a vector containing mac commands
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1352 * @returns MDOT_OK
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1353 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1354 int32_t injectMacCommand(const std::vector<uint8_t>& data);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1355
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1356 /**
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1357 * Clear MAC command buffer to be sent in next uplink
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1358 * @returns MDOT_OK
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1359 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1360 int32_t clearMacCommands();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1361
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1362 /**
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1363 * Get MAC command buffer to be sent in next uplink
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1364 * @returns command bytes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1365 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1366 std::vector<uint8_t> getMacCommands();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1367
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1368 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1369 * Fetch data received from the gateway
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1370 * this function only checks to see if a packet has been received - it does not open a receive window
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1371 * send() must be called before recv()
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1372 * @param data a vector to put the received data into
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1373 * @returns MDOT_OK if packet was successfully received
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1374 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1375 int32_t recv(std::vector<uint8_t>& data);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1376
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1377 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1378 * Ping
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1379 * status will be MDOT_OK if ping succeeded
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1380 * @returns ping_response struct containing status, RSSI, and SNR
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1381 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1382 ping_response ping();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1383
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1384 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1385 * Get return code string
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1386 * @returns string containing a description of the given error code
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1387 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1388 static std::string getReturnCodeString(const int32_t& code);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1389
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1390 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1391 * Get last error
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1392 * @returns string explaining the last error that occured
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1393 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1394 std::string getLastError();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1395
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1396 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1397 * Go to sleep
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1398 * @param interval the number of seconds to sleep before waking up if wakeup_mode == RTC_ALARM or RTC_ALARM_OR_INTERRUPT, else ignored
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1399 * @param wakeup_mode RTC_ALARM, INTERRUPT, RTC_ALARM_OR_INTERRUPT
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1400 * if RTC_ALARM the real time clock is configured to wake the device up after the specified interval
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1401 * if INTERRUPT the device will wake up on the rising edge of the interrupt pin
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1402 * if RTC_ALARM_OR_INTERRUPT the device will wake on the first event to occur
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1403 * @param deepsleep if true go into deep sleep mode (lowest power, all memory and registers are lost, peripherals turned off)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1404 * else go into sleep mode (low power, memory and registers are maintained, peripherals stay on)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1405 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1406 * For the MDOT
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1407 * in sleep mode, the device can be woken up on an XBEE_DI (2-8) pin or by the RTC alarm
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1408 * in deepsleep mode, the device can only be woken up using the WKUP pin (PA0, XBEE_DIO7) or by the RTC alarm
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1409 * For the XDOT
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1410 * in sleep mode, the device can be woken up on GPIO (0-3), UART1_RX, WAKE or by the RTC alarm
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1411 * in deepsleep mode, the device can only be woken up using the WKUP pin (PA0, WAKE) or by the RTC alarm
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1412 * @returns MDOT_OK on success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1413 */
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1414 int32_t sleep(const uint32_t& interval, const uint8_t& wakeup_mode = RTC_ALARM, const bool& deepsleep = true);
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1415
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1416 /**
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1417 * Set auto sleep mode
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1418 * Auto sleep mode will automatically put the MCU to sleep after tx and in between receive windows
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1419 * Note: The MCU will go into a stop mode sleep in between rx windows. This means that
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1420 * peripherals such as timers will not function during the sleep intervals.
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1421 * @param enable - Flag to enable auto sleep mode
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1422 */
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1423 void setAutoSleep(bool enable);
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1424
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1425 /**
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1426 * Get auto sleep mode
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1427 * @returns 0 if sleep mode is disabled, 1 if it is enabled
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1428 */
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1429 uint8_t getAutoSleep();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1430
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1431 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1432 * Set wake pin
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1433 * @param pin the pin to use to wake the device from sleep mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1434 * For MDOT, XBEE_DI (2-8)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1435 * For XDOT, GPIO (0-3), UART1_RX, or WAKE
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1436 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1437 void setWakePin(const PinName& pin);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1438
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1439 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1440 * Get wake pin
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1441 * @returns the pin to use to wake the device from sleep mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1442 * For MDOT, XBEE_DI (2-8)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1443 * For XDOT, GPIO (0-3), UART1_RX, or WAKE
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1444 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1445 PinName getWakePin();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1446
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1447 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1448 * Write data in a user backup register
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1449 * @param register one of UBR0 through UBR9 for MDOT, one of UBR0 through UBR21 for XDOT
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1450 * @param data user data to back up
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1451 * @returns true if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1452 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1453 bool writeUserBackupRegister(uint32_t reg, uint32_t data);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1454
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1455 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1456 * Read data in a user backup register
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1457 * @param register one of UBR0 through UBR9 for MDOT, one of UBR0 through UBR21 for XDOT
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1458 * @param data gets set to content of register
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1459 * @returns true if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1460 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1461 bool readUserBackupRegister(uint32_t reg, uint32_t& data);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1462
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1463 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1464 * Set LBT time in us
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1465 * @param ms time in us
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1466 * @returns true if success
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1467 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1468 bool setLbtTimeUs(uint16_t us);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1469
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1470 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1471 * Get LBT time in us
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1472 * @returns LBT time in us
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1473 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1474 uint16_t getLbtTimeUs();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1475
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1476 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1477 * Set LBT threshold in dBm
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1478 * @param rssi threshold in dBm
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1479 * @returns true if success
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1480 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1481 bool setLbtThreshold(int8_t rssi);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1482
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1483 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1484 * Get LBT threshold in dBm
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1485 * @returns LBT threshold in dBm
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1486 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1487 int8_t getLbtThreshold();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1488
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1489 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1490 * Get Radio Frequency Offset
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1491 * Used for fine calibration of radio frequencies
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1492 * @returns frequency offset in MHz
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1493 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1494 int32_t getFrequencyOffset();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1495 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1496 * Get Radio Frequency Offset
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1497 * Used for fine calibration of radio frequencies
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1498 * @param offset frequency offset in MHz
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1499 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1500 void setFrequencyOffset(int32_t offset);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1501
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1502 /**
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1503 * Get GPS time from network server
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1504 * Sends a DeviceTimeReq command to the network server
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1505 * @returns time since GPS epoch, 0 on failure
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1506 */
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1507 uint64_t getGPSTime();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1508
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1509 /**
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1510 * Add a device time request to the MacCommand buffer
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1511 */
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1512 void addDeviceTimeRequest();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1513
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1514 #if defined(TARGET_MTS_MDOT_F411RE)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1515 ///////////////////////////////////////////////////////////////////
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1516 // Filesystem (Non Volatile Memory) Operation Functions for mDot //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1517 ///////////////////////////////////////////////////////////////////
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1518
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1519 // Save user file data to flash
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1520 // file - name of file max 30 chars
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1521 // data - data of file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1522 // size - size of file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1523 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1524 bool saveUserFile(const char* file, void* data, uint32_t size);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1525
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1526 // Append user file data to flash
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1527 // file - name of file max 30 chars
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1528 // data - data of file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1529 // size - size of file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1530 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1531 bool appendUserFile(const char* file, void* data, uint32_t size);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1532
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1533 // Read user file data from flash
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1534 // file - name of file max 30 chars
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1535 // data - data of file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1536 // size - size of file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1537 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1538 bool readUserFile(const char* file, void* data, uint32_t size);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1539
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1540 // Move a user file in flash
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1541 // file - name of file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1542 // new_name - new name of file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1543 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1544 bool moveUserFile(const char* file, const char* new_name);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1545
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1546 // Delete user file data from flash
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1547 // file - name of file max 30 chars
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1548 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1549 bool deleteUserFile(const char* file);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1550
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1551 // Open user file in flash, max of 4 files open concurrently
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1552 // file - name of file max 30 chars
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1553 // mode - combination of FM_APPEND | FM_TRUNC | FM_CREAT |
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1554 // FM_RDONLY | FM_WRONLY | FM_RDWR | FM_DIRECT
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1555 // returns - mdot_file struct, fd field will be a negative value if file could not be opened
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1556 mDot::mdot_file openUserFile(const char* file, int mode);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1557
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1558 // Seek an open file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1559 // file - mdot file struct
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1560 // offset - offset in bytes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1561 // whence - where offset is based SEEK_SET, SEEK_CUR, SEEK_END
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1562 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1563 bool seekUserFile(mDot::mdot_file& file, size_t offset, int whence);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1564
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1565 // Read bytes from open file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1566 // file - mdot file struct
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1567 // data - mem location to store data
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1568 // length - number of bytes to read
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1569 // returns - number of bytes read, negative if error
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1570 int readUserFile(mDot::mdot_file& file, void* data, size_t length);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1571
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1572 // Write bytes to open file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1573 // file - mdot file struct
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1574 // data - data to write
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1575 // length - number of bytes to write
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1576 // returns - number of bytes written, negative if error
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1577 int writeUserFile(mDot::mdot_file& file, void* data, size_t length);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1578
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1579 // Close open file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1580 // file - mdot file struct
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1581 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1582 bool closeUserFile(mDot::mdot_file& file);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1583
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1584 // List user files stored in flash
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1585 std::vector<mDot::mdot_file> listUserFiles();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1586
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1587 // Move file into the firmware upgrade path to be flashed on next boot
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1588 // file - name of file
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1589 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1590 bool moveUserFileToFirmwareUpgrade(const char* file);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1591
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1592 // Return total size of all files saved in FLASH
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1593 // Does not include SPIFFS overhead
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1594 uint32_t getUsedSpace();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1595
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1596 bool repairFlashFileSystem();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1597 #else
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1598 ///////////////////////////////////////////////////////////////
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1599 // EEPROM (Non Volatile Memory) Operation Functions for xDot //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1600 ///////////////////////////////////////////////////////////////
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1601
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1602 // Write to EEPROM
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1603 // addr - address to write to (0 - 0x17FF)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1604 // data - data to write
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1605 // size - size of data
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1606 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1607 bool nvmWrite(uint16_t addr, void* data, uint16_t size);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1608
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1609 // Read from EEPROM
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1610 // addr - address to read from (0 - 0x17FF)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1611 // data - buffer for data
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1612 // size - size of buffer
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1613 // returns true if successful
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1614 bool nvmRead(uint16_t addr, void* data, uint16_t size);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1615 #endif /* TARGET_MTS_MDOT_F411RE */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1616
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1617 // get current statistics
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1618 // Join Attempts, Join Fails, Up Packets, Down Packets, Missed Acks
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1619 mdot_stats getStats();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1620
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1621 // reset statistics
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1622 // Join Attempts, Join Fails, Up Packets, Down Packets, Missed Acks
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1623 void resetStats();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1624
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1625 // Convert pin number 2-8 to pin name DIO2-DI8
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1626 static PinName pinNum2Name(uint8_t num);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1627
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1628 // Convert pin name DIO2-DI8 to pin number 2-8
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1629 static uint8_t pinName2Num(PinName name);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1630
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1631 // Convert pin name DIO2-DI8 to string
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1632 static std::string pinName2Str(PinName name);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1633
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1634 uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1635
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1636 /*************************************************************************
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1637 * The following functions are only used by the AT command application and
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1638 * should not be used by standard applications consuming the mDot library
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1639 ************************************************************************/
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1640
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1641 // set/get configured baud rate for command port
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1642 // only for use in conjunction with AT interface
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1643 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1644 int32_t setBaud(const uint32_t& baud);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1645 uint32_t getBaud();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1646
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1647 // set/get baud rate for debug port
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1648 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1649 int32_t setDebugBaud(const uint32_t& baud);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1650 uint32_t getDebugBaud();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1651
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1652 // set/get command terminal echo
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1653 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1654 int32_t setEcho(const bool& on);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1655 bool getEcho();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1656
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1657 // set/get command terminal verbose mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1658 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1659 int32_t setVerbose(const bool& on);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1660 bool getVerbose();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1661
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1662 // set/get startup mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1663 // COMMAND_MODE (default), starts up ready to accept AT commands
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1664 // SERIAL_MODE, read serial data and send it as LoRa packets
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1665 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1666 int32_t setStartUpMode(const uint8_t& mode);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1667 uint8_t getStartUpMode();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1668
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1669 int32_t setRxDataRate(const uint8_t& dr);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1670 uint8_t getRxDataRate();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1671
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1672 // get/set TX/RX frequency
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1673 // if set to 0, device will hop frequencies
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1674 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1675 int32_t setTxFrequency(const uint32_t& freq);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1676 uint32_t getTxFrequency();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1677 int32_t setRxFrequency(const uint32_t& freq);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1678 uint32_t getRxFrequency();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1679
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1680 // get/set RX output mode
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1681 // valid options are HEXADECIMAL, BINARY, and EXTENDED
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1682 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1683 int32_t setRxOutput(const uint8_t& mode);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1684 uint8_t getRxOutput();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1685
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1686 // get/set serial wake interval
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1687 // valid values are 2 s - INT_MAX (2147483647) s
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1688 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1689 int32_t setWakeInterval(const uint32_t& interval);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1690 uint32_t getWakeInterval();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1691
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1692 // get/set serial wake delay
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1693 // valid values are 2 ms - INT_MAX (2147483647) ms
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1694 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1695 int32_t setWakeDelay(const uint32_t& delay);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1696 uint32_t getWakeDelay();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1697
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1698 // get/set serial receive timeout
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1699 // valid values are 0 ms - 65000 ms
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1700 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1701 int32_t setWakeTimeout(const uint16_t& timeout);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1702 uint16_t getWakeTimeout();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1703
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1704 // get/set serial wake mode
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1705 // valid values are INTERRUPT or RTC_ALARM
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1706 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1707 int32_t setWakeMode(const uint8_t& delay);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1708 uint8_t getWakeMode();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1709
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1710 // get/set serial flow control enabled
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1711 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1712 int32_t setFlowControl(const bool& on);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1713 bool getFlowControl();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1714
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1715 // get/set serial clear on error
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1716 // if enabled the data read from the serial port will be discarded if it cannot be sent or if the send fails
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1717 // set function returns MDOT_OK if success
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1718 int32_t setSerialClearOnError(const bool& on);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1719 bool getSerialClearOnError();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1720
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1721 // MTS_RADIO_DEBUG_COMMANDS
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1722
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1723 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1724 * Disable Duty cycle
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1725 * enables or disables the duty cycle limitations
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1726 * **** ONLY TO BE USED FOR TESTINGS PURPOSES ****
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1727 * **** ALL DEPLOYABLE CODE MUST ADHERE TO LOCAL REGULATIONS ****
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1728 * **** THIS SETTING WILL NOT BE SAVED TO CONFIGURATION *****
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1729 * @param val true to disable duty-cycle (default:false)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1730 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1731 int32_t setDisableDutyCycle(bool val);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1732
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1733 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1734 * Disable Duty cycle
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1735 * **** ONLY TO BE USED FOR TESTINGS PURPOSES ****
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1736 * **** ALL DEPLOYABLE CODE MUST ADHERE TO LOCAL REGULATIONS ****
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1737 * **** THIS SETTING WILL NOT BE SAVED TO CONFIGURATION *****
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1738 * @return true if duty-cycle is disabled (default:false)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1739 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1740 uint8_t getDisableDutyCycle();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1741
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1742 /**
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1743 * LBT RSSI
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1744 * @return the current RSSI on the configured frequency (SetTxFrequency) using configured LBT Time
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1745 */
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1746 int16_t lbtRssi();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1747
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1748 void openRxWindow(uint32_t timeout, uint8_t bandwidth = 0);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1749 void closeRxWindow();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1750 void sendContinuous(bool enable=true, uint32_t timeout=0, uint32_t frequency=0, int8_t txpower=-1);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1751 int32_t setDeviceId(const std::vector<uint8_t>& id);
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1752 int32_t setProtectedAppEUI(const std::vector<uint8_t>& appEUI);
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1753 int32_t setProtectedAppKey(const std::vector<uint8_t>& appKey);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1754 std::vector<uint8_t> getProtectedAppEUI();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1755 std::vector<uint8_t> getProtectedAppKey();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1756 int32_t setProtectedGenAppKey(const std::vector<uint8_t>& appKey);
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1757 int32_t setDefaultFrequencyBand(const uint8_t& band);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1758 bool saveProtectedConfig();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1759 // resets the radio/mac/link
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1760 void resetRadio();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1761 int32_t setRadioMode(const uint8_t& mode);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1762 std::map<uint8_t, uint8_t> dumpRegisters();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1763 void eraseFlash();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1764
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1765 void setWakeupCallback(void (*function)(void));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1766
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1767 template<typename T>
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1768 void setWakeupCallback(T *object, void (T::*member)(void)) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1769 _wakeup_callback.attach(object, member);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1770 }
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1771
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1772 lora::ChannelPlan* getChannelPlan(void);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1773
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1774 uint32_t setRx2DataRate(uint8_t dr);
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1775 uint8_t getRx2DataRate();
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1776
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1777 void mcGroupKeys(uint8_t *mcKeyEncrypt, uint32_t addr, uint8_t groupId, uint32_t frame_count);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1778 private:
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1779
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1780 void sleep_ms(uint32_t interval,
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1781 uint8_t wakeup_mode = RTC_ALARM,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1782 bool deepsleep = true);
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1783
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1784
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1785 void wakeup();
Jenkins@KEILDM1.dc.multitech.prv 14:f0c24ce93427 1786
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1787 mdot_stats _stats;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1788
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 1789 Callback<void()> _wakeup_callback;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1790
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1791 bool _standbyFlag;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1792 bool _testMode;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1793 uint8_t _savedPort;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1794 void handleTestModePacket();
Jenkins@KEILDM1.dc.multitech.prv 10:1e831990a669 1795 lora::ChannelPlan* _plan;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1796 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1797
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1798 #endif