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 02 15:41:13 2018 -0600
Revision:
67:d8d25077eaa5
Parent:
63:fc27867e9660
Child:
75:e5b2e2d6809e
xdot-library revision 3.0.2-24-gee0f782 and mbed-os revision mbed-os-5.5.7

Who changed what in which revision?

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