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