Bleeding edge development version of the xDot library for mbed 5. This version of the library is not guaranteed to be stable or well tested and should not be used in production or deployment scenarios.

Dependents:   Dot-Examples Dot-AT-Firmware Dot-Examples TEST_FF1705 ... more

The Dot library provides a LoRaWan certified stack for LoRa communication using MultiTech mDot and xDot devices. The stack is compatible with mbed 5.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. Channel plans are included with the 3.x.x Dot Library releases. The following code snippet demonstrates how to create a channel plan and inject it into the stack.

#include "mDot.h"
#include "channel_plans.h"

int main() {
    ChannelPlan* plan = new lora::ChannelPlan_US915();
    assert(plan);
    mDot* dot = mDot::getInstance(plan);
    assert(dot);

    // ...
}

Dot devices must not be deployed with software using a different channel plan than the Dot's default plan! This functionality is for development and testing only!

Multicast Sessions

Multicast sessions and packet rx events in library. When in Class C mode Multicast downlinks can be received. Recieved packets should be filtered on address, counter value will be maintained in the session or can be set explicitly depending on Application support to share Multicast Address, Keys and Counters.

mDot.h

        /**
         * Add a multicast session address and keys
         * Downlink counter is set to 0
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastSession(uint8_t index, uint32_t addr, const uint8_t* nsk, const uint8_t* dsk);
 
        /**
         * Set a multicast session counter
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastDownlinkCounter(uint8_t index, uint32_t count);

mDotEvent.h

The address field was added to PacketRx event.

        virtual void PacketRx(uint8_t port, uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr, lora::DownlinkControl ctrl, uint8_t slot, uint8_t retries, uint32_t address);

The name of the repository can be used to determine which device the stack was compiled for and if it's a development or production-ready build:

A changelog for the Dot library can be found here.

The Dot library version and the version of mbed-os it was compiled against can both be found in the commit message for that revision of the Dot library. Building your application with the same version of mbed-os as what was used to build the Dot library is highly recommended!

The Dot-Examples repository demonstrates how to use the Dot library in a custom application.

The mDot and xDot platform pages have lots of platform specific information and document potential issues, gotchas, etc, and provide instructions for getting started with development. Please take a look at the platform page before starting development as they should answer many questions you will have.

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