Bleeding edge development version of the mDot 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:   mDot-IKS01A1 mDot-IKS01A1 mDot-Examples mDot-IKS01A1-Explora ... more

Fork of libmDot-dev-mbed2-deprecated by MultiTech

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

Dot Library Version 3 Updates

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

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

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

    // ...
}

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

Multicast Sessions

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

mDot.h

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

mDotEvent.h

The address field was added to PacketRx event.

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

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

A changelog for the Dot library can be found here.

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

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

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

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Tue Jan 23 10:55:18 2018 -0600
Revision:
129:3d65480c7adc
Parent:
128:79ed06543c8e
Child:
134:e5ad4bd55ce5
mdot-library revision 3.0.2-35-g4b99fdb and mbed-os revision mbed-os-5.5.7

Who changed what in which revision?

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