nguyen hoang / libmDot-dev-mbed5

khang_91

mDot.h@136:d7d7093d4754, 2018-02-16 (annotated)

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Fri Feb 16 16:00:18 2018 -0600
Revision:
136:d7d7093d4754
Parent:
135:69d2d725ea1e
Child:
141:c6247c5469ff
mdot-library revision 3.0.2-51-g6ba87fb and mbed-os revision mbed-os-5.5.7

Who changed what in which revision?

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