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 Oct 19 14:51:56 2018 -0500
Revision:
130:8cb110bd3e97
Parent:
128:ff9ca3779136
Child:
131:865d54f61813
xdot-library revision 3.1.0-38-g799685a and mbed-os revision mbed-os-5.9.6

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