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

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

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

Dot Library Version 3 Updates

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

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

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

    // ...
}

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

Multicast Sessions

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

mDot.h

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

mDotEvent.h

The address field was added to PacketRx event.

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

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

A changelog for the Dot library can be found here.

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

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

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

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Wed Feb 14 13:46:56 2018 -0600
Revision:
81:2b275bd4c948
Parent:
76:3b946c7d4a8b
Child:
82:1e03f40a72bb
xdot-library revision 3.0.2-41-g8e44939 and mbed-os revision mbed-os-5.5.7

Who changed what in which revision?

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