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:
Mon Nov 13 09:35:22 2017 -0600
Revision:
56:3eb5210b5039
Parent:
51:fb07e1413db3
Child:
58:cc8419855044
xdot-library revision 3.0.1-1-gada985f and mbed-os revision mbed-os-5.5.7

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