Eliott Fersko / libmDot-mbed5

libmDot0mbed5

Fork of libmDot-mbed5 by MultiTech

mDot.h@30:c3150500b324, 2016-09-07 (annotated)

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Wed Sep 07 15:40:13 2016 -0500
Revision:
30:c3150500b324
Parent:
19:f3a46d2bb9b3
Child:
31:7fdee197d415
update from git revision 2.0.6-11-gaae06a1

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
mfiore 0:c62615f15125 16 class mDot {
Mike Fiore 16:b630e18103e5 17 friend class mDotEvent;
mfiore 0:c62615f15125 18
mfiore 0:c62615f15125 19 private:
mfiore 0:c62615f15125 20
mfiore 0:c62615f15125 21 mDot();
mfiore 0:c62615f15125 22 ~mDot();
mfiore 0:c62615f15125 23
Mike Fiore 16:b630e18103e5 24 void initLora();
Mike Fiore 16:b630e18103e5 25
mfiore 0:c62615f15125 26 void setLastError(const std::string& str);
mfiore 0:c62615f15125 27
mfiore 0:c62615f15125 28 static bool validateBaudRate(const uint32_t& baud);
mfiore 0:c62615f15125 29 static bool validateFrequencySubBand(const uint8_t& band);
mfiore 0:c62615f15125 30 bool validateDataRate(const uint8_t& dr);
mfiore 0:c62615f15125 31
mfiore 0:c62615f15125 32 int32_t joinBase(const uint32_t& retries);
mfiore 0:c62615f15125 33 int32_t sendBase(const std::vector<uint8_t>& data, const bool& confirmed = false, const bool& blocking = true, const bool& highBw = false);
mfiore 0:c62615f15125 34 void waitForPacket();
mfiore 0:c62615f15125 35 void waitForLinkCheck();
mfiore 0:c62615f15125 36
mfiore 0:c62615f15125 37 void setActivityLedState(const uint8_t& state);
mfiore 0:c62615f15125 38 uint8_t getActivityLedState();
mfiore 0:c62615f15125 39
mfiore 0:c62615f15125 40 void blinkActivityLed(void) {
Mike Fiore 6:390fc83d588d 41 if (_activity_led) {
Mike Fiore 6:390fc83d588d 42 int val = _activity_led->read();
Mike Fiore 6:390fc83d588d 43 _activity_led->write(!val);
Mike Fiore 6:390fc83d588d 44 }
mfiore 0:c62615f15125 45 }
mfiore 0:c62615f15125 46
mfiore 0:c62615f15125 47 mDot(const mDot&);
mfiore 0:c62615f15125 48 mDot& operator=(const mDot&);
mfiore 0:c62615f15125 49
Mike Fiore 7:683dba5d576f 50 uint32_t RTC_ReadBackupRegister(uint32_t RTC_BKP_DR);
Mike Fiore 7:683dba5d576f 51 void RTC_WriteBackupRegister(uint32_t RTC_BKP_DR, uint32_t Data);
Mike Fiore 7:683dba5d576f 52
Mike Fiore 7:683dba5d576f 53 void wakeup();
Mike Fiore 7:683dba5d576f 54
Mike Fiore 12:54f9cac9d690 55 void enterStopMode(const uint32_t& interval, const uint8_t& wakeup_mode = RTC_ALARM);
Mike Fiore 12:54f9cac9d690 56 void enterStandbyMode(const uint32_t& interval, const uint8_t& wakeup_mode = RTC_ALARM);
Mike Fiore 12:54f9cac9d690 57
mfiore 0:c62615f15125 58 static mDot* _instance;
mfiore 0:c62615f15125 59
Mike Fiore 16:b630e18103e5 60 lora::Mote _mote;
mfiore 0:c62615f15125 61 LoRaConfig* _config;
Mike Fiore 16:b630e18103e5 62 lora::Settings _settings;
Mike Fiore 16:b630e18103e5 63 mDotEvent* _events;
Mike Fiore 16:b630e18103e5 64
mfiore 0:c62615f15125 65 std::string _last_error;
mfiore 0:c62615f15125 66 static const uint32_t _baud_rates[];
mfiore 0:c62615f15125 67 uint8_t _activity_led_state;
mfiore 0:c62615f15125 68 Ticker _tick;
Mike Fiore 6:390fc83d588d 69 DigitalOut* _activity_led;
Mike Fiore 6:390fc83d588d 70 bool _activity_led_enable;
Mike Fiore 6:390fc83d588d 71 PinName _activity_led_pin;
Mike Fiore 5:0bfe6a650513 72 bool _activity_led_external;
jreiss 9:ec2fffe31793 73 uint8_t _linkFailCount;
Mike Fiore 7:683dba5d576f 74 uint8_t _class;
Mike Fiore 7:683dba5d576f 75 InterruptIn* _wakeup;
Mike Fiore 7:683dba5d576f 76 PinName _wakeup_pin;
mfiore 0:c62615f15125 77
mfiore 0:c62615f15125 78 typedef enum {
Jason Reiss 10:27dafba9fe19 79 OFF,
Jason Reiss 10:27dafba9fe19 80 ON,
Jason Reiss 10:27dafba9fe19 81 BLINK,
mfiore 0:c62615f15125 82 } state;
mfiore 0:c62615f15125 83
mfiore 0:c62615f15125 84 public:
mfiore 0:c62615f15125 85
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 86 #if defined(TARGET_MTS_MDOT_F411RE)
mfiore 0:c62615f15125 87 typedef enum {
Mike Fiore 7:683dba5d576f 88 FM_APPEND = (1 << 0),
Mike Fiore 7:683dba5d576f 89 FM_TRUNC = (1 << 1),
Mike Fiore 7:683dba5d576f 90 FM_CREAT = (1 << 2),
Mike Fiore 7:683dba5d576f 91 FM_RDONLY = (1 << 3),
Mike Fiore 7:683dba5d576f 92 FM_WRONLY = (1 << 4),
Mike Fiore 7:683dba5d576f 93 FM_RDWR = (FM_RDONLY | FM_WRONLY),
Mike Fiore 7:683dba5d576f 94 FM_DIRECT = (1 << 5)
Mike Fiore 7:683dba5d576f 95 } FileMode;
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 96 #endif /* TARGET_MTS_MDOT_F411RE */
Mike Fiore 7:683dba5d576f 97
Mike Fiore 7:683dba5d576f 98 typedef enum {
mfiore 0:c62615f15125 99 MDOT_OK = 0,
mfiore 0:c62615f15125 100 MDOT_INVALID_PARAM = -1,
mfiore 0:c62615f15125 101 MDOT_TX_ERROR = -2,
mfiore 0:c62615f15125 102 MDOT_RX_ERROR = -3,
mfiore 0:c62615f15125 103 MDOT_JOIN_ERROR = -4,
mfiore 0:c62615f15125 104 MDOT_TIMEOUT = -5,
mfiore 0:c62615f15125 105 MDOT_NOT_JOINED = -6,
mfiore 0:c62615f15125 106 MDOT_ENCRYPTION_DISABLED = -7,
mfiore 0:c62615f15125 107 MDOT_NO_FREE_CHAN = -8,
Mike Fiore 12:54f9cac9d690 108 MDOT_TEST_MODE = -9,
Mike Fiore 12:54f9cac9d690 109 MDOT_NO_ENABLED_CHAN = -10,
Mike Fiore 12:54f9cac9d690 110 MDOT_AGGREGATED_DUTY_CYCLE = -11,
mfiore 0:c62615f15125 111 MDOT_ERROR = -1024,
mfiore 0:c62615f15125 112 } mdot_ret_code;
mfiore 0:c62615f15125 113
mfiore 0:c62615f15125 114 enum JoinMode {
Mike Fiore 16:b630e18103e5 115 MANUAL = 0,
Jason Reiss 10:27dafba9fe19 116 OTA,
Mike Fiore 12:54f9cac9d690 117 AUTO_OTA,
Mike Fiore 12:54f9cac9d690 118 PEER_TO_PEER
mfiore 0:c62615f15125 119 };
mfiore 0:c62615f15125 120
mfiore 0:c62615f15125 121 enum Mode {
Jason Reiss 10:27dafba9fe19 122 COMMAND_MODE,
Jason Reiss 10:27dafba9fe19 123 SERIAL_MODE
mfiore 0:c62615f15125 124 };
mfiore 0:c62615f15125 125
mfiore 0:c62615f15125 126 enum RX_Output {
Jason Reiss 10:27dafba9fe19 127 HEXADECIMAL,
Jason Reiss 10:27dafba9fe19 128 BINARY
mfiore 0:c62615f15125 129 };
mfiore 0:c62615f15125 130
mfiore 0:c62615f15125 131 enum DataRates {
Mike Fiore 12:54f9cac9d690 132 DR0,
Mike Fiore 12:54f9cac9d690 133 DR1,
Mike Fiore 12:54f9cac9d690 134 DR2,
Mike Fiore 12:54f9cac9d690 135 DR3,
Mike Fiore 12:54f9cac9d690 136 DR4,
Mike Fiore 12:54f9cac9d690 137 DR5,
Mike Fiore 12:54f9cac9d690 138 DR6,
Mike Fiore 12:54f9cac9d690 139 DR7,
Mike Fiore 12:54f9cac9d690 140 DR8,
Mike Fiore 12:54f9cac9d690 141 DR9,
Mike Fiore 12:54f9cac9d690 142 DR10,
Mike Fiore 12:54f9cac9d690 143 DR11,
Mike Fiore 12:54f9cac9d690 144 DR12,
Mike Fiore 12:54f9cac9d690 145 DR13,
Mike Fiore 12:54f9cac9d690 146 DR14,
Mike Fiore 12:54f9cac9d690 147 DR15,
Mike Fiore 12:54f9cac9d690 148 SF_12 = 16,
Jason Reiss 10:27dafba9fe19 149 SF_11,
Jason Reiss 10:27dafba9fe19 150 SF_10,
Jason Reiss 10:27dafba9fe19 151 SF_9,
Jason Reiss 10:27dafba9fe19 152 SF_8,
Jason Reiss 10:27dafba9fe19 153 SF_7,
Jason Reiss 10:27dafba9fe19 154 SF_7H,
Mike Fiore 12:54f9cac9d690 155 SF_FSK
mfiore 0:c62615f15125 156 };
mfiore 0:c62615f15125 157
mfiore 0:c62615f15125 158 enum FrequencyBands {
Mike Fiore 16:b630e18103e5 159 FB_868 = 0,
Mike Fiore 16:b630e18103e5 160 FB_915 = 1,
Mike Fiore 16:b630e18103e5 161 FB_EU868 = 0, // EU868
Mike Fiore 16:b630e18103e5 162 FB_US915 = 1, // US915
Mike Fiore 16:b630e18103e5 163 FB_AU915 = 2
mfiore 0:c62615f15125 164 };
mfiore 0:c62615f15125 165
mfiore 0:c62615f15125 166 enum FrequencySubBands {
Jason Reiss 10:27dafba9fe19 167 FSB_ALL,
Jason Reiss 10:27dafba9fe19 168 FSB_1,
Jason Reiss 10:27dafba9fe19 169 FSB_2,
Jason Reiss 10:27dafba9fe19 170 FSB_3,
Jason Reiss 10:27dafba9fe19 171 FSB_4,
Jason Reiss 10:27dafba9fe19 172 FSB_5,
Jason Reiss 10:27dafba9fe19 173 FSB_6,
Jason Reiss 10:27dafba9fe19 174 FSB_7,
Jason Reiss 10:27dafba9fe19 175 FSB_8
mfiore 0:c62615f15125 176 };
mfiore 0:c62615f15125 177
Mike Fiore 6:390fc83d588d 178 enum JoinByteOrder {
Jason Reiss 10:27dafba9fe19 179 LSB,
Jason Reiss 10:27dafba9fe19 180 MSB
Mike Fiore 6:390fc83d588d 181 };
Mike Fiore 6:390fc83d588d 182
Mike Fiore 7:683dba5d576f 183 enum wakeup_mode {
Jason Reiss 10:27dafba9fe19 184 RTC_ALARM,
Jason Reiss 10:27dafba9fe19 185 INTERRUPT,
Jason Reiss 10:27dafba9fe19 186 RTC_ALARM_OR_INTERRUPT
Mike Fiore 7:683dba5d576f 187 };
Mike Fiore 7:683dba5d576f 188
jreiss 9:ec2fffe31793 189 enum UserBackupRegs {
Jason Reiss 10:27dafba9fe19 190 UBR0,
Jason Reiss 10:27dafba9fe19 191 UBR1,
Jason Reiss 10:27dafba9fe19 192 UBR2,
Jason Reiss 10:27dafba9fe19 193 UBR3,
Jason Reiss 10:27dafba9fe19 194 UBR4,
Jason Reiss 10:27dafba9fe19 195 UBR5,
Jason Reiss 10:27dafba9fe19 196 UBR6,
Jason Reiss 10:27dafba9fe19 197 UBR7,
Jason Reiss 10:27dafba9fe19 198 UBR8,
Jason Reiss 10:27dafba9fe19 199 UBR9
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 200 #if defined (TARGET_XDOT_L151CC)
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 201 ,UBR10,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 202 UBR11,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 203 UBR12,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 204 UBR13,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 205 UBR14,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 206 UBR15,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 207 UBR16,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 208 UBR17,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 209 UBR18,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 210 UBR19,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 211 UBR20,
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 212 UBR21
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 213 #endif /* TARGET_XDOT_L151CC */
jreiss 9:ec2fffe31793 214 };
jreiss 9:ec2fffe31793 215
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 216 #if defined(TARGET_MTS_MDOT_F411RE)
Mike Fiore 7:683dba5d576f 217 typedef struct {
Mike Fiore 7:683dba5d576f 218 int16_t fd;
Mike Fiore 16:b630e18103e5 219 char name[33];
Mike Fiore 7:683dba5d576f 220 uint32_t size;
Mike Fiore 7:683dba5d576f 221 } mdot_file;
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 222 #endif /* TARGET_MTS_MDOT_F411RE */
Mike Fiore 7:683dba5d576f 223
mfiore 0:c62615f15125 224 typedef struct {
mfiore 0:c62615f15125 225 uint32_t Up;
mfiore 0:c62615f15125 226 uint32_t Down;
mfiore 0:c62615f15125 227 uint32_t Joins;
mfiore 0:c62615f15125 228 uint32_t JoinFails;
mfiore 0:c62615f15125 229 uint32_t MissedAcks;
Mike Fiore 16:b630e18103e5 230 uint32_t CRCErrors;
mfiore 0:c62615f15125 231 } mdot_stats;
mfiore 0:c62615f15125 232
mfiore 0:c62615f15125 233 typedef struct {
mfiore 0:c62615f15125 234 int16_t last;
mfiore 0:c62615f15125 235 int16_t min;
mfiore 0:c62615f15125 236 int16_t max;
mfiore 0:c62615f15125 237 int16_t avg;
mfiore 0:c62615f15125 238 } rssi_stats;
mfiore 0:c62615f15125 239
mfiore 0:c62615f15125 240 typedef struct {
Mike Fiore 11:d8464345e1f1 241 int16_t last;
Mike Fiore 11:d8464345e1f1 242 int16_t min;
Mike Fiore 11:d8464345e1f1 243 int16_t max;
Mike Fiore 11:d8464345e1f1 244 int16_t avg;
mfiore 0:c62615f15125 245 } snr_stats;
mfiore 0:c62615f15125 246
mfiore 0:c62615f15125 247 typedef struct {
mfiore 0:c62615f15125 248 bool status;
mfiore 0:c62615f15125 249 int32_t dBm;
mfiore 0:c62615f15125 250 uint32_t gateways;
mfiore 0:c62615f15125 251 std::vector<uint8_t> payload;
mfiore 0:c62615f15125 252 } link_check;
mfiore 0:c62615f15125 253
mfiore 0:c62615f15125 254 typedef struct {
mfiore 0:c62615f15125 255 int32_t status;
mfiore 0:c62615f15125 256 int16_t rssi;
mfiore 0:c62615f15125 257 int16_t snr;
mfiore 0:c62615f15125 258 } ping_response;
mfiore 0:c62615f15125 259
mfiore 0:c62615f15125 260 static const uint8_t MaxLengths_915[];
mfiore 0:c62615f15125 261 static const uint8_t MaxLengths_868[];
mfiore 0:c62615f15125 262
mfiore 0:c62615f15125 263 static std::string JoinModeStr(uint8_t mode);
mfiore 0:c62615f15125 264 static std::string ModeStr(uint8_t mode);
mfiore 0:c62615f15125 265 static std::string RxOutputStr(uint8_t format);
mfiore 0:c62615f15125 266 static std::string DataRateStr(uint8_t rate);
mfiore 0:c62615f15125 267 static std::string FrequencyBandStr(uint8_t band);
mfiore 0:c62615f15125 268 static std::string FrequencySubBandStr(uint8_t band);
mfiore 0:c62615f15125 269
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 270 #if defined(TARGET_MTS_MDOT_F411RE)
jreiss 9:ec2fffe31793 271 uint32_t UserRegisters[10];
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 272 #else
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 273 uint32_t UserRegisters[22];
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 274 #endif /* TARGET_MTS_MDOT_F411RE */
jreiss 9:ec2fffe31793 275
mfiore 0:c62615f15125 276 /** Get a handle to the singleton object
mfiore 0:c62615f15125 277 * @returns pointer to mDot object
mfiore 0:c62615f15125 278 */
mfiore 0:c62615f15125 279 static mDot* getInstance();
mfiore 0:c62615f15125 280
Mike Fiore 12:54f9cac9d690 281 void setEvents(mDotEvent* events);
Mike Fiore 12:54f9cac9d690 282
mfiore 0:c62615f15125 283 /** Get library version information
mfiore 0:c62615f15125 284 * @returns string containing library version information
mfiore 0:c62615f15125 285 */
mfiore 0:c62615f15125 286 std::string getId();
mfiore 0:c62615f15125 287
mfiore 0:c62615f15125 288 /** Perform a soft reset of the system
mfiore 0:c62615f15125 289 */
mfiore 0:c62615f15125 290 void resetCpu();
mfiore 0:c62615f15125 291
mfiore 0:c62615f15125 292 /** Reset config to factory default
mfiore 0:c62615f15125 293 */
mfiore 0:c62615f15125 294 void resetConfig();
mfiore 0:c62615f15125 295
mfiore 0:c62615f15125 296 /** Save config data to non volatile memory
mfiore 0:c62615f15125 297 * @returns true if success, false if failure
mfiore 0:c62615f15125 298 */
mfiore 0:c62615f15125 299 bool saveConfig();
mfiore 0:c62615f15125 300
mfiore 0:c62615f15125 301 /** Set the log level for the library
mfiore 0:c62615f15125 302 * options are:
mfiore 0:c62615f15125 303 * NONE_LEVEL - logging is off at this level
mfiore 0:c62615f15125 304 * FATAL_LEVEL - only critical errors will be reported
mfiore 0:c62615f15125 305 * ERROR_LEVEL
mfiore 0:c62615f15125 306 * WARNING_LEVEL
mfiore 0:c62615f15125 307 * INFO_LEVEL
mfiore 0:c62615f15125 308 * DEBUG_LEVEL
mfiore 0:c62615f15125 309 * TRACE_LEVEL - every detail will be reported
mfiore 0:c62615f15125 310 * @param level the level to log at
mfiore 0:c62615f15125 311 * @returns MDOT_OK if success
mfiore 0:c62615f15125 312 */
mfiore 0:c62615f15125 313 int32_t setLogLevel(const uint8_t& level);
mfiore 0:c62615f15125 314
mfiore 0:c62615f15125 315 /** Get the current log level for the library
mfiore 0:c62615f15125 316 * @returns current log level
mfiore 0:c62615f15125 317 */
Mike Fiore 6:390fc83d588d 318 uint8_t getLogLevel();
Mike Fiore 6:390fc83d588d 319
Mike Fiore 12:54f9cac9d690 320 /** Seed pseudo RNG in LoRaMac layer, uses random value from radio RSSI reading by default
Mike Fiore 12:54f9cac9d690 321 * @param seed for RNG
Mike Fiore 12:54f9cac9d690 322 */
Mike Fiore 12:54f9cac9d690 323 void seedRandom(uint32_t seed);
Mike Fiore 12:54f9cac9d690 324
Mike Fiore 6:390fc83d588d 325 /** Enable or disable the activity LED.
Mike Fiore 6:390fc83d588d 326 * @param enable true to enable the LED, false to disable
Mike Fiore 6:390fc83d588d 327 */
Mike Fiore 6:390fc83d588d 328 void setActivityLedEnable(const bool& enable);
Mike Fiore 4:94969e981dcc 329
Mike Fiore 6:390fc83d588d 330 /** Find out if the activity LED is enabled
Mike Fiore 6:390fc83d588d 331 * @returns true if activity LED is enabled, false if disabled
Mike Fiore 6:390fc83d588d 332 */
Mike Fiore 6:390fc83d588d 333 bool getActivityLedEnable();
Mike Fiore 6:390fc83d588d 334
Mike Fiore 6:390fc83d588d 335 /** Use a different pin for the activity LED.
Mike Fiore 6:390fc83d588d 336 * The default is XBEE_RSSI.
Mike Fiore 6:390fc83d588d 337 * @param pin the new pin to use
Mike Fiore 6:390fc83d588d 338 */
Mike Fiore 6:390fc83d588d 339 void setActivityLedPin(const PinName& pin);
Mike Fiore 6:390fc83d588d 340
Mike Fiore 5:0bfe6a650513 341 /** Use an external DigitalOut object for the activity LED.
Mike Fiore 5:0bfe6a650513 342 * The pointer must stay valid!
Mike Fiore 5:0bfe6a650513 343 * @param pin the DigitalOut object to use
Mike Fiore 5:0bfe6a650513 344 */
Mike Fiore 5:0bfe6a650513 345 void setActivityLedPin(DigitalOut* pin);
Mike Fiore 6:390fc83d588d 346
Mike Fiore 6:390fc83d588d 347 /** Find out what pin the activity LED is on
Mike Fiore 6:390fc83d588d 348 * @returns the pin the activity LED is using
Mike Fiore 6:390fc83d588d 349 */
Mike Fiore 6:390fc83d588d 350 PinName getActivityLedPin();
mfiore 0:c62615f15125 351
Mike Fiore 12:54f9cac9d690 352 /** Returns boolean indicative of start-up from standby mode
Mike Fiore 12:54f9cac9d690 353 * @returns true if dot woke from standby
Mike Fiore 12:54f9cac9d690 354 */
Mike Fiore 12:54f9cac9d690 355 bool getStandbyFlag();
Mike Fiore 12:54f9cac9d690 356
Mike Fiore 16:b630e18103e5 357 std::vector<uint16_t> getChannelMask();
Mike Fiore 16:b630e18103e5 358
Mike Fiore 16:b630e18103e5 359 int32_t setChannelMask(uint8_t offset, uint16_t mask);
Mike Fiore 16:b630e18103e5 360
Mike Fiore 12:54f9cac9d690 361 /** Add a channel frequencies currently in use
Mike Fiore 12:54f9cac9d690 362 * @returns MDOT_OK
Mike Fiore 12:54f9cac9d690 363 */
Mike Fiore 12:54f9cac9d690 364 int32_t addChannel(uint8_t index, uint32_t frequency, uint8_t datarateRange);
Mike Fiore 12:54f9cac9d690 365
mfiore 0:c62615f15125 366 /** Get list of channel frequencies currently in use
mfiore 0:c62615f15125 367 * @returns vector of channels currently in use
mfiore 0:c62615f15125 368 */
mfiore 0:c62615f15125 369 std::vector<uint32_t> getChannels();
mfiore 0:c62615f15125 370
Mike Fiore 12:54f9cac9d690 371 /** Get list of channel datarate ranges currently in use
Mike Fiore 12:54f9cac9d690 372 * @returns vector of datarate ranges currently in use
Mike Fiore 12:54f9cac9d690 373 */
Mike Fiore 12:54f9cac9d690 374 std::vector<uint8_t> getChannelRanges();
Mike Fiore 12:54f9cac9d690 375
Mike Fiore 12:54f9cac9d690 376 /** Get list of channel frequencies in config file to be used as session defaults
Mike Fiore 12:54f9cac9d690 377 * @returns vector of channels in config file
Mike Fiore 12:54f9cac9d690 378 */
Mike Fiore 12:54f9cac9d690 379 std::vector<uint32_t> getConfigChannels();
Mike Fiore 12:54f9cac9d690 380
Mike Fiore 12:54f9cac9d690 381 /** Get list of channel datarate ranges in config file to be used as session defaults
Mike Fiore 12:54f9cac9d690 382 * @returns vector of datarate ranges in config file
Mike Fiore 12:54f9cac9d690 383 */
Mike Fiore 12:54f9cac9d690 384 std::vector<uint8_t> getConfigChannelRanges();
Mike Fiore 12:54f9cac9d690 385
mfiore 0:c62615f15125 386 /** Get frequency band
mfiore 0:c62615f15125 387 * @returns FB_915 if configured for United States, FB_868 if configured for Europe
mfiore 0:c62615f15125 388 */
mfiore 0:c62615f15125 389 uint8_t getFrequencyBand();
mfiore 0:c62615f15125 390
mfiore 0:c62615f15125 391 /** Set frequency sub band
mfiore 0:c62615f15125 392 * only applicable if frequency band is set for United States (FB_915)
Jason Reiss 10:27dafba9fe19 393 * sub band 0 will allow the radio to use all 64 channels
mfiore 0:c62615f15125 394 * sub band 1 - 8 will allow the radio to use the 8 channels in that sub band
mfiore 0:c62615f15125 395 * for use with Conduit gateway and MTAC_LORA, use sub bands 1 - 8, not sub band 0
mfiore 0:c62615f15125 396 * @param band the sub band to use (0 - 8)
mfiore 0:c62615f15125 397 * @returns MDOT_OK if success
mfiore 0:c62615f15125 398 */
mfiore 0:c62615f15125 399 int32_t setFrequencySubBand(const uint8_t& band);
mfiore 0:c62615f15125 400
mfiore 0:c62615f15125 401 /** Get frequency sub band
mfiore 0:c62615f15125 402 * @returns frequency sub band currently in use
mfiore 0:c62615f15125 403 */
mfiore 0:c62615f15125 404 uint8_t getFrequencySubBand();
mfiore 0:c62615f15125 405
Mike Fiore 12:54f9cac9d690 406 /** Get the datarate currently in use within the MAC layer
Mike Fiore 12:54f9cac9d690 407 * returns 0-15
Mike Fiore 12:54f9cac9d690 408 */
Mike Fiore 12:54f9cac9d690 409 uint8_t getSessionDataRate();
Mike Fiore 12:54f9cac9d690 410
mfiore 0:c62615f15125 411 /** Enable/disable public network mode
Jason Reiss 10:27dafba9fe19 412 * JoinDelay will be set to (public: 5s, private: 1s) and
Jason Reiss 10:27dafba9fe19 413 * RxDelay will be set to 1s both can be adjusted afterwards
mfiore 0:c62615f15125 414 * @param on should be true to enable public network mode
mfiore 0:c62615f15125 415 * @returns MDOT_OK if success
mfiore 0:c62615f15125 416 */
mfiore 0:c62615f15125 417 int32_t setPublicNetwork(const bool& on);
mfiore 0:c62615f15125 418
mfiore 0:c62615f15125 419 /** Get public network mode
mfiore 0:c62615f15125 420 * @returns true if public network mode is enabled
mfiore 0:c62615f15125 421 */
mfiore 0:c62615f15125 422 bool getPublicNetwork();
mfiore 0:c62615f15125 423
mfiore 0:c62615f15125 424 /** Get the device ID
mfiore 0:c62615f15125 425 * @returns vector containing the device ID (size 8)
mfiore 0:c62615f15125 426 */
mfiore 0:c62615f15125 427 std::vector<uint8_t> getDeviceId();
mfiore 0:c62615f15125 428
Jason Reiss 10:27dafba9fe19 429 /** Get the device port to be used for lora application data (1-223)
Jason Reiss 10:27dafba9fe19 430 * @returns port
Jason Reiss 10:27dafba9fe19 431 */
Jason Reiss 10:27dafba9fe19 432 uint8_t getAppPort();
Jason Reiss 10:27dafba9fe19 433
Jason Reiss 10:27dafba9fe19 434 /** Set the device port to be used for lora application data (1-223)
Jason Reiss 10:27dafba9fe19 435 * @returns MDOT_OK if success
Jason Reiss 10:27dafba9fe19 436 */
Jason Reiss 10:27dafba9fe19 437 int32_t setAppPort(uint8_t port);
Jason Reiss 10:27dafba9fe19 438
Jason Reiss 10:27dafba9fe19 439 /** Set the device class A, B or C
Jason Reiss 10:27dafba9fe19 440 * @returns MDOT_OK if success
Jason Reiss 10:27dafba9fe19 441 */
Jason Reiss 10:27dafba9fe19 442 int32_t setClass(std::string newClass);
Jason Reiss 10:27dafba9fe19 443
Jason Reiss 10:27dafba9fe19 444 /** Get the device class A, B or C
Jason Reiss 10:27dafba9fe19 445 * @returns MDOT_OK if success
Jason Reiss 10:27dafba9fe19 446 */
Jason Reiss 10:27dafba9fe19 447 std::string getClass();
Jason Reiss 10:27dafba9fe19 448
Jason Reiss 10:27dafba9fe19 449 /** Get the max packet length with current settings
Jason Reiss 10:27dafba9fe19 450 * @returns max packet length
Jason Reiss 10:27dafba9fe19 451 */
Jason Reiss 10:27dafba9fe19 452 uint8_t getMaxPacketLength();
Jason Reiss 10:27dafba9fe19 453
mfiore 0:c62615f15125 454 /** Set network address
mfiore 0:c62615f15125 455 * for use with MANUAL network join mode, will be assigned in OTA & AUTO_OTA modes
mfiore 0:c62615f15125 456 * @param addr a vector of 4 bytes
mfiore 0:c62615f15125 457 * @returns MDOT_OK if success
mfiore 0:c62615f15125 458 */
mfiore 0:c62615f15125 459 int32_t setNetworkAddress(const std::vector<uint8_t>& addr);
mfiore 0:c62615f15125 460
mfiore 0:c62615f15125 461 /** Get network address
mfiore 0:c62615f15125 462 * @returns vector containing network address (size 4)
mfiore 0:c62615f15125 463 */
mfiore 0:c62615f15125 464 std::vector<uint8_t> getNetworkAddress();
mfiore 0:c62615f15125 465
mfiore 0:c62615f15125 466 /** Set network session key
mfiore 0:c62615f15125 467 * for use with MANUAL network join mode, will be assigned in OTA & AUTO_OTA modes
mfiore 0:c62615f15125 468 * @param key a vector of 16 bytes
mfiore 0:c62615f15125 469 * @returns MDOT_OK if success
mfiore 0:c62615f15125 470 */
mfiore 0:c62615f15125 471 int32_t setNetworkSessionKey(const std::vector<uint8_t>& key);
mfiore 0:c62615f15125 472
mfiore 0:c62615f15125 473 /** Get network session key
mfiore 0:c62615f15125 474 * @returns vector containing network session key (size 16)
mfiore 0:c62615f15125 475 */
mfiore 0:c62615f15125 476 std::vector<uint8_t> getNetworkSessionKey();
mfiore 0:c62615f15125 477
mfiore 0:c62615f15125 478 /** Set data session key
mfiore 0:c62615f15125 479 * for use with MANUAL network join mode, will be assigned in OTA & AUTO_OTA modes
mfiore 0:c62615f15125 480 * @param key a vector of 16 bytes
mfiore 0:c62615f15125 481 * @returns MDOT_OK if success
mfiore 0:c62615f15125 482 */
mfiore 0:c62615f15125 483 int32_t setDataSessionKey(const std::vector<uint8_t>& key);
mfiore 0:c62615f15125 484
mfiore 0:c62615f15125 485 /** Get data session key
mfiore 0:c62615f15125 486 * @returns vector containing data session key (size 16)
mfiore 0:c62615f15125 487 */
mfiore 0:c62615f15125 488 std::vector<uint8_t> getDataSessionKey();
mfiore 0:c62615f15125 489
mfiore 0:c62615f15125 490 /** Set network name
mfiore 0:c62615f15125 491 * for use with OTA & AUTO_OTA network join modes
mfiore 0:c62615f15125 492 * generates network ID (crc64 of name) automatically
mfiore 0:c62615f15125 493 * @param name a string of of at least 8 bytes and no more than 128 bytes
mfiore 0:c62615f15125 494 * @return MDOT_OK if success
mfiore 0:c62615f15125 495 */
mfiore 0:c62615f15125 496 int32_t setNetworkName(const std::string& name);
mfiore 0:c62615f15125 497
mfiore 0:c62615f15125 498 /** Get network name
mfiore 0:c62615f15125 499 * @return string containing network name (size 8 to 128)
mfiore 0:c62615f15125 500 */
mfiore 0:c62615f15125 501 std::string getNetworkName();
mfiore 0:c62615f15125 502
mfiore 0:c62615f15125 503 /** Set network ID
mfiore 0:c62615f15125 504 * for use with OTA & AUTO_OTA network join modes
mfiore 0:c62615f15125 505 * setting network ID via this function sets network name to empty
mfiore 0:c62615f15125 506 * @param id a vector of 8 bytes
mfiore 0:c62615f15125 507 * @returns MDOT_OK if success
mfiore 0:c62615f15125 508 */
mfiore 0:c62615f15125 509 int32_t setNetworkId(const std::vector<uint8_t>& id);
mfiore 0:c62615f15125 510
mfiore 0:c62615f15125 511 /** Get network ID
mfiore 0:c62615f15125 512 * @returns vector containing network ID (size 8)
mfiore 0:c62615f15125 513 */
mfiore 0:c62615f15125 514 std::vector<uint8_t> getNetworkId();
mfiore 0:c62615f15125 515
mfiore 0:c62615f15125 516 /** Set network passphrase
mfiore 0:c62615f15125 517 * for use with OTA & AUTO_OTA network join modes
mfiore 0:c62615f15125 518 * generates network key (cmac of passphrase) automatically
mfiore 0:c62615f15125 519 * @param name a string of of at least 8 bytes and no more than 128 bytes
mfiore 0:c62615f15125 520 * @return MDOT_OK if success
mfiore 0:c62615f15125 521 */
mfiore 0:c62615f15125 522 int32_t setNetworkPassphrase(const std::string& passphrase);
mfiore 0:c62615f15125 523
mfiore 0:c62615f15125 524 /** Get network passphrase
mfiore 0:c62615f15125 525 * @return string containing network passphrase (size 8 to 128)
mfiore 0:c62615f15125 526 */
mfiore 0:c62615f15125 527 std::string getNetworkPassphrase();
mfiore 0:c62615f15125 528
mfiore 0:c62615f15125 529 /** Set network key
mfiore 0:c62615f15125 530 * for use with OTA & AUTO_OTA network join modes
mfiore 0:c62615f15125 531 * setting network key via this function sets network passphrase to empty
mfiore 0:c62615f15125 532 * @param id a vector of 16 bytes
mfiore 0:c62615f15125 533 * @returns MDOT_OK if success
mfiore 0:c62615f15125 534 */
mfiore 0:c62615f15125 535 int32_t setNetworkKey(const std::vector<uint8_t>& id);
mfiore 0:c62615f15125 536
mfiore 0:c62615f15125 537 /** Get network key
mfiore 0:c62615f15125 538 * @returns a vector containing network key (size 16)
mfiore 0:c62615f15125 539 */
mfiore 0:c62615f15125 540 std::vector<uint8_t> getNetworkKey();
mfiore 0:c62615f15125 541
Mike Fiore 6:390fc83d588d 542 /** Set join byte order
Mike Fiore 6:390fc83d588d 543 * @param order 0:LSB 1:MSB
Mike Fiore 6:390fc83d588d 544 */
Mike Fiore 6:390fc83d588d 545 uint32_t setJoinByteOrder(uint8_t order);
Mike Fiore 6:390fc83d588d 546
Mike Fiore 6:390fc83d588d 547 /** Get join byte order
Mike Fiore 6:390fc83d588d 548 * @returns byte order to use in joins 0:LSB 1:MSB
Mike Fiore 6:390fc83d588d 549 */
Mike Fiore 6:390fc83d588d 550 uint8_t getJoinByteOrder();
Mike Fiore 6:390fc83d588d 551
mfiore 0:c62615f15125 552 /** Attempt to join network
Mike Fiore 12:54f9cac9d690 553 * each attempt will be made with a random datarate up to the configured datarate
Mike Fiore 12:54f9cac9d690 554 * 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 555 * Check getNextTxMs() for time until next join attempt can be made
mfiore 0:c62615f15125 556 * @returns MDOT_OK if success
mfiore 0:c62615f15125 557 */
mfiore 0:c62615f15125 558 int32_t joinNetwork();
mfiore 0:c62615f15125 559
mfiore 0:c62615f15125 560 /** Attempts to join network once
mfiore 0:c62615f15125 561 * @returns MDOT_OK if success
mfiore 0:c62615f15125 562 */
mfiore 0:c62615f15125 563 int32_t joinNetworkOnce();
mfiore 0:c62615f15125 564
mfiore 0:c62615f15125 565 /** Resets current network session, essentially disconnecting from the network
mfiore 0:c62615f15125 566 * has no effect for MANUAL network join mode
mfiore 0:c62615f15125 567 */
mfiore 0:c62615f15125 568 void resetNetworkSession();
mfiore 0:c62615f15125 569
Mike Fiore 12:54f9cac9d690 570 /** Restore saved network session from flash
Mike Fiore 12:54f9cac9d690 571 * has no effect for MANUAL network join mode
Mike Fiore 12:54f9cac9d690 572 */
Mike Fiore 12:54f9cac9d690 573 void restoreNetworkSession();
Mike Fiore 12:54f9cac9d690 574
Mike Fiore 12:54f9cac9d690 575 /** Save current network session to flash
Mike Fiore 12:54f9cac9d690 576 * has no effect for MANUAL network join mode
Mike Fiore 12:54f9cac9d690 577 */
Mike Fiore 12:54f9cac9d690 578 void saveNetworkSession();
Mike Fiore 12:54f9cac9d690 579
jreiss 17:306ffaa5d79b 580 /** Set number of times joining will retry each sub-band before changing
jreiss 17:306ffaa5d79b 581 * to the next subband in US915 and AU915
mfiore 0:c62615f15125 582 * @param retries must be between 0 - 255
mfiore 0:c62615f15125 583 * @returns MDOT_OK if success
mfiore 0:c62615f15125 584 */
mfiore 0:c62615f15125 585 int32_t setJoinRetries(const uint8_t& retries);
mfiore 0:c62615f15125 586
jreiss 17:306ffaa5d79b 587 /** Get number of times joining will retry each sub-band
mfiore 0:c62615f15125 588 * @returns join retries (0 - 255)
mfiore 0:c62615f15125 589 */
mfiore 0:c62615f15125 590 uint8_t getJoinRetries();
mfiore 0:c62615f15125 591
mfiore 0:c62615f15125 592 /** Set network join mode
mfiore 0:c62615f15125 593 * MANUAL: set network address and session keys manually
mfiore 0:c62615f15125 594 * OTA: User sets network name and passphrase, then attempts to join
mfiore 0:c62615f15125 595 * AUTO_OTA: same as OTA, but network sessions can be saved and restored
mfiore 0:c62615f15125 596 * @param mode MANUAL, OTA, or AUTO_OTA
mfiore 0:c62615f15125 597 * @returns MDOT_OK if success
mfiore 0:c62615f15125 598 */
mfiore 0:c62615f15125 599 int32_t setJoinMode(const uint8_t& mode);
mfiore 0:c62615f15125 600
mfiore 0:c62615f15125 601 /** Get network join mode
mfiore 0:c62615f15125 602 * @returns MANUAL, OTA, or AUTO_OTA
mfiore 0:c62615f15125 603 */
mfiore 0:c62615f15125 604 uint8_t getJoinMode();
mfiore 0:c62615f15125 605
mfiore 0:c62615f15125 606 /** Get network join status
mfiore 0:c62615f15125 607 * @returns true if currently joined to network
mfiore 0:c62615f15125 608 */
mfiore 0:c62615f15125 609 bool getNetworkJoinStatus();
mfiore 0:c62615f15125 610
mfiore 0:c62615f15125 611 /** Do a network link check
mfiore 0:c62615f15125 612 * application data may be returned in response to a network link check command
mfiore 0:c62615f15125 613 * @returns link_check structure containing success, dBm above noise floor, gateways in range, and packet payload
mfiore 0:c62615f15125 614 */
mfiore 0:c62615f15125 615 link_check networkLinkCheck();
mfiore 0:c62615f15125 616
mfiore 0:c62615f15125 617 /** Set network link check count to perform automatic link checks every count packets
mfiore 0:c62615f15125 618 * only applicable if ACKs are disabled
mfiore 0:c62615f15125 619 * @param count must be between 0 - 255
mfiore 0:c62615f15125 620 * @returns MDOT_OK if success
mfiore 0:c62615f15125 621 */
mfiore 0:c62615f15125 622 int32_t setLinkCheckCount(const uint8_t& count);
mfiore 0:c62615f15125 623
mfiore 0:c62615f15125 624 /** Get network link check count
mfiore 0:c62615f15125 625 * @returns count (0 - 255)
mfiore 0:c62615f15125 626 */
mfiore 0:c62615f15125 627 uint8_t getLinkCheckCount();
mfiore 0:c62615f15125 628
mfiore 0:c62615f15125 629 /** Set network link check threshold, number of link check failures or missed acks to tolerate
mfiore 0:c62615f15125 630 * before considering network connection lost
mfiore 0:c62615f15125 631 * @pararm count must be between 0 - 255
mfiore 0:c62615f15125 632 * @returns MDOT_OK if success
mfiore 0:c62615f15125 633 */
mfiore 0:c62615f15125 634 int32_t setLinkCheckThreshold(const uint8_t& count);
mfiore 0:c62615f15125 635
mfiore 0:c62615f15125 636 /** Get network link check threshold
mfiore 0:c62615f15125 637 * @returns threshold (0 - 255)
mfiore 0:c62615f15125 638 */
mfiore 0:c62615f15125 639 uint8_t getLinkCheckThreshold();
mfiore 0:c62615f15125 640
Mike Fiore 12:54f9cac9d690 641 /** Get/set number of failed link checks in the current session
Mike Fiore 12:54f9cac9d690 642 * @returns count (0 - 255)
Mike Fiore 12:54f9cac9d690 643 */
Mike Fiore 12:54f9cac9d690 644 uint8_t getLinkFailCount();
Mike Fiore 12:54f9cac9d690 645 int32_t setLinkFailCount(uint8_t count);
Mike Fiore 12:54f9cac9d690 646
Mike Fiore 12:54f9cac9d690 647 /** Set UpLinkCounter number of packets sent to the gateway during this network session (sequence number)
Mike Fiore 12:54f9cac9d690 648 * @returns MDOT_OK
Mike Fiore 12:54f9cac9d690 649 */
Mike Fiore 12:54f9cac9d690 650 int32_t setUpLinkCounter(uint32_t count);
Mike Fiore 12:54f9cac9d690 651
mfiore 0:c62615f15125 652 /** Get UpLinkCounter
mfiore 0:c62615f15125 653 * @returns number of packets sent to the gateway during this network session (sequence number)
mfiore 0:c62615f15125 654 */
mfiore 0:c62615f15125 655 uint32_t getUpLinkCounter();
mfiore 0:c62615f15125 656
Mike Fiore 12:54f9cac9d690 657 /** Set UpLinkCounter number of packets sent by the gateway during this network session (sequence number)
Mike Fiore 12:54f9cac9d690 658 * @returns MDOT_OK
Mike Fiore 12:54f9cac9d690 659 */
Mike Fiore 12:54f9cac9d690 660 int32_t setDownLinkCounter(uint32_t count);
Mike Fiore 12:54f9cac9d690 661
Mike Fiore 12:54f9cac9d690 662 /** Get DownLinkCounter
Mike Fiore 12:54f9cac9d690 663 * @returns number of packets sent by the gateway during this network session (sequence number)
Mike Fiore 12:54f9cac9d690 664 */
Mike Fiore 12:54f9cac9d690 665 uint32_t getDownLinkCounter();
Mike Fiore 12:54f9cac9d690 666
mfiore 0:c62615f15125 667 /** Enable/disable AES encryption
mfiore 0:c62615f15125 668 * AES encryption must be enabled for use with Conduit gateway and MTAC_LORA card
mfiore 0:c62615f15125 669 * @param on true for AES encryption to be enabled
mfiore 0:c62615f15125 670 * @returns MDOT_OK if success
mfiore 0:c62615f15125 671 */
mfiore 0:c62615f15125 672 int32_t setAesEncryption(const bool& on);
mfiore 0:c62615f15125 673
mfiore 0:c62615f15125 674 /** Get AES encryption
mfiore 0:c62615f15125 675 * @returns true if AES encryption is enabled
mfiore 0:c62615f15125 676 */
mfiore 0:c62615f15125 677 bool getAesEncryption();
mfiore 0:c62615f15125 678
mfiore 0:c62615f15125 679 /** Get RSSI stats
Mike Fiore 11:d8464345e1f1 680 * @returns rssi_stats struct containing last, min, max, and avg RSSI in dB
mfiore 0:c62615f15125 681 */
mfiore 0:c62615f15125 682 rssi_stats getRssiStats();
mfiore 0:c62615f15125 683
mfiore 0:c62615f15125 684 /** Get SNR stats
Mike Fiore 11:d8464345e1f1 685 * @returns snr_stats struct containing last, min, max, and avg SNR in cB
mfiore 0:c62615f15125 686 */
mfiore 0:c62615f15125 687 snr_stats getSnrStats();
mfiore 0:c62615f15125 688
mfiore 0:c62615f15125 689 /** Get ms until next free channel
mfiore 0:c62615f15125 690 * only applicable for European models, US models return 0
mfiore 0:c62615f15125 691 * @returns time (ms) until a channel is free to use for transmitting
mfiore 0:c62615f15125 692 */
mfiore 0:c62615f15125 693 uint32_t getNextTxMs();
mfiore 0:c62615f15125 694
Jason Reiss 10:27dafba9fe19 695 /** Get join delay in seconds
Jason Reiss 10:27dafba9fe19 696 * Public network defaults to 5 seconds
Jason Reiss 10:27dafba9fe19 697 * Private network defaults to 1 second
Jason Reiss 10:27dafba9fe19 698 * @returns number of seconds before join accept message is expected
Jason Reiss 10:27dafba9fe19 699 */
Jason Reiss 10:27dafba9fe19 700 uint8_t getJoinDelay();
Jason Reiss 10:27dafba9fe19 701
Jason Reiss 10:27dafba9fe19 702 /** Set join delay in seconds
Jason Reiss 10:27dafba9fe19 703 * Public network defaults to 5 seconds
Jason Reiss 10:27dafba9fe19 704 * Private network defaults to 1 second
Jason Reiss 10:27dafba9fe19 705 * @param delay number of seconds before join accept message is expected
Jason Reiss 10:27dafba9fe19 706 * @return MDOT_OK if success
Jason Reiss 10:27dafba9fe19 707 */
Jason Reiss 10:27dafba9fe19 708 uint32_t setJoinDelay(uint8_t delay);
Jason Reiss 10:27dafba9fe19 709
Mike Fiore 16:b630e18103e5 710 /** Get join Rx1 datarate offset
Mike Fiore 16:b630e18103e5 711 * defaults to 0
Mike Fiore 16:b630e18103e5 712 * @returns offset
Mike Fiore 16:b630e18103e5 713 */
Mike Fiore 16:b630e18103e5 714 uint8_t getJoinRx1DataRateOffset();
Mike Fiore 16:b630e18103e5 715
Mike Fiore 16:b630e18103e5 716 /** Set join Rx1 datarate offset
Mike Fiore 16:b630e18103e5 717 * @param offset for datarate
Mike Fiore 16:b630e18103e5 718 * @return MDOT_OK if success
Mike Fiore 16:b630e18103e5 719 */
Mike Fiore 16:b630e18103e5 720 uint32_t setJoinRx1DataRateOffset(uint8_t offset);
Mike Fiore 16:b630e18103e5 721
Mike Fiore 16:b630e18103e5 722 /** Get join Rx2 datarate
Mike Fiore 16:b630e18103e5 723 * defaults to US:DR8, AU:DR8, EU:DR0
Mike Fiore 16:b630e18103e5 724 * @returns datarate
Mike Fiore 16:b630e18103e5 725 */
Mike Fiore 16:b630e18103e5 726 uint8_t getJoinRx2DataRate();
Mike Fiore 16:b630e18103e5 727
Mike Fiore 16:b630e18103e5 728 /** Set join Rx2 datarate
Mike Fiore 16:b630e18103e5 729 * @param datarate
Mike Fiore 16:b630e18103e5 730 * @return MDOT_OK if success
Mike Fiore 16:b630e18103e5 731 */
Mike Fiore 16:b630e18103e5 732 uint32_t setJoinRx2DataRate(uint8_t datarate);
Mike Fiore 16:b630e18103e5 733
Mike Fiore 16:b630e18103e5 734 /** Get join Rx2 frequency
Mike Fiore 16:b630e18103e5 735 * defaults US:923.3, AU:923.3, EU:869.525
Mike Fiore 16:b630e18103e5 736 * @returns frequency
Mike Fiore 16:b630e18103e5 737 */
Mike Fiore 16:b630e18103e5 738 uint32_t getJoinRx2Frequency();
Mike Fiore 16:b630e18103e5 739
Mike Fiore 16:b630e18103e5 740 /** Set join Rx2 frequency
Mike Fiore 16:b630e18103e5 741 * @param frequency
Mike Fiore 16:b630e18103e5 742 * @return MDOT_OK if success
Mike Fiore 16:b630e18103e5 743 */
Mike Fiore 16:b630e18103e5 744 uint32_t setJoinRx2Frequency(uint32_t frequency);
Mike Fiore 16:b630e18103e5 745
Jason Reiss 10:27dafba9fe19 746 /** Get rx delay in seconds
Jason Reiss 10:27dafba9fe19 747 * Defaults to 1 second
Jason Reiss 10:27dafba9fe19 748 * @returns number of seconds before response message is expected
Jason Reiss 10:27dafba9fe19 749 */
Jason Reiss 10:27dafba9fe19 750 uint8_t getRxDelay();
Jason Reiss 10:27dafba9fe19 751
Jason Reiss 10:27dafba9fe19 752 /** Set rx delay in seconds
Jason Reiss 10:27dafba9fe19 753 * Defaults to 1 second
Jason Reiss 10:27dafba9fe19 754 * @param delay number of seconds before response message is expected
Jason Reiss 10:27dafba9fe19 755 * @return MDOT_OK if success
Jason Reiss 10:27dafba9fe19 756 */
Jason Reiss 10:27dafba9fe19 757 uint32_t setRxDelay(uint8_t delay);
Jason Reiss 10:27dafba9fe19 758
Jason Reiss 10:27dafba9fe19 759 /** Get preserve session to save network session info through reset or power down in AUTO_OTA mode
Jason Reiss 10:27dafba9fe19 760 * Defaults to off
Jason Reiss 10:27dafba9fe19 761 * @returns true if enabled
Jason Reiss 10:27dafba9fe19 762 */
Jason Reiss 10:27dafba9fe19 763 bool getPreserveSession();
Jason Reiss 10:27dafba9fe19 764
Jason Reiss 10:27dafba9fe19 765 /** Set preserve session to save network session info through reset or power down in AUTO_OTA mode
Jason Reiss 10:27dafba9fe19 766 * Defaults to off
Jason Reiss 10:27dafba9fe19 767 * @param enable
Jason Reiss 10:27dafba9fe19 768 * @return MDOT_OK if success
Jason Reiss 10:27dafba9fe19 769 */
Jason Reiss 10:27dafba9fe19 770 uint32_t setPreserveSession(bool enable);
Jason Reiss 10:27dafba9fe19 771
mfiore 0:c62615f15125 772 /** Get data pending
mfiore 0:c62615f15125 773 * only valid after sending data to the gateway
mfiore 0:c62615f15125 774 * @returns true if server has available packet(s)
mfiore 0:c62615f15125 775 */
mfiore 0:c62615f15125 776 bool getDataPending();
mfiore 0:c62615f15125 777
Mike Fiore 16:b630e18103e5 778 /** Get ack requested
Mike Fiore 16:b630e18103e5 779 * only valid after sending data to the gateway
Mike Fiore 16:b630e18103e5 780 * @returns true if server has requested ack
Mike Fiore 16:b630e18103e5 781 */
Mike Fiore 16:b630e18103e5 782 bool getAckRequested();
Mike Fiore 16:b630e18103e5 783
Mike Fiore 16:b630e18103e5 784 /** Get is transmitting indicator
mfiore 0:c62615f15125 785 * @returns true if currently transmitting
mfiore 0:c62615f15125 786 */
mfiore 0:c62615f15125 787 bool getIsTransmitting();
mfiore 0:c62615f15125 788
Mike Fiore 16:b630e18103e5 789 /** Get is idle indicator
Mike Fiore 16:b630e18103e5 790 * @returns true if not currently transmitting, waiting or receiving
Mike Fiore 16:b630e18103e5 791 */
Mike Fiore 16:b630e18103e5 792 bool getIsIdle();
Mike Fiore 16:b630e18103e5 793
mfiore 0:c62615f15125 794 /** Set TX data rate
mfiore 0:c62615f15125 795 * data rates affect maximum payload size
Mike Fiore 11:d8464345e1f1 796 * @param dr SF_7 - SF_12|DR0-DR7 for Europe, SF_7 - SF_10 | DR0-DR4 for United States
mfiore 0:c62615f15125 797 * @returns MDOT_OK if success
mfiore 0:c62615f15125 798 */
mfiore 0:c62615f15125 799 int32_t setTxDataRate(const uint8_t& dr);
mfiore 0:c62615f15125 800
mfiore 0:c62615f15125 801 /** Get TX data rate
Mike Fiore 11:d8464345e1f1 802 * @returns current TX data rate (DR0-DR15)
mfiore 0:c62615f15125 803 */
mfiore 0:c62615f15125 804 uint8_t getTxDataRate();
mfiore 0:c62615f15125 805
Mike Fiore 12:54f9cac9d690 806 /** Get a random value from the radio based on RSSI
Mike Fiore 12:54f9cac9d690 807 * @returns randome value
Mike Fiore 12:54f9cac9d690 808 */
Mike Fiore 12:54f9cac9d690 809 uint32_t getRadioRandom();
Mike Fiore 12:54f9cac9d690 810
Mike Fiore 11:d8464345e1f1 811 /** Get data rate spreading factor and bandwidth
Mike Fiore 11:d8464345e1f1 812 * EU868 Datarates
Mike Fiore 11:d8464345e1f1 813 * ---------------
Mike Fiore 11:d8464345e1f1 814 * DR0 - SF12BW125
Mike Fiore 11:d8464345e1f1 815 * DR1 - SF11BW125
Mike Fiore 11:d8464345e1f1 816 * DR2 - SF10BW125
Mike Fiore 11:d8464345e1f1 817 * DR3 - SF9BW125
Mike Fiore 11:d8464345e1f1 818 * DR4 - SF8BW125
Mike Fiore 11:d8464345e1f1 819 * DR5 - SF7BW125
Mike Fiore 11:d8464345e1f1 820 * DR6 - SF7BW250
Mike Fiore 11:d8464345e1f1 821 * DR7 - FSK
Mike Fiore 11:d8464345e1f1 822 *
Mike Fiore 11:d8464345e1f1 823 * US915 Datarates
Mike Fiore 11:d8464345e1f1 824 * ---------------
Mike Fiore 11:d8464345e1f1 825 * DR0 - SF10BW125
Mike Fiore 11:d8464345e1f1 826 * DR1 - SF9BW125
Mike Fiore 11:d8464345e1f1 827 * DR2 - SF8BW125
Mike Fiore 11:d8464345e1f1 828 * DR3 - SF7BW125
Mike Fiore 11:d8464345e1f1 829 * DR4 - SF8BW500
Mike Fiore 11:d8464345e1f1 830 *
jreiss 17:306ffaa5d79b 831 * AU915 Datarates
jreiss 17:306ffaa5d79b 832 * ---------------
jreiss 17:306ffaa5d79b 833 * DR0 - SF10BW125
jreiss 17:306ffaa5d79b 834 * DR1 - SF9BW125
jreiss 17:306ffaa5d79b 835 * DR2 - SF8BW125
jreiss 17:306ffaa5d79b 836 * DR3 - SF7BW125
jreiss 17:306ffaa5d79b 837 * DR4 - SF8BW500
jreiss 17:306ffaa5d79b 838 *
Mike Fiore 11:d8464345e1f1 839 * @returns spreading factor and bandwidth
Mike Fiore 11:d8464345e1f1 840 */
Mike Fiore 11:d8464345e1f1 841 std::string getDateRateDetails(uint8_t rate);
Mike Fiore 11:d8464345e1f1 842
Mike Fiore 12:54f9cac9d690 843 /** Set TX power output of radio before antenna gain, default: 14 dBm
Mike Fiore 12:54f9cac9d690 844 * actual output power may be limited by local regulations for the chosen frequency
mfiore 0:c62615f15125 845 * power affects maximum range
mfiore 0:c62615f15125 846 * @param power 2 dBm - 20 dBm
mfiore 0:c62615f15125 847 * @returns MDOT_OK if success
mfiore 0:c62615f15125 848 */
mfiore 0:c62615f15125 849 int32_t setTxPower(const uint32_t& power);
mfiore 0:c62615f15125 850
mfiore 0:c62615f15125 851 /** Get TX power
mfiore 0:c62615f15125 852 * @returns TX power (2 dBm - 20 dBm)
mfiore 0:c62615f15125 853 */
mfiore 0:c62615f15125 854 uint32_t getTxPower();
mfiore 0:c62615f15125 855
Mike Fiore 12:54f9cac9d690 856 /** Get configured gain of installed antenna, default: +3 dBi
Mike Fiore 11:d8464345e1f1 857 * @returns gain of antenna in dBi
Mike Fiore 11:d8464345e1f1 858 */
Mike Fiore 11:d8464345e1f1 859 int8_t getAntennaGain();
Mike Fiore 11:d8464345e1f1 860
Mike Fiore 12:54f9cac9d690 861 /** Set configured gain of installed antenna, default: +3 dBi
Mike Fiore 11:d8464345e1f1 862 * @param gain -127 dBi - 128 dBi
Mike Fiore 11:d8464345e1f1 863 * @returns MDOT_OK if success
Mike Fiore 11:d8464345e1f1 864 */
Mike Fiore 11:d8464345e1f1 865 int32_t setAntennaGain(int8_t gain);
Mike Fiore 11:d8464345e1f1 866
mfiore 0:c62615f15125 867 /** Enable/disable TX waiting for rx windows
mfiore 0:c62615f15125 868 * when enabled, send calls will block until a packet is received or RX timeout
mfiore 0:c62615f15125 869 * @param enable set to true if expecting responses to transmitted packets
mfiore 0:c62615f15125 870 * @returns MDOT_OK if success
mfiore 0:c62615f15125 871 */
mfiore 0:c62615f15125 872 int32_t setTxWait(const bool& enable);
mfiore 0:c62615f15125 873
mfiore 0:c62615f15125 874 /** Get TX wait
mfiore 0:c62615f15125 875 * @returns true if TX wait is enabled
mfiore 0:c62615f15125 876 */
mfiore 0:c62615f15125 877 bool getTxWait();
mfiore 0:c62615f15125 878
Mike Fiore 16:b630e18103e5 879 /** Cancel pending rx windows
Mike Fiore 16:b630e18103e5 880 */
Mike Fiore 16:b630e18103e5 881 void cancelRxWindow();
Mike Fiore 16:b630e18103e5 882
mfiore 0:c62615f15125 883 /** Get time on air
mfiore 0:c62615f15125 884 * @returns the amount of time (in ms) it would take to send bytes bytes based on current configuration
mfiore 0:c62615f15125 885 */
mfiore 0:c62615f15125 886 uint32_t getTimeOnAir(uint8_t bytes);
mfiore 0:c62615f15125 887
mfiore 0:c62615f15125 888 /** Get min frequency
mfiore 0:c62615f15125 889 * @returns minimum frequency based on current configuration
mfiore 0:c62615f15125 890 */
mfiore 0:c62615f15125 891 uint32_t getMinFrequency();
mfiore 0:c62615f15125 892
mfiore 0:c62615f15125 893 /** Get max frequency
mfiore 0:c62615f15125 894 * @returns maximum frequency based on current configuration
mfiore 0:c62615f15125 895 */
mfiore 0:c62615f15125 896 uint32_t getMaxFrequency();
mfiore 0:c62615f15125 897
Mike Fiore 12:54f9cac9d690 898 // get/set adaptive data rate
Mike Fiore 12:54f9cac9d690 899 // configure data rates and power levels based on signal to noise of packets received at gateway
Mike Fiore 12:54f9cac9d690 900 // true == adaptive data rate is on
Mike Fiore 12:54f9cac9d690 901 // set function returns MDOT_OK if success
Mike Fiore 12:54f9cac9d690 902 int32_t setAdr(const bool& on);
Mike Fiore 12:54f9cac9d690 903 bool getAdr();
Mike Fiore 12:54f9cac9d690 904
mfiore 0:c62615f15125 905 /** Set forward error correction bytes
mfiore 0:c62615f15125 906 * @param bytes 1 - 4 bytes
mfiore 0:c62615f15125 907 * @returns MDOT_OK if success
mfiore 0:c62615f15125 908 */
mfiore 0:c62615f15125 909 int32_t setFec(const uint8_t& bytes);
mfiore 0:c62615f15125 910
mfiore 0:c62615f15125 911 /** Get forward error correction bytes
mfiore 0:c62615f15125 912 * @returns bytes (1 - 4)
mfiore 0:c62615f15125 913 */
mfiore 0:c62615f15125 914 uint8_t getFec();
mfiore 0:c62615f15125 915
mfiore 0:c62615f15125 916 /** Enable/disable CRC checking of packets
mfiore 0:c62615f15125 917 * CRC checking must be enabled for use with Conduit gateway and MTAC_LORA card
mfiore 0:c62615f15125 918 * @param on set to true to enable CRC checking
mfiore 0:c62615f15125 919 * @returns MDOT_OK if success
mfiore 0:c62615f15125 920 */
mfiore 0:c62615f15125 921 int32_t setCrc(const bool& on);
mfiore 0:c62615f15125 922
mfiore 0:c62615f15125 923 /** Get CRC checking
mfiore 0:c62615f15125 924 * @returns true if CRC checking is enabled
mfiore 0:c62615f15125 925 */
mfiore 0:c62615f15125 926 bool getCrc();
mfiore 0:c62615f15125 927
mfiore 0:c62615f15125 928 /** Set ack
mfiore 0:c62615f15125 929 * @param retries 0 to disable acks, otherwise 1 - 8
mfiore 0:c62615f15125 930 * @returns MDOT_OK if success
mfiore 0:c62615f15125 931 */
mfiore 0:c62615f15125 932 int32_t setAck(const uint8_t& retries);
mfiore 0:c62615f15125 933
mfiore 0:c62615f15125 934 /** Get ack
mfiore 0:c62615f15125 935 * @returns 0 if acks are disabled, otherwise retries (1 - 8)
mfiore 0:c62615f15125 936 */
mfiore 0:c62615f15125 937 uint8_t getAck();
mfiore 0:c62615f15125 938
Mike Fiore 12:54f9cac9d690 939 /** Set number of packet repeats for unconfirmed frames
Mike Fiore 12:54f9cac9d690 940 * @param repeat 0 or 1 for no repeats, otherwise 2-15
Mike Fiore 12:54f9cac9d690 941 * @returns MDOT_OK if success
Mike Fiore 12:54f9cac9d690 942 */
Mike Fiore 12:54f9cac9d690 943 int32_t setRepeat(const uint8_t& repeat);
Mike Fiore 12:54f9cac9d690 944
Mike Fiore 12:54f9cac9d690 945 /** Get number of packet repeats for unconfirmed frames
Mike Fiore 12:54f9cac9d690 946 * @returns 0 or 1 if no repeats, otherwise 2-15
Mike Fiore 12:54f9cac9d690 947 */
Mike Fiore 12:54f9cac9d690 948 uint8_t getRepeat();
Mike Fiore 12:54f9cac9d690 949
mfiore 0:c62615f15125 950 /** Send data to the gateway
mfiore 0:c62615f15125 951 * validates data size (based on spreading factor)
mfiore 0:c62615f15125 952 * @param data a vector of up to 242 bytes (may be less based on spreading factor)
mfiore 0:c62615f15125 953 * @returns MDOT_OK if packet was sent successfully (ACKs disabled), or if an ACK was received (ACKs enabled)
mfiore 0:c62615f15125 954 */
mfiore 0:c62615f15125 955 int32_t send(const std::vector<uint8_t>& data, const bool& blocking = true, const bool& highBw = false);
mfiore 0:c62615f15125 956
Mike Fiore 16:b630e18103e5 957 /** Inject mac command
Mike Fiore 16:b630e18103e5 958 * @param data a vector containing mac commands
Mike Fiore 16:b630e18103e5 959 * @returns MDOT_OK
Mike Fiore 16:b630e18103e5 960 */
Mike Fiore 16:b630e18103e5 961 int32_t injectMacCommand(const std::vector<uint8_t>& data);
Mike Fiore 16:b630e18103e5 962
Mike Fiore 16:b630e18103e5 963 /**
Mike Fiore 16:b630e18103e5 964 * Clear MAC command buffer to be sent in next uplink
Mike Fiore 16:b630e18103e5 965 * @returns MDOT_OK
Mike Fiore 16:b630e18103e5 966 */
Mike Fiore 16:b630e18103e5 967 int32_t clearMacCommands();
Mike Fiore 16:b630e18103e5 968
Mike Fiore 16:b630e18103e5 969 /**
Mike Fiore 16:b630e18103e5 970 * Get MAC command buffer to be sent in next uplink
Mike Fiore 16:b630e18103e5 971 * @returns command bytes
Mike Fiore 16:b630e18103e5 972 */
Mike Fiore 16:b630e18103e5 973 std::vector<uint8_t> getMacCommands();
Mike Fiore 16:b630e18103e5 974
mfiore 0:c62615f15125 975 /** Fetch data received from the gateway
mfiore 0:c62615f15125 976 * this function only checks to see if a packet has been received - it does not open a receive window
mfiore 0:c62615f15125 977 * send() must be called before recv()
mfiore 0:c62615f15125 978 * @param data a vector to put the received data into
mfiore 0:c62615f15125 979 * @returns MDOT_OK if packet was successfully received
mfiore 0:c62615f15125 980 */
mfiore 0:c62615f15125 981 int32_t recv(std::vector<uint8_t>& data);
mfiore 0:c62615f15125 982
mfiore 0:c62615f15125 983 /** Ping
mfiore 0:c62615f15125 984 * status will be MDOT_OK if ping succeeded
mfiore 0:c62615f15125 985 * @returns ping_response struct containing status, RSSI, and SNR
mfiore 0:c62615f15125 986 */
mfiore 0:c62615f15125 987 ping_response ping();
mfiore 0:c62615f15125 988
mfiore 0:c62615f15125 989 /** Get return code string
mfiore 0:c62615f15125 990 * @returns string containing a description of the given error code
mfiore 0:c62615f15125 991 */
mfiore 0:c62615f15125 992 static std::string getReturnCodeString(const int32_t& code);
mfiore 0:c62615f15125 993
mfiore 0:c62615f15125 994 /** Get last error
mfiore 0:c62615f15125 995 * @returns string explaining the last error that occured
mfiore 0:c62615f15125 996 */
mfiore 0:c62615f15125 997 std::string getLastError();
mfiore 0:c62615f15125 998
Mike Fiore 7:683dba5d576f 999 /** Go to sleep
Jason Reiss 10:27dafba9fe19 1000 * @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 1001 * @param wakeup_mode RTC_ALARM, INTERRUPT, RTC_ALARM_OR_INTERRUPT
Mike Fiore 7:683dba5d576f 1002 * if RTC_ALARM the real time clock is configured to wake the device up after the specified interval
Mike Fiore 7:683dba5d576f 1003 * if INTERRUPT the device will wake up on the rising edge of the interrupt pin
Jason Reiss 10:27dafba9fe19 1004 * if RTC_ALARM_OR_INTERRUPT the device will wake on the first event to occur
Mike Fiore 7:683dba5d576f 1005 * @param deepsleep if true go into deep sleep mode (lowest power, all memory and registers are lost, peripherals turned off)
Mike Fiore 7:683dba5d576f 1006 * else go into sleep mode (low power, memory and registers are maintained, peripherals stay on)
Mike Fiore 7:683dba5d576f 1007 *
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1008 * For the MDOT
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1009 * 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 1010 * 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 1011 * For the XDOT
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1012 * 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 1013 * 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 1014 */
Mike Fiore 7:683dba5d576f 1015 void sleep(const uint32_t& interval, const uint8_t& wakeup_mode = RTC_ALARM, const bool& deepsleep = true);
Mike Fiore 7:683dba5d576f 1016
Mike Fiore 7:683dba5d576f 1017 /** Set wake pin
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1018 * @param pin the pin to use to wake the device from sleep mode
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1019 * For MDOT, XBEE_DI (2-8)
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1020 * For XDOT, GPIO (0-3), UART1_RX, or WAKE
Mike Fiore 7:683dba5d576f 1021 */
Mike Fiore 7:683dba5d576f 1022 void setWakePin(const PinName& pin);
Mike Fiore 7:683dba5d576f 1023
Mike Fiore 7:683dba5d576f 1024 /** Get wake pin
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1025 * @returns the pin to use to wake the device from sleep mode
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1026 * For MDOT, XBEE_DI (2-8)
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1027 * For XDOT, GPIO (0-3), UART1_RX, or WAKE
Mike Fiore 7:683dba5d576f 1028 */
Mike Fiore 7:683dba5d576f 1029 PinName getWakePin();
Mike Fiore 7:683dba5d576f 1030
jreiss 9:ec2fffe31793 1031 /** Write data in a user backup register
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1032 * @param register one of UBR0 through UBR9 for MDOT, one of UBR0 through UBR21 for XDOT
jreiss 9:ec2fffe31793 1033 * @param data user data to back up
jreiss 9:ec2fffe31793 1034 * @returns true if success
jreiss 9:ec2fffe31793 1035 */
jreiss 9:ec2fffe31793 1036 bool writeUserBackupRegister(uint32_t reg, uint32_t data);
jreiss 9:ec2fffe31793 1037
jreiss 9:ec2fffe31793 1038 /** Read data in a user backup register
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1039 * @param register one of UBR0 through UBR9 for MDOT, one of UBR0 through UBR21 for XDOT
jreiss 9:ec2fffe31793 1040 * @param data gets set to content of register
jreiss 9:ec2fffe31793 1041 * @returns true if success
jreiss 9:ec2fffe31793 1042 */
jreiss 9:ec2fffe31793 1043 bool readUserBackupRegister(uint32_t reg, uint32_t& data);
jreiss 9:ec2fffe31793 1044
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1045 #if defined(TARGET_MTS_MDOT_F411RE)
Mike Fiore 11:d8464345e1f1 1046 // Save user file data to flash
Mike Fiore 11:d8464345e1f1 1047 // file - name of file max 30 chars
Mike Fiore 11:d8464345e1f1 1048 // data - data of file
Mike Fiore 11:d8464345e1f1 1049 // size - size of file
Mike Fiore 11:d8464345e1f1 1050 bool saveUserFile(const char* file, void* data, uint32_t size);
Mike Fiore 11:d8464345e1f1 1051
Mike Fiore 11:d8464345e1f1 1052 // Append user file data to flash
Mike Fiore 11:d8464345e1f1 1053 // file - name of file max 30 chars
Mike Fiore 11:d8464345e1f1 1054 // data - data of file
Mike Fiore 11:d8464345e1f1 1055 // size - size of file
Mike Fiore 11:d8464345e1f1 1056 bool appendUserFile(const char* file, void* data, uint32_t size);
Mike Fiore 11:d8464345e1f1 1057
Mike Fiore 11:d8464345e1f1 1058 // Read user file data from flash
Mike Fiore 11:d8464345e1f1 1059 // file - name of file max 30 chars
Mike Fiore 11:d8464345e1f1 1060 // data - data of file
Mike Fiore 11:d8464345e1f1 1061 // size - size of file
Mike Fiore 11:d8464345e1f1 1062 bool readUserFile(const char* file, void* data, uint32_t size);
Mike Fiore 11:d8464345e1f1 1063
Mike Fiore 11:d8464345e1f1 1064 // Move a user file in flash
Mike Fiore 11:d8464345e1f1 1065 // file - name of file
Mike Fiore 11:d8464345e1f1 1066 // new_name - new name of file
Mike Fiore 11:d8464345e1f1 1067 bool moveUserFile(const char* file, const char* new_name);
Mike Fiore 11:d8464345e1f1 1068
Mike Fiore 11:d8464345e1f1 1069 // Delete user file data from flash
Mike Fiore 11:d8464345e1f1 1070 // file - name of file max 30 chars
Mike Fiore 11:d8464345e1f1 1071 bool deleteUserFile(const char* file);
Mike Fiore 11:d8464345e1f1 1072
Mike Fiore 11:d8464345e1f1 1073 // Open user file in flash, max of 4 files open concurrently
Mike Fiore 11:d8464345e1f1 1074 // file - name of file max 30 chars
Mike Fiore 11:d8464345e1f1 1075 // mode - combination of FM_APPEND | FM_TRUNC | FM_CREAT |
Mike Fiore 11:d8464345e1f1 1076 // FM_RDONLY | FM_WRONLY | FM_RDWR | FM_DIRECT
Mike Fiore 11:d8464345e1f1 1077 // returns - mdot_file struct, fd field will be a negative value if file could not be opened
Mike Fiore 11:d8464345e1f1 1078 mDot::mdot_file openUserFile(const char* file, int mode);
Mike Fiore 11:d8464345e1f1 1079
Mike Fiore 11:d8464345e1f1 1080 // Seek an open file
Mike Fiore 11:d8464345e1f1 1081 // file - mdot file struct
Mike Fiore 11:d8464345e1f1 1082 // offset - offset in bytes
Mike Fiore 11:d8464345e1f1 1083 // whence - where offset is based SEEK_SET, SEEK_CUR, SEEK_END
Mike Fiore 11:d8464345e1f1 1084 bool seekUserFile(mDot::mdot_file& file, size_t offset, int whence);
Mike Fiore 11:d8464345e1f1 1085
Mike Fiore 11:d8464345e1f1 1086 // Read bytes from open file
Mike Fiore 11:d8464345e1f1 1087 // file - mdot file struct
Mike Fiore 11:d8464345e1f1 1088 // data - mem location to store data
Mike Fiore 11:d8464345e1f1 1089 // length - number of bytes to read
Mike Fiore 11:d8464345e1f1 1090 // returns - number of bytes written
Mike Fiore 11:d8464345e1f1 1091 int readUserFile(mDot::mdot_file& file, void* data, size_t length);
Mike Fiore 11:d8464345e1f1 1092
Mike Fiore 11:d8464345e1f1 1093 // Write bytes to open file
Mike Fiore 11:d8464345e1f1 1094 // file - mdot file struct
Mike Fiore 11:d8464345e1f1 1095 // data - data to write
Mike Fiore 11:d8464345e1f1 1096 // length - number of bytes to write
Mike Fiore 11:d8464345e1f1 1097 // returns - number of bytes written
Mike Fiore 11:d8464345e1f1 1098 int writeUserFile(mDot::mdot_file& file, void* data, size_t length);
Mike Fiore 11:d8464345e1f1 1099
Mike Fiore 11:d8464345e1f1 1100 // Close open file
Mike Fiore 11:d8464345e1f1 1101 // file - mdot file struct
Mike Fiore 11:d8464345e1f1 1102 bool closeUserFile(mDot::mdot_file& file);
Mike Fiore 11:d8464345e1f1 1103
Mike Fiore 11:d8464345e1f1 1104 // List user files stored in flash
Mike Fiore 11:d8464345e1f1 1105 std::vector<mDot::mdot_file> listUserFiles();
Mike Fiore 11:d8464345e1f1 1106
Mike Fiore 11:d8464345e1f1 1107 // Move file into the firmware upgrade path to be flashed on next boot
Mike Fiore 11:d8464345e1f1 1108 // file - name of file
Mike Fiore 11:d8464345e1f1 1109 bool moveUserFileToFirmwareUpgrade(const char* file);
Jenkins@KEILDM1.dc.multitech.prv 19:f3a46d2bb9b3 1110 #endif /* TARGET_MTS_MDOT_F411RE */
Mike Fiore 11:d8464345e1f1 1111
Mike Fiore 11:d8464345e1f1 1112 // get current statistics
Mike Fiore 11:d8464345e1f1 1113 // Join Attempts, Join Fails, Up Packets, Down Packets, Missed Acks
Mike Fiore 11:d8464345e1f1 1114 mdot_stats getStats();
Mike Fiore 11:d8464345e1f1 1115
Mike Fiore 11:d8464345e1f1 1116 // reset statistics
Mike Fiore 11:d8464345e1f1 1117 // Join Attempts, Join Fails, Up Packets, Down Packets, Missed Acks
Mike Fiore 11:d8464345e1f1 1118 void resetStats();
Mike Fiore 11:d8464345e1f1 1119
Mike Fiore 11:d8464345e1f1 1120 // Convert pin number 2-8 to pin name DIO2-DI8
Mike Fiore 11:d8464345e1f1 1121 static PinName pinNum2Name(uint8_t num);
Mike Fiore 11:d8464345e1f1 1122
Mike Fiore 11:d8464345e1f1 1123 // Convert pin name DIO2-DI8 to pin number 2-8
Mike Fiore 11:d8464345e1f1 1124 static uint8_t pinName2Num(PinName name);
Mike Fiore 11:d8464345e1f1 1125
Mike Fiore 11:d8464345e1f1 1126 // Convert pin name DIO2-DI8 to string
Mike Fiore 11:d8464345e1f1 1127 static std::string pinName2Str(PinName name);
Mike Fiore 11:d8464345e1f1 1128
Mike Fiore 11:d8464345e1f1 1129 uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
mfiore 0:c62615f15125 1130
mfiore 0:c62615f15125 1131 /*************************************************************************
mfiore 0:c62615f15125 1132 * The following functions are only used by the AT command application and
mfiore 0:c62615f15125 1133 * should not be used by standard applications consuming the mDot library
mfiore 0:c62615f15125 1134 ************************************************************************/
Mike Fiore 7:683dba5d576f 1135
mfiore 0:c62615f15125 1136 // set/get configured baud rate for command port
mfiore 0:c62615f15125 1137 // only for use in conjunction with AT interface
mfiore 0:c62615f15125 1138 // set function returns MDOT_OK if success
mfiore 0:c62615f15125 1139 int32_t setBaud(const uint32_t& baud);
mfiore 0:c62615f15125 1140 uint32_t getBaud();
mfiore 0:c62615f15125 1141
mfiore 0:c62615f15125 1142 // set/get baud rate for debug port
mfiore 0:c62615f15125 1143 // set function returns MDOT_OK if success
mfiore 0:c62615f15125 1144 int32_t setDebugBaud(const uint32_t& baud);
mfiore 0:c62615f15125 1145 uint32_t getDebugBaud();
mfiore 0:c62615f15125 1146
mfiore 0:c62615f15125 1147 // set/get command terminal echo
mfiore 0:c62615f15125 1148 // set function returns MDOT_OK if success
mfiore 0:c62615f15125 1149 int32_t setEcho(const bool& on);
mfiore 0:c62615f15125 1150 bool getEcho();
mfiore 0:c62615f15125 1151
mfiore 0:c62615f15125 1152 // set/get command terminal verbose mode
mfiore 0:c62615f15125 1153 // set function returns MDOT_OK if success
mfiore 0:c62615f15125 1154 int32_t setVerbose(const bool& on);
mfiore 0:c62615f15125 1155 bool getVerbose();
mfiore 0:c62615f15125 1156
mfiore 0:c62615f15125 1157 // set/get startup mode
mfiore 0:c62615f15125 1158 // COMMAND_MODE (default), starts up ready to accept AT commands
mfiore 0:c62615f15125 1159 // SERIAL_MODE, read serial data and send it as LoRa packets
mfiore 0:c62615f15125 1160 // set function returns MDOT_OK if success
mfiore 0:c62615f15125 1161 int32_t setStartUpMode(const uint8_t& mode);
mfiore 0:c62615f15125 1162 uint8_t getStartUpMode();
mfiore 0:c62615f15125 1163
mfiore 0:c62615f15125 1164 int32_t setRxDataRate(const uint8_t& dr);
mfiore 0:c62615f15125 1165 uint8_t getRxDataRate();
mfiore 0:c62615f15125 1166
mfiore 0:c62615f15125 1167 // get/set TX/RX frequency
mfiore 0:c62615f15125 1168 // if frequency band == FB_868 (Europe), must be between 863000000 - 870000000
mfiore 0:c62615f15125 1169 // if frequency band == FB_915 (United States), must be between 902000000-928000000
mfiore 0:c62615f15125 1170 // if set to 0, device will hop frequencies
mfiore 0:c62615f15125 1171 // set function returns MDOT_OK if success
mfiore 0:c62615f15125 1172 int32_t setTxFrequency(const uint32_t& freq);
mfiore 0:c62615f15125 1173 uint32_t getTxFrequency();
mfiore 0:c62615f15125 1174 int32_t setRxFrequency(const uint32_t& freq);
mfiore 0:c62615f15125 1175 uint32_t getRxFrequency();
mfiore 0:c62615f15125 1176
mfiore 0:c62615f15125 1177 // get/set TX/RX inverted
mfiore 0:c62615f15125 1178 // true == signal is inverted
mfiore 0:c62615f15125 1179 // set function returns MDOT_OK if success
mfiore 0:c62615f15125 1180 int32_t setTxInverted(const bool& on);
mfiore 0:c62615f15125 1181 bool getTxInverted();
mfiore 0:c62615f15125 1182 int32_t setRxInverted(const bool& on);
mfiore 0:c62615f15125 1183 bool getRxInverted();
mfiore 0:c62615f15125 1184
mfiore 0:c62615f15125 1185 // get/set RX output mode
mfiore 0:c62615f15125 1186 // valid options are HEXADECIMAL and BINARY
mfiore 0:c62615f15125 1187 // set function returns MDOT_OK if success
mfiore 0:c62615f15125 1188 int32_t setRxOutput(const uint8_t& mode);
mfiore 0:c62615f15125 1189 uint8_t getRxOutput();
mfiore 0:c62615f15125 1190
mfiore 0:c62615f15125 1191 // get/set serial wake interval
mfiore 0:c62615f15125 1192 // valid values are 2 s - INT_MAX (2147483647) s
mfiore 0:c62615f15125 1193 // set function returns MDOT_OK if success
Mike Fiore 7:683dba5d576f 1194 int32_t setWakeInterval(const uint32_t& interval);
Mike Fiore 7:683dba5d576f 1195 uint32_t getWakeInterval();
mfiore 0:c62615f15125 1196
mfiore 0:c62615f15125 1197 // get/set serial wake delay
mfiore 0:c62615f15125 1198 // valid values are 2 ms - INT_MAX (2147483647) ms
mfiore 0:c62615f15125 1199 // set function returns MDOT_OK if success
Mike Fiore 7:683dba5d576f 1200 int32_t setWakeDelay(const uint32_t& delay);
Mike Fiore 7:683dba5d576f 1201 uint32_t getWakeDelay();
mfiore 0:c62615f15125 1202
mfiore 0:c62615f15125 1203 // get/set serial receive timeout
mfiore 0:c62615f15125 1204 // valid values are 0 ms - 65000 ms
mfiore 0:c62615f15125 1205 // set function returns MDOT_OK if success
Mike Fiore 7:683dba5d576f 1206 int32_t setWakeTimeout(const uint16_t& timeout);
Mike Fiore 7:683dba5d576f 1207 uint16_t getWakeTimeout();
Mike Fiore 7:683dba5d576f 1208
Mike Fiore 7:683dba5d576f 1209 // get/set serial wake mode
Mike Fiore 7:683dba5d576f 1210 // valid values are INTERRUPT or RTC_ALARM
Mike Fiore 7:683dba5d576f 1211 // set function returns MDOT_OK if success
Mike Fiore 7:683dba5d576f 1212 int32_t setWakeMode(const uint8_t& delay);
Mike Fiore 7:683dba5d576f 1213 uint8_t getWakeMode();
Mike Fiore 7:683dba5d576f 1214
Mike Fiore 12:54f9cac9d690 1215 // get/set serial flow control enabled
Mike Fiore 12:54f9cac9d690 1216 // set function returns MDOT_OK if success
Mike Fiore 12:54f9cac9d690 1217 int32_t setFlowControl(const bool& on);
Mike Fiore 12:54f9cac9d690 1218 bool getFlowControl();
Mike Fiore 12:54f9cac9d690 1219
Mike Fiore 12:54f9cac9d690 1220 // get/set serial clear on error
Mike Fiore 12:54f9cac9d690 1221 // 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 1222 // set function returns MDOT_OK if success
Mike Fiore 12:54f9cac9d690 1223 int32_t setSerialClearOnError(const bool& on);
Mike Fiore 12:54f9cac9d690 1224 bool getSerialClearOnError();
mfiore 0:c62615f15125 1225
mfiore 0:c62615f15125 1226 // MTS_RADIO_DEBUG_COMMANDS
Mike Fiore 7:683dba5d576f 1227
Mike Fiore 16:b630e18103e5 1228 /** Disable Duty cycle
Mike Fiore 16:b630e18103e5 1229 * enables or disables the duty cycle limitations
Mike Fiore 16:b630e18103e5 1230 * **** ONLY TO BE USED FOR TESTINGS PURPOSES ****
Mike Fiore 16:b630e18103e5 1231 * **** ALL DEPLOYABLE CODE MUST ADHERE TO LOCAL REGULATIONS ****
Mike Fiore 16:b630e18103e5 1232 * **** THIS SETTING WILL NOT BE SAVED TO CONFIGURATION *****
Mike Fiore 16:b630e18103e5 1233 * @param val true to disable duty-cycle (default:false)
Mike Fiore 16:b630e18103e5 1234 */
Mike Fiore 16:b630e18103e5 1235 int32_t setDisableDutyCycle(bool val);
Mike Fiore 16:b630e18103e5 1236
Mike Fiore 16:b630e18103e5 1237 /** Disable Duty cycle
Mike Fiore 16:b630e18103e5 1238 * **** ONLY TO BE USED FOR TESTINGS PURPOSES ****
Mike Fiore 16:b630e18103e5 1239 * **** ALL DEPLOYABLE CODE MUST ADHERE TO LOCAL REGULATIONS ****
Mike Fiore 16:b630e18103e5 1240 * **** THIS SETTING WILL NOT BE SAVED TO CONFIGURATION *****
Mike Fiore 16:b630e18103e5 1241 * @return true if duty-cycle is disabled (default:false)
Mike Fiore 16:b630e18103e5 1242 */
Mike Fiore 16:b630e18103e5 1243 uint8_t getDisableDutyCycle();
Mike Fiore 16:b630e18103e5 1244
Mike Fiore 7:683dba5d576f 1245 void openRxWindow(uint32_t timeout, uint8_t bandwidth = 0);
Mike Fiore 16:b630e18103e5 1246 void closeRxWindow();
Mike Fiore 16:b630e18103e5 1247 void sendContinuous(bool enable=true);
mfiore 0:c62615f15125 1248 int32_t setDeviceId(const std::vector<uint8_t>& id);
mfiore 0:c62615f15125 1249 int32_t setFrequencyBand(const uint8_t& band);
mfiore 0:c62615f15125 1250 bool saveProtectedConfig();
mfiore 0:c62615f15125 1251 void resetRadio();
mfiore 0:c62615f15125 1252 int32_t setRadioMode(const uint8_t& mode);
mfiore 0:c62615f15125 1253 std::map<uint8_t, uint8_t> dumpRegisters();
mfiore 0:c62615f15125 1254 void eraseFlash();
mfiore 0:c62615f15125 1255
Mike Fiore 7:683dba5d576f 1256 // deprecated - use setWakeInterval
Mike Fiore 7:683dba5d576f 1257 int32_t setSerialWakeInterval(const uint32_t& interval);
Mike Fiore 7:683dba5d576f 1258 // deprecated - use getWakeInterval
Mike Fiore 7:683dba5d576f 1259 uint32_t getSerialWakeInterval();
Mike Fiore 6:390fc83d588d 1260
Mike Fiore 7:683dba5d576f 1261 // deprecated - use setWakeDelay
Mike Fiore 7:683dba5d576f 1262 int32_t setSerialWakeDelay(const uint32_t& delay);
Mike Fiore 7:683dba5d576f 1263 // deprecated - use setWakeDelay
Mike Fiore 7:683dba5d576f 1264 uint32_t getSerialWakeDelay();
Mike Fiore 7:683dba5d576f 1265
Mike Fiore 7:683dba5d576f 1266 // deprecated - use setWakeTimeout
Mike Fiore 7:683dba5d576f 1267 int32_t setSerialReceiveTimeout(const uint16_t& timeout);
Mike Fiore 7:683dba5d576f 1268 // deprecated - use getWakeTimeout
Mike Fiore 7:683dba5d576f 1269 uint16_t getSerialReceiveTimeout();
mfiore 0:c62615f15125 1270
Mike Fiore 11:d8464345e1f1 1271 void setWakeupCallback(void (*function)(void));
Mike Fiore 11:d8464345e1f1 1272
Mike Fiore 11:d8464345e1f1 1273 template<typename T>
Mike Fiore 11:d8464345e1f1 1274 void setWakeupCallback(T *object, void (T::*member)(void)) {
Mike Fiore 11:d8464345e1f1 1275 _wakeup_callback.attach(object, member);
Mike Fiore 11:d8464345e1f1 1276 }
Mike Fiore 11:d8464345e1f1 1277
mfiore 0:c62615f15125 1278 private:
mfiore 0:c62615f15125 1279 mdot_stats _stats;
mfiore 0:c62615f15125 1280
Mike Fiore 11:d8464345e1f1 1281 FunctionPointer _wakeup_callback;
Mike Fiore 11:d8464345e1f1 1282
Mike Fiore 12:54f9cac9d690 1283 bool _standbyFlag;
Mike Fiore 12:54f9cac9d690 1284 bool _testMode;
Mike Fiore 12:54f9cac9d690 1285 uint8_t _savedPort;
Mike Fiore 12:54f9cac9d690 1286 void handleTestModePacket();
Mike Fiore 12:54f9cac9d690 1287
mfiore 0:c62615f15125 1288 };
mfiore 0:c62615f15125 1289
mfiore 0:c62615f15125 1290 #endif