Stable version of the mDot library for mbed 5. This version of the library is suitable for deployment scenarios. See lastest commit message for version of mbed-os library that has been tested against.

Dependents:   mdot_two_way unh-hackathon-example unh-hackathon-example-raw TelitSensorToCloud ... more

Fork of libmDot-dev-mbed5-deprecated by MultiTech

The Dot library provides a LoRaWan certified stack for LoRa communication using MultiTech mDot and xDot devices. The stack is compatible with mbed 5.

The name of the repository can be used to determine which device the stack was compiled for and if it's a development or production-ready build:

A changelog for the Dot library can be found here.

The Dot library version and the version of mbed-os it was compiled against can both be found in the commit message for that revision of the Dot library. Building your application with the same version of mbed-os as what was used to build the Dot library is highly recommended!

The Dot-Examples repository demonstrates how to use the Dot library in a custom application.

The mDot and xDot platform pages have lots of platform specific information and document potential issues, gotchas, etc, and provide instructions for getting started with development. Please take a look at the platform page before starting development as they should answer many questions you will have.

FOTA

Full FOTA support is only available with mDot, xDot does not have the required external flash. xDot can use the FOTA example to dynamically join a multicast session only. After joining the multicast session the received Fragmentation packets could be handed to a host MCU for processing and at completion the firmware can be loaded into the xDot using the bootloader and y-modem. See xDot Developer Guide.

  • Add the following code to allow Fota to use the Dot instance

main.cpp

    // Initialize FOTA singleton
    Fota::getInstance(dot);
  • Add fragmentation handling the the PacketRx event

RadioEvent.h

    virtual void PacketRx(uint8_t port, uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr, lora::DownlinkControl ctrl, uint8_t slot, uint8_t retries, uint32_t address, bool dupRx) {
        mDotEvent::PacketRx(port, payload, size, rssi, snr, ctrl, slot, retries, address, dupRx);

#if ACTIVE_EXAMPLE == FOTA_EXAMPLE
        if(port == 200 || port == 201 || port == 202) {
            Fota::getInstance()->processCmd(payload, port, size);
        }
#endif
    }

A definition is needed to enable Fragmentation support on mDot and save fragments to flash. This should not be defined for xDot and will result in a compiler error.

mbed_app.json

{
    "macros": [
        "FOTA=1"
    ]
}

The FOTA implementation has a few differences from the LoRaWAN Protocol

  • Fragmentation Indexing starts at 0
  • McKEKey is 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
  • Start Time is a count-down in seconds to start of session
Committer:
Mike Fiore
Date:
Thu Aug 04 15:11:24 2016 -0500
Revision:
16:b630e18103e5
Parent:
12:54f9cac9d690
Child:
17:306ffaa5d79b
update from libmDot-2.0.1-ARMCC.tar.gz

Who changed what in which revision?

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