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

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

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

Dot Library Version 3 Updates

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

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

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

    // ...
}

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

Multicast Sessions

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

mDot.h

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

mDotEvent.h

The address field was added to PacketRx event.

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

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

A changelog for the Dot library can be found here.

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

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

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

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

Who changed what in which revision?

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