Bleeding edge development version of the mDot library for mbed 5. This version of the library is not guaranteed to be stable or well tested and should not be used in production or deployment scenarios.

Dependents:   mDot-IKS01A1 mDot-IKS01A1 mDot-Examples mDot-IKS01A1-Explora ... more

Fork of libmDot-dev-mbed2-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.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. Channel plans are included with the 3.x.x Dot Library releases. The following code snippet demonstrates how to create a channel plan and inject it into the stack.

#include "mDot.h"
#include "channel_plans.h"

int main() {
    ChannelPlan* plan = new lora::ChannelPlan_US915();
    assert(plan);
    mDot* dot = mDot::getInstance(plan);
    assert(dot);

    // ...
}

Dot devices must not be deployed with software using a different channel plan than the Dot's default plan! This functionality is for development and testing only!

Multicast Sessions

Multicast sessions and packet rx events in library. When in Class C mode Multicast downlinks can be received. Recieved packets should be filtered on address, counter value will be maintained in the session or can be set explicitly depending on Application support to share Multicast Address, Keys and Counters.

mDot.h

        /**
         * Add a multicast session address and keys
         * Downlink counter is set to 0
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastSession(uint8_t index, uint32_t addr, const uint8_t* nsk, const uint8_t* dsk);
 
        /**
         * Set a multicast session counter
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastDownlinkCounter(uint8_t index, uint32_t count);

mDotEvent.h

The address field was added to PacketRx event.

        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);

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.

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