Eliott Fersko / libmDot-mbed5

libmDot0mbed5

Fork of libmDot-mbed5 by MultiTech

mDot.h@19:f3a46d2bb9b3, 2016-08-19 (annotated)

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Fri Aug 19 16:23:07 2016 -0500
Revision:
19:f3a46d2bb9b3
Parent:
17:306ffaa5d79b
Child:
30:c3150500b324
update from git revision 2.0.3-15-g0042cdf

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