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