nguyen hoang / libmDot-dev-mbed5

khang_91

mDot.h@149:724ee1863b4a, 2018-04-30 (annotated)

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