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