nguyen hoang / libmDot-dev-mbed5

khang_91

mDot.h@173:88c20655ca6f, 2018-09-04 (annotated)

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Tue Sep 04 15:28:56 2018 -0500
Revision:
173:88c20655ca6f
Parent:
172:7ec44396a51b
Child:
176:e8835022d431
mdot-library revision 3.1.0-18-gba4df31 and mbed-os revision mbed-os-5.7.7

Who changed what in which revision?

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