libmDot-mbed5 - Stable version of the mDot library for mbed 5. Th…

MultiTech » Code » libmDot-mbed5

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

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

Fork of libmDot-dev-mbed5-deprecated by MultiTech

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

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

libmDot-mbed5 -> production-ready build for mDot
libmDot-dev-mbed5 -> development build for mDot
libxDot-mbed5 -> production-ready build for xDot
libxDot-dev-mbed5 -> development build for xDot

A changelog for the Dot library can be found here.

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

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

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

FOTA

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

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

main.cpp

    // Initialize FOTA singleton
    Fota::getInstance(dot);

Add fragmentation handling the the PacketRx event

RadioEvent.h

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

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

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

mbed_app.json

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

The FOTA implementation has a few differences from the LoRaWAN Protocol

Fragmentation Indexing starts at 0
McKEKey is 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
Start Time is a count-down in seconds to start of session

mDot.h@7:683dba5d576f, 2015-08-17 (annotated)

Committer:: Mike Fiore
Date:: Mon Aug 17 16:18:29 2015 -0500
Revision:: 7:683dba5d576f
Parent:: 6:390fc83d588d
Child:: 9:ec2fffe31793

update to version 0.0.7

Who changed what in which revision?

User	Revision	Line number	New contents of line
Mike Fiore	7:683dba5d576f	1	/************************************************
Mike Fiore	7:683dba5d576f	2	* MultiTech MTDOT Library
Mike Fiore	7:683dba5d576f	3	* Copyright (c) 2015 MultiTech Systems
Mike Fiore	7:683dba5d576f	4	*
Mike Fiore	7:683dba5d576f	5	* See LICENSE file for license information
Mike Fiore	7:683dba5d576f	6	***********************************************/
Mike Fiore	7:683dba5d576f	7
mfiore	0:c62615f15125	8
mfiore	0:c62615f15125	9	#ifndef MDOT_H
mfiore	0:c62615f15125	10	#define MDOT_H
mfiore	0:c62615f15125	11
mfiore	0:c62615f15125	12	#include "mbed.h"
mfiore	0:c62615f15125	13	#include "rtos.h"
mfiore	0:c62615f15125	14	#include <vector>
mfiore	0:c62615f15125	15	#include <map>
mfiore	0:c62615f15125	16	#include <string>
mfiore	0:c62615f15125	17
mfiore	0:c62615f15125	18	class LoRaMacEvent;
mfiore	0:c62615f15125	19	class LoRaConfig;
mfiore	0:c62615f15125	20	class LoRaMac;
mfiore	0:c62615f15125	21	class MdotRadio;
mfiore	0:c62615f15125	22
mfiore	0:c62615f15125	23	class mDot {
mfiore	0:c62615f15125	24
mfiore	0:c62615f15125	25	private:
mfiore	0:c62615f15125	26
mfiore	0:c62615f15125	27	mDot();
mfiore	0:c62615f15125	28	~mDot();
mfiore	0:c62615f15125	29
mfiore	0:c62615f15125	30	static void idle(void const* args) {
mfiore	0:c62615f15125	31	while (1)
mfiore	0:c62615f15125	32	__WFI();
mfiore	0:c62615f15125	33	}
mfiore	0:c62615f15125	34
mfiore	0:c62615f15125	35	void setLastError(const std::string& str);
mfiore	0:c62615f15125	36
mfiore	0:c62615f15125	37	static bool validateBaudRate(const uint32_t& baud);
mfiore	0:c62615f15125	38	static bool validateFrequencySubBand(const uint8_t& band);
mfiore	0:c62615f15125	39	bool validateDataRate(const uint8_t& dr);
mfiore	0:c62615f15125	40
mfiore	0:c62615f15125	41	int32_t joinBase(const uint32_t& retries);
mfiore	0:c62615f15125	42	int32_t sendBase(const std::vector<uint8_t>& data, const bool& confirmed = false, const bool& blocking = true, const bool& highBw = false);
mfiore	0:c62615f15125	43	void waitForPacket();
mfiore	0:c62615f15125	44	void waitForLinkCheck();
mfiore	0:c62615f15125	45
mfiore	0:c62615f15125	46	void setActivityLedState(const uint8_t& state);
mfiore	0:c62615f15125	47	uint8_t getActivityLedState();
mfiore	0:c62615f15125	48
mfiore	0:c62615f15125	49	void blinkActivityLed(void) {
Mike Fiore	6:390fc83d588d	50	if (_activity_led) {
Mike Fiore	6:390fc83d588d	51	int val = _activity_led->read();
Mike Fiore	6:390fc83d588d	52	_activity_led->write(!val);
Mike Fiore	6:390fc83d588d	53	}
mfiore	0:c62615f15125	54	}
mfiore	0:c62615f15125	55
mfiore	0:c62615f15125	56	mDot(const mDot&);
mfiore	0:c62615f15125	57	mDot& operator=(const mDot&);
mfiore	0:c62615f15125	58
Mike Fiore	7:683dba5d576f	59	uint32_t RTC_ReadBackupRegister(uint32_t RTC_BKP_DR);
Mike Fiore	7:683dba5d576f	60	void RTC_WriteBackupRegister(uint32_t RTC_BKP_DR, uint32_t Data);
Mike Fiore	7:683dba5d576f	61
Mike Fiore	7:683dba5d576f	62	void wakeup();
Mike Fiore	7:683dba5d576f	63
mfiore	0:c62615f15125	64	static mDot* _instance;
mfiore	0:c62615f15125	65
mfiore	0:c62615f15125	66	LoRaMac* _mac;
mfiore	0:c62615f15125	67	MdotRadio* _radio;
mfiore	0:c62615f15125	68	LoRaMacEvent* _events;
mfiore	0:c62615f15125	69	LoRaConfig* _config;
mfiore	0:c62615f15125	70	Thread _idle_thread;
mfiore	0:c62615f15125	71	std::string _last_error;
mfiore	0:c62615f15125	72	static const uint32_t _baud_rates[];
mfiore	0:c62615f15125	73	uint8_t _activity_led_state;
mfiore	0:c62615f15125	74	Ticker _tick;
Mike Fiore	6:390fc83d588d	75	DigitalOut* _activity_led;
Mike Fiore	6:390fc83d588d	76	bool _activity_led_enable;
Mike Fiore	6:390fc83d588d	77	PinName _activity_led_pin;
Mike Fiore	5:0bfe6a650513	78	bool _activity_led_external;
mfiore	0:c62615f15125	79	uint16_t _linkFailCount;
Mike Fiore	7:683dba5d576f	80	uint8_t _class;
Mike Fiore	7:683dba5d576f	81	InterruptIn* _wakeup;
Mike Fiore	7:683dba5d576f	82	PinName _wakeup_pin;
mfiore	0:c62615f15125	83
mfiore	0:c62615f15125	84	typedef enum {
mfiore	0:c62615f15125	85	OFF, ON, BLINK,
mfiore	0:c62615f15125	86	} state;
mfiore	0:c62615f15125	87
mfiore	0:c62615f15125	88	public:
mfiore	0:c62615f15125	89
mfiore	0:c62615f15125	90	typedef enum {
Mike Fiore	7:683dba5d576f	91	FM_APPEND = (1 << 0),
Mike Fiore	7:683dba5d576f	92	FM_TRUNC = (1 << 1),
Mike Fiore	7:683dba5d576f	93	FM_CREAT = (1 << 2),
Mike Fiore	7:683dba5d576f	94	FM_RDONLY = (1 << 3),
Mike Fiore	7:683dba5d576f	95	FM_WRONLY = (1 << 4),
Mike Fiore	7:683dba5d576f	96	FM_RDWR = (FM_RDONLY \| FM_WRONLY),
Mike Fiore	7:683dba5d576f	97	FM_DIRECT = (1 << 5)
Mike Fiore	7:683dba5d576f	98	} FileMode;
Mike Fiore	7:683dba5d576f	99
Mike Fiore	7:683dba5d576f	100	typedef enum {
mfiore	0:c62615f15125	101	MDOT_OK = 0,
mfiore	0:c62615f15125	102	MDOT_INVALID_PARAM = -1,
mfiore	0:c62615f15125	103	MDOT_TX_ERROR = -2,
mfiore	0:c62615f15125	104	MDOT_RX_ERROR = -3,
mfiore	0:c62615f15125	105	MDOT_JOIN_ERROR = -4,
mfiore	0:c62615f15125	106	MDOT_TIMEOUT = -5,
mfiore	0:c62615f15125	107	MDOT_NOT_JOINED = -6,
mfiore	0:c62615f15125	108	MDOT_ENCRYPTION_DISABLED = -7,
mfiore	0:c62615f15125	109	MDOT_NO_FREE_CHAN = -8,
mfiore	0:c62615f15125	110	MDOT_ERROR = -1024,
mfiore	0:c62615f15125	111	} mdot_ret_code;
mfiore	0:c62615f15125	112
mfiore	0:c62615f15125	113	enum JoinMode {
mfiore	0:c62615f15125	114	MANUAL, OTA, AUTO_OTA
mfiore	0:c62615f15125	115	};
mfiore	0:c62615f15125	116
mfiore	0:c62615f15125	117	enum Mode {
mfiore	0:c62615f15125	118	COMMAND_MODE, SERIAL_MODE
mfiore	0:c62615f15125	119	};
mfiore	0:c62615f15125	120
mfiore	0:c62615f15125	121	enum RX_Output {
mfiore	0:c62615f15125	122	HEXADECIMAL, BINARY
mfiore	0:c62615f15125	123	};
mfiore	0:c62615f15125	124
mfiore	0:c62615f15125	125	enum DataRates {
mfiore	0:c62615f15125	126	SF_12, SF_11, SF_10, SF_9, SF_8, SF_7, SF_7H, SF_50
mfiore	0:c62615f15125	127	};
mfiore	0:c62615f15125	128
mfiore	0:c62615f15125	129	enum FrequencyBands {
mfiore	0:c62615f15125	130	FB_868, FB_915
mfiore	0:c62615f15125	131	};
mfiore	0:c62615f15125	132
mfiore	0:c62615f15125	133	enum FrequencySubBands {
mfiore	0:c62615f15125	134	FSB_ALL, FSB_1, FSB_2, FSB_3, FSB_4, FSB_5, FSB_6, FSB_7, FSB_8
mfiore	0:c62615f15125	135	};
mfiore	0:c62615f15125	136
Mike Fiore	6:390fc83d588d	137	enum JoinByteOrder {
Mike Fiore	6:390fc83d588d	138	LSB, MSB
Mike Fiore	6:390fc83d588d	139	};
Mike Fiore	6:390fc83d588d	140
Mike Fiore	7:683dba5d576f	141	enum wakeup_mode {
Mike Fiore	7:683dba5d576f	142	RTC_ALARM, INTERRUPT
Mike Fiore	7:683dba5d576f	143	};
Mike Fiore	7:683dba5d576f	144
Mike Fiore	7:683dba5d576f	145	typedef struct {
Mike Fiore	7:683dba5d576f	146	int16_t fd;
Mike Fiore	7:683dba5d576f	147	char name[30];
Mike Fiore	7:683dba5d576f	148	uint32_t size;
Mike Fiore	7:683dba5d576f	149	} mdot_file;
Mike Fiore	7:683dba5d576f	150
mfiore	0:c62615f15125	151	typedef struct {
mfiore	0:c62615f15125	152	uint32_t Up;
mfiore	0:c62615f15125	153	uint32_t Down;
mfiore	0:c62615f15125	154	uint32_t Joins;
mfiore	0:c62615f15125	155	uint32_t JoinFails;
mfiore	0:c62615f15125	156	uint32_t MissedAcks;
mfiore	0:c62615f15125	157	} mdot_stats;
mfiore	0:c62615f15125	158
mfiore	0:c62615f15125	159	typedef struct {
mfiore	0:c62615f15125	160	int16_t last;
mfiore	0:c62615f15125	161	int16_t min;
mfiore	0:c62615f15125	162	int16_t max;
mfiore	0:c62615f15125	163	int16_t avg;
mfiore	0:c62615f15125	164	} rssi_stats;
mfiore	0:c62615f15125	165
mfiore	0:c62615f15125	166	typedef struct {
mfiore	0:c62615f15125	167	int8_t last;
mfiore	0:c62615f15125	168	int8_t min;
mfiore	0:c62615f15125	169	int8_t max;
mfiore	0:c62615f15125	170	int8_t avg;
mfiore	0:c62615f15125	171	} snr_stats;
mfiore	0:c62615f15125	172
mfiore	0:c62615f15125	173	typedef struct {
mfiore	0:c62615f15125	174	bool status;
mfiore	0:c62615f15125	175	int32_t dBm;
mfiore	0:c62615f15125	176	uint32_t gateways;
mfiore	0:c62615f15125	177	std::vector<uint8_t> payload;
mfiore	0:c62615f15125	178	} link_check;
mfiore	0:c62615f15125	179
mfiore	0:c62615f15125	180	typedef struct {
mfiore	0:c62615f15125	181	int32_t status;
mfiore	0:c62615f15125	182	int16_t rssi;
mfiore	0:c62615f15125	183	int16_t snr;
mfiore	0:c62615f15125	184	} ping_response;
mfiore	0:c62615f15125	185
mfiore	0:c62615f15125	186	static const uint8_t MaxLengths_915[];
mfiore	0:c62615f15125	187	static const uint8_t MaxLengths_868[];
mfiore	0:c62615f15125	188
mfiore	0:c62615f15125	189	static std::string JoinModeStr(uint8_t mode);
mfiore	0:c62615f15125	190	static std::string ModeStr(uint8_t mode);
mfiore	0:c62615f15125	191	static std::string RxOutputStr(uint8_t format);
mfiore	0:c62615f15125	192	static std::string DataRateStr(uint8_t rate);
mfiore	0:c62615f15125	193	static std::string FrequencyBandStr(uint8_t band);
mfiore	0:c62615f15125	194	static std::string FrequencySubBandStr(uint8_t band);
mfiore	0:c62615f15125	195
mfiore	0:c62615f15125	196	/** Get a handle to the singleton object
mfiore	0:c62615f15125	197	* @returns pointer to mDot object
mfiore	0:c62615f15125	198	*/
mfiore	0:c62615f15125	199	static mDot* getInstance();
mfiore	0:c62615f15125	200
mfiore	0:c62615f15125	201	/** Get library version information
mfiore	0:c62615f15125	202	* @returns string containing library version information
mfiore	0:c62615f15125	203	*/
mfiore	0:c62615f15125	204	std::string getId();
mfiore	0:c62615f15125	205
mfiore	0:c62615f15125	206	/** Perform a soft reset of the system
mfiore	0:c62615f15125	207	*/
mfiore	0:c62615f15125	208	void resetCpu();
mfiore	0:c62615f15125	209
mfiore	0:c62615f15125	210	/** Reset config to factory default
mfiore	0:c62615f15125	211	*/
mfiore	0:c62615f15125	212	void resetConfig();
mfiore	0:c62615f15125	213
mfiore	0:c62615f15125	214	/** Save config data to non volatile memory
mfiore	0:c62615f15125	215	* @returns true if success, false if failure
mfiore	0:c62615f15125	216	*/
mfiore	0:c62615f15125	217	bool saveConfig();
mfiore	0:c62615f15125	218
mfiore	0:c62615f15125	219	/** Set the log level for the library
mfiore	0:c62615f15125	220	* options are:
mfiore	0:c62615f15125	221	* NONE_LEVEL - logging is off at this level
mfiore	0:c62615f15125	222	* FATAL_LEVEL - only critical errors will be reported
mfiore	0:c62615f15125	223	* ERROR_LEVEL
mfiore	0:c62615f15125	224	* WARNING_LEVEL
mfiore	0:c62615f15125	225	* INFO_LEVEL
mfiore	0:c62615f15125	226	* DEBUG_LEVEL
mfiore	0:c62615f15125	227	* TRACE_LEVEL - every detail will be reported
mfiore	0:c62615f15125	228	* @param level the level to log at
mfiore	0:c62615f15125	229	* @returns MDOT_OK if success
mfiore	0:c62615f15125	230	*/
mfiore	0:c62615f15125	231	int32_t setLogLevel(const uint8_t& level);
mfiore	0:c62615f15125	232
mfiore	0:c62615f15125	233	/** Get the current log level for the library
mfiore	0:c62615f15125	234	* @returns current log level
mfiore	0:c62615f15125	235	*/
Mike Fiore	6:390fc83d588d	236	uint8_t getLogLevel();
Mike Fiore	6:390fc83d588d	237
Mike Fiore	6:390fc83d588d	238	/** Enable or disable the activity LED.
Mike Fiore	6:390fc83d588d	239	* @param enable true to enable the LED, false to disable
Mike Fiore	6:390fc83d588d	240	*/
Mike Fiore	6:390fc83d588d	241	void setActivityLedEnable(const bool& enable);
Mike Fiore	4:94969e981dcc	242
Mike Fiore	6:390fc83d588d	243	/** Find out if the activity LED is enabled
Mike Fiore	6:390fc83d588d	244	* @returns true if activity LED is enabled, false if disabled
Mike Fiore	6:390fc83d588d	245	*/
Mike Fiore	6:390fc83d588d	246	bool getActivityLedEnable();
Mike Fiore	6:390fc83d588d	247
Mike Fiore	6:390fc83d588d	248	/** Use a different pin for the activity LED.
Mike Fiore	6:390fc83d588d	249	* The default is XBEE_RSSI.
Mike Fiore	6:390fc83d588d	250	* @param pin the new pin to use
Mike Fiore	6:390fc83d588d	251	*/
Mike Fiore	6:390fc83d588d	252	void setActivityLedPin(const PinName& pin);
Mike Fiore	6:390fc83d588d	253
Mike Fiore	5:0bfe6a650513	254	/** Use an external DigitalOut object for the activity LED.
Mike Fiore	5:0bfe6a650513	255	* The pointer must stay valid!
Mike Fiore	5:0bfe6a650513	256	* @param pin the DigitalOut object to use
Mike Fiore	5:0bfe6a650513	257	*/
Mike Fiore	5:0bfe6a650513	258	void setActivityLedPin(DigitalOut* pin);
Mike Fiore	6:390fc83d588d	259
Mike Fiore	6:390fc83d588d	260	/** Find out what pin the activity LED is on
Mike Fiore	6:390fc83d588d	261	* @returns the pin the activity LED is using
Mike Fiore	6:390fc83d588d	262	*/
Mike Fiore	6:390fc83d588d	263	PinName getActivityLedPin();
mfiore	0:c62615f15125	264
mfiore	0:c62615f15125	265	/** Get list of channel frequencies currently in use
mfiore	0:c62615f15125	266	* @returns vector of channels currently in use
mfiore	0:c62615f15125	267	*/
mfiore	0:c62615f15125	268	std::vector<uint32_t> getChannels();
mfiore	0:c62615f15125	269
mfiore	0:c62615f15125	270	/** Get frequency band
mfiore	0:c62615f15125	271	* @returns FB_915 if configured for United States, FB_868 if configured for Europe
mfiore	0:c62615f15125	272	*/
mfiore	0:c62615f15125	273	uint8_t getFrequencyBand();
mfiore	0:c62615f15125	274
mfiore	0:c62615f15125	275	/** Set frequency sub band
mfiore	0:c62615f15125	276	* only applicable if frequency band is set for United States (FB_915)
mfiore	0:c62615f15125	277	* sub band 0 will allow the radio to use all 64 channels
mfiore	0:c62615f15125	278	* sub band 1 - 8 will allow the radio to use the 8 channels in that sub band
mfiore	0:c62615f15125	279	* for use with Conduit gateway and MTAC_LORA, use sub bands 1 - 8, not sub band 0
mfiore	0:c62615f15125	280	* @param band the sub band to use (0 - 8)
mfiore	0:c62615f15125	281	* @returns MDOT_OK if success
mfiore	0:c62615f15125	282	*/
mfiore	0:c62615f15125	283	int32_t setFrequencySubBand(const uint8_t& band);
mfiore	0:c62615f15125	284
mfiore	0:c62615f15125	285	/** Get frequency sub band
mfiore	0:c62615f15125	286	* @returns frequency sub band currently in use
mfiore	0:c62615f15125	287	*/
mfiore	0:c62615f15125	288	uint8_t getFrequencySubBand();
mfiore	0:c62615f15125	289
mfiore	0:c62615f15125	290	/** Enable/disable public network mode
mfiore	0:c62615f15125	291	* for use with Conduit gateway and MTAC_LORA, disable public network mode
mfiore	0:c62615f15125	292	* @param on should be true to enable public network mode
mfiore	0:c62615f15125	293	* @returns MDOT_OK if success
mfiore	0:c62615f15125	294	*/
mfiore	0:c62615f15125	295	int32_t setPublicNetwork(const bool& on);
mfiore	0:c62615f15125	296
mfiore	0:c62615f15125	297	/** Get public network mode
mfiore	0:c62615f15125	298	* @returns true if public network mode is enabled
mfiore	0:c62615f15125	299	*/
mfiore	0:c62615f15125	300	bool getPublicNetwork();
mfiore	0:c62615f15125	301
mfiore	0:c62615f15125	302	/** Get the device ID
mfiore	0:c62615f15125	303	* @returns vector containing the device ID (size 8)
mfiore	0:c62615f15125	304	*/
mfiore	0:c62615f15125	305	std::vector<uint8_t> getDeviceId();
mfiore	0:c62615f15125	306
mfiore	0:c62615f15125	307	/** Set network address
mfiore	0:c62615f15125	308	* for use with MANUAL network join mode, will be assigned in OTA & AUTO_OTA modes
mfiore	0:c62615f15125	309	* @param addr a vector of 4 bytes
mfiore	0:c62615f15125	310	* @returns MDOT_OK if success
mfiore	0:c62615f15125	311	*/
mfiore	0:c62615f15125	312	int32_t setNetworkAddress(const std::vector<uint8_t>& addr);
mfiore	0:c62615f15125	313
mfiore	0:c62615f15125	314	/** Get network address
mfiore	0:c62615f15125	315	* @returns vector containing network address (size 4)
mfiore	0:c62615f15125	316	*/
mfiore	0:c62615f15125	317	std::vector<uint8_t> getNetworkAddress();
mfiore	0:c62615f15125	318
mfiore	0:c62615f15125	319	/** Set network session key
mfiore	0:c62615f15125	320	* for use with MANUAL network join mode, will be assigned in OTA & AUTO_OTA modes
mfiore	0:c62615f15125	321	* @param key a vector of 16 bytes
mfiore	0:c62615f15125	322	* @returns MDOT_OK if success
mfiore	0:c62615f15125	323	*/
mfiore	0:c62615f15125	324	int32_t setNetworkSessionKey(const std::vector<uint8_t>& key);
mfiore	0:c62615f15125	325
mfiore	0:c62615f15125	326	/** Get network session key
mfiore	0:c62615f15125	327	* @returns vector containing network session key (size 16)
mfiore	0:c62615f15125	328	*/
mfiore	0:c62615f15125	329	std::vector<uint8_t> getNetworkSessionKey();
mfiore	0:c62615f15125	330
mfiore	0:c62615f15125	331	/** Set data session key
mfiore	0:c62615f15125	332	* for use with MANUAL network join mode, will be assigned in OTA & AUTO_OTA modes
mfiore	0:c62615f15125	333	* @param key a vector of 16 bytes
mfiore	0:c62615f15125	334	* @returns MDOT_OK if success
mfiore	0:c62615f15125	335	*/
mfiore	0:c62615f15125	336	int32_t setDataSessionKey(const std::vector<uint8_t>& key);
mfiore	0:c62615f15125	337
mfiore	0:c62615f15125	338	/** Get data session key
mfiore	0:c62615f15125	339	* @returns vector containing data session key (size 16)
mfiore	0:c62615f15125	340	*/
mfiore	0:c62615f15125	341	std::vector<uint8_t> getDataSessionKey();
mfiore	0:c62615f15125	342
mfiore	0:c62615f15125	343	/** Set network name
mfiore	0:c62615f15125	344	* for use with OTA & AUTO_OTA network join modes
mfiore	0:c62615f15125	345	* generates network ID (crc64 of name) automatically
mfiore	0:c62615f15125	346	* @param name a string of of at least 8 bytes and no more than 128 bytes
mfiore	0:c62615f15125	347	* @return MDOT_OK if success
mfiore	0:c62615f15125	348	*/
mfiore	0:c62615f15125	349	int32_t setNetworkName(const std::string& name);
mfiore	0:c62615f15125	350
mfiore	0:c62615f15125	351	/** Get network name
mfiore	0:c62615f15125	352	* @return string containing network name (size 8 to 128)
mfiore	0:c62615f15125	353	*/
mfiore	0:c62615f15125	354	std::string getNetworkName();
mfiore	0:c62615f15125	355
mfiore	0:c62615f15125	356	/** Set network ID
mfiore	0:c62615f15125	357	* for use with OTA & AUTO_OTA network join modes
mfiore	0:c62615f15125	358	* setting network ID via this function sets network name to empty
mfiore	0:c62615f15125	359	* @param id a vector of 8 bytes
mfiore	0:c62615f15125	360	* @returns MDOT_OK if success
mfiore	0:c62615f15125	361	*/
mfiore	0:c62615f15125	362	int32_t setNetworkId(const std::vector<uint8_t>& id);
mfiore	0:c62615f15125	363
mfiore	0:c62615f15125	364	/** Get network ID
mfiore	0:c62615f15125	365	* @returns vector containing network ID (size 8)
mfiore	0:c62615f15125	366	*/
mfiore	0:c62615f15125	367	std::vector<uint8_t> getNetworkId();
mfiore	0:c62615f15125	368
mfiore	0:c62615f15125	369	/** Set network passphrase
mfiore	0:c62615f15125	370	* for use with OTA & AUTO_OTA network join modes
mfiore	0:c62615f15125	371	* generates network key (cmac of passphrase) automatically
mfiore	0:c62615f15125	372	* @param name a string of of at least 8 bytes and no more than 128 bytes
mfiore	0:c62615f15125	373	* @return MDOT_OK if success
mfiore	0:c62615f15125	374	*/
mfiore	0:c62615f15125	375	int32_t setNetworkPassphrase(const std::string& passphrase);
mfiore	0:c62615f15125	376
mfiore	0:c62615f15125	377	/** Get network passphrase
mfiore	0:c62615f15125	378	* @return string containing network passphrase (size 8 to 128)
mfiore	0:c62615f15125	379	*/
mfiore	0:c62615f15125	380	std::string getNetworkPassphrase();
mfiore	0:c62615f15125	381
mfiore	0:c62615f15125	382	/** Set network key
mfiore	0:c62615f15125	383	* for use with OTA & AUTO_OTA network join modes
mfiore	0:c62615f15125	384	* setting network key via this function sets network passphrase to empty
mfiore	0:c62615f15125	385	* @param id a vector of 16 bytes
mfiore	0:c62615f15125	386	* @returns MDOT_OK if success
mfiore	0:c62615f15125	387	*/
mfiore	0:c62615f15125	388	int32_t setNetworkKey(const std::vector<uint8_t>& id);
mfiore	0:c62615f15125	389
mfiore	0:c62615f15125	390	/** Get network key
mfiore	0:c62615f15125	391	* @returns a vector containing network key (size 16)
mfiore	0:c62615f15125	392	*/
mfiore	0:c62615f15125	393	std::vector<uint8_t> getNetworkKey();
mfiore	0:c62615f15125	394
Mike Fiore	6:390fc83d588d	395	/** Set join byte order
Mike Fiore	6:390fc83d588d	396	* @param order 0:LSB 1:MSB
Mike Fiore	6:390fc83d588d	397	*/
Mike Fiore	6:390fc83d588d	398	uint32_t setJoinByteOrder(uint8_t order);
Mike Fiore	6:390fc83d588d	399
Mike Fiore	6:390fc83d588d	400	/** Get join byte order
Mike Fiore	6:390fc83d588d	401	* @returns byte order to use in joins 0:LSB 1:MSB
Mike Fiore	6:390fc83d588d	402	*/
Mike Fiore	6:390fc83d588d	403	uint8_t getJoinByteOrder();
Mike Fiore	6:390fc83d588d	404
mfiore	0:c62615f15125	405	/** Attempt to join network
mfiore	0:c62615f15125	406	* retries according to configuration set by setJoinRetries()
mfiore	0:c62615f15125	407	* @returns MDOT_OK if success
mfiore	0:c62615f15125	408	*/
mfiore	0:c62615f15125	409	int32_t joinNetwork();
mfiore	0:c62615f15125	410
mfiore	0:c62615f15125	411	/** Attempts to join network once
mfiore	0:c62615f15125	412	* @returns MDOT_OK if success
mfiore	0:c62615f15125	413	*/
mfiore	0:c62615f15125	414	int32_t joinNetworkOnce();
mfiore	0:c62615f15125	415
mfiore	0:c62615f15125	416	/** Resets current network session, essentially disconnecting from the network
mfiore	0:c62615f15125	417	* has no effect for MANUAL network join mode
mfiore	0:c62615f15125	418	*/
mfiore	0:c62615f15125	419	void resetNetworkSession();
mfiore	0:c62615f15125	420
mfiore	0:c62615f15125	421	/** Set number of times joining will retry before giving up
mfiore	0:c62615f15125	422	* @param retries must be between 0 - 255
mfiore	0:c62615f15125	423	* @returns MDOT_OK if success
mfiore	0:c62615f15125	424	*/
mfiore	0:c62615f15125	425	int32_t setJoinRetries(const uint8_t& retries);
mfiore	0:c62615f15125	426
mfiore	0:c62615f15125	427	/** Set number of times joining will retry before giving up
mfiore	0:c62615f15125	428	* @returns join retries (0 - 255)
mfiore	0:c62615f15125	429	*/
mfiore	0:c62615f15125	430	uint8_t getJoinRetries();
mfiore	0:c62615f15125	431
mfiore	0:c62615f15125	432	/** Set network join mode
mfiore	0:c62615f15125	433	* MANUAL: set network address and session keys manually
mfiore	0:c62615f15125	434	* OTA: User sets network name and passphrase, then attempts to join
mfiore	0:c62615f15125	435	* AUTO_OTA: same as OTA, but network sessions can be saved and restored
mfiore	0:c62615f15125	436	* @param mode MANUAL, OTA, or AUTO_OTA
mfiore	0:c62615f15125	437	* @returns MDOT_OK if success
mfiore	0:c62615f15125	438	*/
mfiore	0:c62615f15125	439	int32_t setJoinMode(const uint8_t& mode);
mfiore	0:c62615f15125	440
mfiore	0:c62615f15125	441	/** Get network join mode
mfiore	0:c62615f15125	442	* @returns MANUAL, OTA, or AUTO_OTA
mfiore	0:c62615f15125	443	*/
mfiore	0:c62615f15125	444	uint8_t getJoinMode();
mfiore	0:c62615f15125	445
mfiore	0:c62615f15125	446	/** Get network join status
mfiore	0:c62615f15125	447	* @returns true if currently joined to network
mfiore	0:c62615f15125	448	*/
mfiore	0:c62615f15125	449	bool getNetworkJoinStatus();
mfiore	0:c62615f15125	450
mfiore	0:c62615f15125	451	/** Do a network link check
mfiore	0:c62615f15125	452	* application data may be returned in response to a network link check command
mfiore	0:c62615f15125	453	* @returns link_check structure containing success, dBm above noise floor, gateways in range, and packet payload
mfiore	0:c62615f15125	454	*/
mfiore	0:c62615f15125	455	link_check networkLinkCheck();
mfiore	0:c62615f15125	456
mfiore	0:c62615f15125	457	/** Set network link check count to perform automatic link checks every count packets
mfiore	0:c62615f15125	458	* only applicable if ACKs are disabled
mfiore	0:c62615f15125	459	* @param count must be between 0 - 255
mfiore	0:c62615f15125	460	* @returns MDOT_OK if success
mfiore	0:c62615f15125	461	*/
mfiore	0:c62615f15125	462	int32_t setLinkCheckCount(const uint8_t& count);
mfiore	0:c62615f15125	463
mfiore	0:c62615f15125	464	/** Get network link check count
mfiore	0:c62615f15125	465	* @returns count (0 - 255)
mfiore	0:c62615f15125	466	*/
mfiore	0:c62615f15125	467	uint8_t getLinkCheckCount();
mfiore	0:c62615f15125	468
mfiore	0:c62615f15125	469	/** Set network link check threshold, number of link check failures or missed acks to tolerate
mfiore	0:c62615f15125	470	* before considering network connection lost
mfiore	0:c62615f15125	471	* @pararm count must be between 0 - 255
mfiore	0:c62615f15125	472	* @returns MDOT_OK if success
mfiore	0:c62615f15125	473	*/
mfiore	0:c62615f15125	474	int32_t setLinkCheckThreshold(const uint8_t& count);
mfiore	0:c62615f15125	475
mfiore	0:c62615f15125	476	/** Get network link check threshold
mfiore	0:c62615f15125	477	* @returns threshold (0 - 255)
mfiore	0:c62615f15125	478	*/
mfiore	0:c62615f15125	479	uint8_t getLinkCheckThreshold();
mfiore	0:c62615f15125	480
mfiore	0:c62615f15125	481	/** Get UpLinkCounter
mfiore	0:c62615f15125	482	* @returns number of packets sent to the gateway during this network session (sequence number)
mfiore	0:c62615f15125	483	*/
mfiore	0:c62615f15125	484	uint32_t getUpLinkCounter();
mfiore	0:c62615f15125	485
mfiore	0:c62615f15125	486	/** Enable/disable AES encryption
mfiore	0:c62615f15125	487	* AES encryption must be enabled for use with Conduit gateway and MTAC_LORA card
mfiore	0:c62615f15125	488	* @param on true for AES encryption to be enabled
mfiore	0:c62615f15125	489	* @returns MDOT_OK if success
mfiore	0:c62615f15125	490	*/
mfiore	0:c62615f15125	491	int32_t setAesEncryption(const bool& on);
mfiore	0:c62615f15125	492
mfiore	0:c62615f15125	493	/** Get AES encryption
mfiore	0:c62615f15125	494	* @returns true if AES encryption is enabled
mfiore	0:c62615f15125	495	*/
mfiore	0:c62615f15125	496	bool getAesEncryption();
mfiore	0:c62615f15125	497
mfiore	0:c62615f15125	498	/** Get RSSI stats
mfiore	0:c62615f15125	499	* @returns rssi_stats struct containing last, min, max, and avg RSSI
mfiore	0:c62615f15125	500	*/
mfiore	0:c62615f15125	501	rssi_stats getRssiStats();
mfiore	0:c62615f15125	502
mfiore	0:c62615f15125	503	/** Get SNR stats
mfiore	0:c62615f15125	504	* @returns snr_stats struct containing last, min, max, and avg SNR
mfiore	0:c62615f15125	505	*/
mfiore	0:c62615f15125	506	snr_stats getSnrStats();
mfiore	0:c62615f15125	507
mfiore	0:c62615f15125	508	/** Get ms until next free channel
mfiore	0:c62615f15125	509	* only applicable for European models, US models return 0
mfiore	0:c62615f15125	510	* @returns time (ms) until a channel is free to use for transmitting
mfiore	0:c62615f15125	511	*/
mfiore	0:c62615f15125	512	uint32_t getNextTxMs();
mfiore	0:c62615f15125	513
mfiore	0:c62615f15125	514	/** Get data pending
mfiore	0:c62615f15125	515	* only valid after sending data to the gateway
mfiore	0:c62615f15125	516	* @returns true if server has available packet(s)
mfiore	0:c62615f15125	517	*/
mfiore	0:c62615f15125	518	bool getDataPending();
mfiore	0:c62615f15125	519
mfiore	0:c62615f15125	520	/** Get transmitting
mfiore	0:c62615f15125	521	* @returns true if currently transmitting
mfiore	0:c62615f15125	522	*/
mfiore	0:c62615f15125	523	bool getIsTransmitting();
mfiore	0:c62615f15125	524
mfiore	0:c62615f15125	525	/** Set TX data rate
mfiore	0:c62615f15125	526	* data rates affect maximum payload size
mfiore	0:c62615f15125	527	* @param dr SF_7 - SF_12 for Europe, SF_7 - SF_10 for United States
mfiore	0:c62615f15125	528	* @returns MDOT_OK if success
mfiore	0:c62615f15125	529	*/
mfiore	0:c62615f15125	530	int32_t setTxDataRate(const uint8_t& dr);
mfiore	0:c62615f15125	531
mfiore	0:c62615f15125	532	/** Get TX data rate
mfiore	0:c62615f15125	533	* @returns current TX data rate (SF_7 - SF_12)
mfiore	0:c62615f15125	534	*/
mfiore	0:c62615f15125	535	uint8_t getTxDataRate();
mfiore	0:c62615f15125	536
mfiore	0:c62615f15125	537	/** Set TX power
mfiore	0:c62615f15125	538	* power affects maximum range
mfiore	0:c62615f15125	539	* @param power 2 dBm - 20 dBm
mfiore	0:c62615f15125	540	* @returns MDOT_OK if success
mfiore	0:c62615f15125	541	*/
mfiore	0:c62615f15125	542	int32_t setTxPower(const uint32_t& power);
mfiore	0:c62615f15125	543
mfiore	0:c62615f15125	544	/** Get TX power
mfiore	0:c62615f15125	545	* @returns TX power (2 dBm - 20 dBm)
mfiore	0:c62615f15125	546	*/
mfiore	0:c62615f15125	547	uint32_t getTxPower();
mfiore	0:c62615f15125	548
mfiore	0:c62615f15125	549	/** Enable/disable TX waiting for rx windows
mfiore	0:c62615f15125	550	* when enabled, send calls will block until a packet is received or RX timeout
mfiore	0:c62615f15125	551	* @param enable set to true if expecting responses to transmitted packets
mfiore	0:c62615f15125	552	* @returns MDOT_OK if success
mfiore	0:c62615f15125	553	*/
mfiore	0:c62615f15125	554	int32_t setTxWait(const bool& enable);
mfiore	0:c62615f15125	555
mfiore	0:c62615f15125	556	/** Get TX wait
mfiore	0:c62615f15125	557	* @returns true if TX wait is enabled
mfiore	0:c62615f15125	558	*/
mfiore	0:c62615f15125	559	bool getTxWait();
mfiore	0:c62615f15125	560
mfiore	0:c62615f15125	561	/** Get time on air
mfiore	0:c62615f15125	562	* @returns the amount of time (in ms) it would take to send bytes bytes based on current configuration
mfiore	0:c62615f15125	563	*/
mfiore	0:c62615f15125	564	uint32_t getTimeOnAir(uint8_t bytes);
mfiore	0:c62615f15125	565
mfiore	0:c62615f15125	566	/** Get min frequency
mfiore	0:c62615f15125	567	* @returns minimum frequency based on current configuration
mfiore	0:c62615f15125	568	*/
mfiore	0:c62615f15125	569	uint32_t getMinFrequency();
mfiore	0:c62615f15125	570
mfiore	0:c62615f15125	571	/** Get max frequency
mfiore	0:c62615f15125	572	* @returns maximum frequency based on current configuration
mfiore	0:c62615f15125	573	*/
mfiore	0:c62615f15125	574	uint32_t getMaxFrequency();
mfiore	0:c62615f15125	575
mfiore	0:c62615f15125	576	/** Set forward error correction bytes
mfiore	0:c62615f15125	577	* @param bytes 1 - 4 bytes
mfiore	0:c62615f15125	578	* @returns MDOT_OK if success
mfiore	0:c62615f15125	579	*/
mfiore	0:c62615f15125	580	int32_t setFec(const uint8_t& bytes);
mfiore	0:c62615f15125	581
mfiore	0:c62615f15125	582	/** Get forward error correction bytes
mfiore	0:c62615f15125	583	* @returns bytes (1 - 4)
mfiore	0:c62615f15125	584	*/
mfiore	0:c62615f15125	585	uint8_t getFec();
mfiore	0:c62615f15125	586
mfiore	0:c62615f15125	587	/** Enable/disable CRC checking of packets
mfiore	0:c62615f15125	588	* CRC checking must be enabled for use with Conduit gateway and MTAC_LORA card
mfiore	0:c62615f15125	589	* @param on set to true to enable CRC checking
mfiore	0:c62615f15125	590	* @returns MDOT_OK if success
mfiore	0:c62615f15125	591	*/
mfiore	0:c62615f15125	592	int32_t setCrc(const bool& on);
mfiore	0:c62615f15125	593
mfiore	0:c62615f15125	594	/** Get CRC checking
mfiore	0:c62615f15125	595	* @returns true if CRC checking is enabled
mfiore	0:c62615f15125	596	*/
mfiore	0:c62615f15125	597	bool getCrc();
mfiore	0:c62615f15125	598
mfiore	0:c62615f15125	599	/** Set ack
mfiore	0:c62615f15125	600	* @param retries 0 to disable acks, otherwise 1 - 8
mfiore	0:c62615f15125	601	* @returns MDOT_OK if success
mfiore	0:c62615f15125	602	*/
mfiore	0:c62615f15125	603	int32_t setAck(const uint8_t& retries);
mfiore	0:c62615f15125	604
mfiore	0:c62615f15125	605	/** Get ack
mfiore	0:c62615f15125	606	* @returns 0 if acks are disabled, otherwise retries (1 - 8)
mfiore	0:c62615f15125	607	*/
mfiore	0:c62615f15125	608	uint8_t getAck();
mfiore	0:c62615f15125	609
mfiore	0:c62615f15125	610	/** Send data to the gateway
mfiore	0:c62615f15125	611	* validates data size (based on spreading factor)
mfiore	0:c62615f15125	612	* @param data a vector of up to 242 bytes (may be less based on spreading factor)
mfiore	0:c62615f15125	613	* @returns MDOT_OK if packet was sent successfully (ACKs disabled), or if an ACK was received (ACKs enabled)
mfiore	0:c62615f15125	614	*/
mfiore	0:c62615f15125	615	int32_t send(const std::vector<uint8_t>& data, const bool& blocking = true, const bool& highBw = false);
mfiore	0:c62615f15125	616
mfiore	0:c62615f15125	617	/** Fetch data received from the gateway
mfiore	0:c62615f15125	618	* this function only checks to see if a packet has been received - it does not open a receive window
mfiore	0:c62615f15125	619	* send() must be called before recv()
mfiore	0:c62615f15125	620	* @param data a vector to put the received data into
mfiore	0:c62615f15125	621	* @returns MDOT_OK if packet was successfully received
mfiore	0:c62615f15125	622	*/
mfiore	0:c62615f15125	623	int32_t recv(std::vector<uint8_t>& data);
mfiore	0:c62615f15125	624
Mike Fiore	6:390fc83d588d	625
mfiore	0:c62615f15125	626	/** Ping
mfiore	0:c62615f15125	627	* status will be MDOT_OK if ping succeeded
mfiore	0:c62615f15125	628	* @returns ping_response struct containing status, RSSI, and SNR
mfiore	0:c62615f15125	629	*/
mfiore	0:c62615f15125	630	ping_response ping();
mfiore	0:c62615f15125	631
mfiore	0:c62615f15125	632	/** Get return code string
mfiore	0:c62615f15125	633	* @returns string containing a description of the given error code
mfiore	0:c62615f15125	634	*/
mfiore	0:c62615f15125	635	static std::string getReturnCodeString(const int32_t& code);
mfiore	0:c62615f15125	636
mfiore	0:c62615f15125	637	/** Get last error
mfiore	0:c62615f15125	638	* @returns string explaining the last error that occured
mfiore	0:c62615f15125	639	*/
mfiore	0:c62615f15125	640	std::string getLastError();
mfiore	0:c62615f15125	641
Mike Fiore	7:683dba5d576f	642	/** Go to sleep
Mike Fiore	7:683dba5d576f	643	* @param interval the number of seconds to sleep before waking up if wakeup_mode == RTC_ALARM, else ignored
Mike Fiore	7:683dba5d576f	644	* @param wakeup_mode RTC_ALARM, INTERRUPT
Mike Fiore	7:683dba5d576f	645	* if RTC_ALARM the real time clock is configured to wake the device up after the specified interval
Mike Fiore	7:683dba5d576f	646	* if INTERRUPT the device will wake up on the rising edge of the interrupt pin
Mike Fiore	7:683dba5d576f	647	* @param deepsleep if true go into deep sleep mode (lowest power, all memory and registers are lost, peripherals turned off)
Mike Fiore	7:683dba5d576f	648	* else go into sleep mode (low power, memory and registers are maintained, peripherals stay on)
Mike Fiore	7:683dba5d576f	649	*
Mike Fiore	7:683dba5d576f	650	* CURRENTLY ONLY DEEPSLEEP MODE IS AVAILABLE
Mike Fiore	7:683dba5d576f	651	*
Mike Fiore	7:683dba5d576f	652	* in sleep mode, the device can be woken up on any of the XBEE pins or by the RTC alarm
Mike Fiore	7:683dba5d576f	653	* in deepsleep mode, the device can only be woken up using the WKUP pin (PA0, XBEE_DIO7) or by the RTC alarm
Mike Fiore	7:683dba5d576f	654	*/
Mike Fiore	7:683dba5d576f	655	void sleep(const uint32_t& interval, const uint8_t& wakeup_mode = RTC_ALARM, const bool& deepsleep = true);
Mike Fiore	7:683dba5d576f	656
Mike Fiore	7:683dba5d576f	657	/** Set wake pin
Mike Fiore	7:683dba5d576f	658	* @param pin the pin to use to wake the device from sleep mode
Mike Fiore	7:683dba5d576f	659	*/
Mike Fiore	7:683dba5d576f	660	void setWakePin(const PinName& pin);
Mike Fiore	7:683dba5d576f	661
Mike Fiore	7:683dba5d576f	662	/** Get wake pin
Mike Fiore	7:683dba5d576f	663	* @returns the pin to use to wake the device from sleep mode
Mike Fiore	7:683dba5d576f	664	*/
Mike Fiore	7:683dba5d576f	665	PinName getWakePin();
Mike Fiore	7:683dba5d576f	666
mfiore	0:c62615f15125	667	/******************************************
mfiore	0:c62615f15125	668	* THESE FEATURES ARE NOT FULLY IMPLEMENTED
mfiore	0:c62615f15125	669	*****************************************/
mfiore	0:c62615f15125	670	// get/set adaptive data rate
mfiore	0:c62615f15125	671	// configure data rates and power levels based on signal to noise information from gateway
mfiore	0:c62615f15125	672	// true == adaptive data rate is on
mfiore	0:c62615f15125	673	// set function returns MDOT_OK if success
mfiore	0:c62615f15125	674	int32_t setAdr(const bool& on);
mfiore	0:c62615f15125	675	bool getAdr();
mfiore	0:c62615f15125	676
mfiore	0:c62615f15125	677	/*************************************************************************
mfiore	0:c62615f15125	678	* The following functions are only used by the AT command application and
mfiore	0:c62615f15125	679	* should not be used by standard applications consuming the mDot library
mfiore	0:c62615f15125	680	************************************************************************/
Mike Fiore	7:683dba5d576f	681
mfiore	0:c62615f15125	682	// set/get configured baud rate for command port
mfiore	0:c62615f15125	683	// only for use in conjunction with AT interface
mfiore	0:c62615f15125	684	// set function returns MDOT_OK if success
mfiore	0:c62615f15125	685	int32_t setBaud(const uint32_t& baud);
mfiore	0:c62615f15125	686	uint32_t getBaud();
mfiore	0:c62615f15125	687
mfiore	0:c62615f15125	688	// set/get baud rate for debug port
mfiore	0:c62615f15125	689	// set function returns MDOT_OK if success
mfiore	0:c62615f15125	690	int32_t setDebugBaud(const uint32_t& baud);
mfiore	0:c62615f15125	691	uint32_t getDebugBaud();
mfiore	0:c62615f15125	692
mfiore	0:c62615f15125	693	// set/get command terminal echo
mfiore	0:c62615f15125	694	// set function returns MDOT_OK if success
mfiore	0:c62615f15125	695	int32_t setEcho(const bool& on);
mfiore	0:c62615f15125	696	bool getEcho();
mfiore	0:c62615f15125	697
mfiore	0:c62615f15125	698	// set/get command terminal verbose mode
mfiore	0:c62615f15125	699	// set function returns MDOT_OK if success
mfiore	0:c62615f15125	700	int32_t setVerbose(const bool& on);
mfiore	0:c62615f15125	701	bool getVerbose();
mfiore	0:c62615f15125	702
mfiore	0:c62615f15125	703	// set/get startup mode
mfiore	0:c62615f15125	704	// COMMAND_MODE (default), starts up ready to accept AT commands
mfiore	0:c62615f15125	705	// SERIAL_MODE, read serial data and send it as LoRa packets
mfiore	0:c62615f15125	706	// set function returns MDOT_OK if success
mfiore	0:c62615f15125	707	int32_t setStartUpMode(const uint8_t& mode);
mfiore	0:c62615f15125	708	uint8_t getStartUpMode();
mfiore	0:c62615f15125	709
mfiore	0:c62615f15125	710	int32_t setRxDataRate(const uint8_t& dr);
mfiore	0:c62615f15125	711	uint8_t getRxDataRate();
mfiore	0:c62615f15125	712
mfiore	0:c62615f15125	713	// get/set TX/RX frequency
mfiore	0:c62615f15125	714	// if frequency band == FB_868 (Europe), must be between 863000000 - 870000000
mfiore	0:c62615f15125	715	// if frequency band == FB_915 (United States), must be between 902000000-928000000
mfiore	0:c62615f15125	716	// if set to 0, device will hop frequencies
mfiore	0:c62615f15125	717	// set function returns MDOT_OK if success
mfiore	0:c62615f15125	718	int32_t setTxFrequency(const uint32_t& freq);
mfiore	0:c62615f15125	719	uint32_t getTxFrequency();
mfiore	0:c62615f15125	720	int32_t setRxFrequency(const uint32_t& freq);
mfiore	0:c62615f15125	721	uint32_t getRxFrequency();
mfiore	0:c62615f15125	722
mfiore	0:c62615f15125	723	// get/set TX/RX inverted
mfiore	0:c62615f15125	724	// true == signal is inverted
mfiore	0:c62615f15125	725	// set function returns MDOT_OK if success
mfiore	0:c62615f15125	726	int32_t setTxInverted(const bool& on);
mfiore	0:c62615f15125	727	bool getTxInverted();
mfiore	0:c62615f15125	728	int32_t setRxInverted(const bool& on);
mfiore	0:c62615f15125	729	bool getRxInverted();
mfiore	0:c62615f15125	730
mfiore	0:c62615f15125	731	// get/set RX output mode
mfiore	0:c62615f15125	732	// valid options are HEXADECIMAL and BINARY
mfiore	0:c62615f15125	733	// set function returns MDOT_OK if success
mfiore	0:c62615f15125	734	int32_t setRxOutput(const uint8_t& mode);
mfiore	0:c62615f15125	735	uint8_t getRxOutput();
mfiore	0:c62615f15125	736
mfiore	0:c62615f15125	737	// get/set serial wake interval
mfiore	0:c62615f15125	738	// valid values are 2 s - INT_MAX (2147483647) s
mfiore	0:c62615f15125	739	// set function returns MDOT_OK if success
Mike Fiore	7:683dba5d576f	740	int32_t setWakeInterval(const uint32_t& interval);
Mike Fiore	7:683dba5d576f	741	uint32_t getWakeInterval();
mfiore	0:c62615f15125	742
mfiore	0:c62615f15125	743	// get/set serial wake delay
mfiore	0:c62615f15125	744	// valid values are 2 ms - INT_MAX (2147483647) ms
mfiore	0:c62615f15125	745	// set function returns MDOT_OK if success
Mike Fiore	7:683dba5d576f	746	int32_t setWakeDelay(const uint32_t& delay);
Mike Fiore	7:683dba5d576f	747	uint32_t getWakeDelay();
mfiore	0:c62615f15125	748
mfiore	0:c62615f15125	749	// get/set serial receive timeout
mfiore	0:c62615f15125	750	// valid values are 0 ms - 65000 ms
mfiore	0:c62615f15125	751	// set function returns MDOT_OK if success
Mike Fiore	7:683dba5d576f	752	int32_t setWakeTimeout(const uint16_t& timeout);
Mike Fiore	7:683dba5d576f	753	uint16_t getWakeTimeout();
Mike Fiore	7:683dba5d576f	754
Mike Fiore	7:683dba5d576f	755	// get/set serial wake mode
Mike Fiore	7:683dba5d576f	756	// valid values are INTERRUPT or RTC_ALARM
Mike Fiore	7:683dba5d576f	757	// set function returns MDOT_OK if success
Mike Fiore	7:683dba5d576f	758	int32_t setWakeMode(const uint8_t& delay);
Mike Fiore	7:683dba5d576f	759	uint8_t getWakeMode();
Mike Fiore	7:683dba5d576f	760
Mike Fiore	7:683dba5d576f	761	// Save user file data to flash
Mike Fiore	7:683dba5d576f	762	// file - name of file max 30 chars
Mike Fiore	7:683dba5d576f	763	// data - data of file
Mike Fiore	7:683dba5d576f	764	// size - size of file
Mike Fiore	7:683dba5d576f	765	bool saveUserFile(const char* file, void* data, uint32_t size);
Mike Fiore	7:683dba5d576f	766
Mike Fiore	7:683dba5d576f	767	// Append user file data to flash
Mike Fiore	7:683dba5d576f	768	// file - name of file max 30 chars
Mike Fiore	7:683dba5d576f	769	// data - data of file
Mike Fiore	7:683dba5d576f	770	// size - size of file
Mike Fiore	7:683dba5d576f	771	bool appendUserFile(const char* file, void* data, uint32_t size);
Mike Fiore	7:683dba5d576f	772
Mike Fiore	7:683dba5d576f	773	// Read user file data from flash
Mike Fiore	7:683dba5d576f	774	// file - name of file max 30 chars
Mike Fiore	7:683dba5d576f	775	// data - data of file
Mike Fiore	7:683dba5d576f	776	// size - size of file
Mike Fiore	7:683dba5d576f	777	bool readUserFile(const char* file, void* data, uint32_t size);
Mike Fiore	7:683dba5d576f	778
Mike Fiore	7:683dba5d576f	779	// Move a user file in flash
Mike Fiore	7:683dba5d576f	780	// file - name of file
Mike Fiore	7:683dba5d576f	781	// new_name - new name of file
Mike Fiore	7:683dba5d576f	782	bool moveUserFile(const char* file, const char* new_name);
Mike Fiore	7:683dba5d576f	783
Mike Fiore	7:683dba5d576f	784	// Delete user file data from flash
Mike Fiore	7:683dba5d576f	785	// file - name of file max 30 chars
Mike Fiore	7:683dba5d576f	786	bool deleteUserFile(const char* file);
Mike Fiore	7:683dba5d576f	787
Mike Fiore	7:683dba5d576f	788	// Open user file in flash, max of 4 files open concurrently
Mike Fiore	7:683dba5d576f	789	// file - name of file max 30 chars
Mike Fiore	7:683dba5d576f	790	// mode - combination of FM_APPEND \| FM_TRUNC \| FM_CREAT \|
Mike Fiore	7:683dba5d576f	791	// FM_RDONLY \| FM_WRONLY \| FM_RDWR \| FM_DIRECT
Mike Fiore	7:683dba5d576f	792	// returns - mdot_file struct, fd field will be a negative value if file could not be opened
Mike Fiore	7:683dba5d576f	793	mDot::mdot_file openUserFile(const char* file, int mode);
Mike Fiore	7:683dba5d576f	794
Mike Fiore	7:683dba5d576f	795	// Seek an open file
Mike Fiore	7:683dba5d576f	796	// file - mdot file struct
Mike Fiore	7:683dba5d576f	797	// offset - offset in bytes
Mike Fiore	7:683dba5d576f	798	// whence - where offset is based SEEK_SET, SEEK_CUR, SEEK_END
Mike Fiore	7:683dba5d576f	799	bool seekUserFile(mDot::mdot_file& file, size_t offset, int whence);
Mike Fiore	7:683dba5d576f	800
Mike Fiore	7:683dba5d576f	801	// Read bytes from open file
Mike Fiore	7:683dba5d576f	802	// file - mdot file struct
Mike Fiore	7:683dba5d576f	803	// data - mem location to store data
Mike Fiore	7:683dba5d576f	804	// length - number of bytes to read
Mike Fiore	7:683dba5d576f	805	// returns - number of bytes written
Mike Fiore	7:683dba5d576f	806	int readUserFile(mDot::mdot_file& file, void* data, size_t length);
Mike Fiore	7:683dba5d576f	807
Mike Fiore	7:683dba5d576f	808	// Write bytes to open file
Mike Fiore	7:683dba5d576f	809	// file - mdot file struct
Mike Fiore	7:683dba5d576f	810	// data - data to write
Mike Fiore	7:683dba5d576f	811	// length - number of bytes to write
Mike Fiore	7:683dba5d576f	812	// returns - number of bytes written
Mike Fiore	7:683dba5d576f	813	int writeUserFile(mDot::mdot_file& file, void* data, size_t length);
Mike Fiore	7:683dba5d576f	814
Mike Fiore	7:683dba5d576f	815	// Close open file
Mike Fiore	7:683dba5d576f	816	// file - mdot file struct
Mike Fiore	7:683dba5d576f	817	bool closeUserFile(mDot::mdot_file& file);
Mike Fiore	7:683dba5d576f	818
Mike Fiore	7:683dba5d576f	819	// List user files stored in flash
Mike Fiore	7:683dba5d576f	820	std::vector<mDot::mdot_file> listUserFiles();
Mike Fiore	7:683dba5d576f	821
Mike Fiore	7:683dba5d576f	822	// Move file into the firmware upgrade path to be flashed on next boot
Mike Fiore	7:683dba5d576f	823	// file - name of file
Mike Fiore	7:683dba5d576f	824	bool moveUserFileToFirmwareUpgrade(const char* file);
Mike Fiore	7:683dba5d576f	825
Mike Fiore	7:683dba5d576f	826	// get current statistics
Mike Fiore	7:683dba5d576f	827	// Join Attempts, Join Fails, Up Packets, Down Packets, Missed Acks
Mike Fiore	7:683dba5d576f	828	mdot_stats getStats();
Mike Fiore	7:683dba5d576f	829
Mike Fiore	7:683dba5d576f	830	// reset statistics
Mike Fiore	7:683dba5d576f	831	// Join Attempts, Join Fails, Up Packets, Down Packets, Missed Acks
Mike Fiore	7:683dba5d576f	832	void resetStats();
Mike Fiore	7:683dba5d576f	833
Mike Fiore	7:683dba5d576f	834	// Convert pin number 2-8 to pin name DIO2-DI8
Mike Fiore	7:683dba5d576f	835	static PinName pinNum2Name(uint8_t num);
Mike Fiore	7:683dba5d576f	836
Mike Fiore	7:683dba5d576f	837	// Convert pin name DIO2-DI8 to pin number 2-8
Mike Fiore	7:683dba5d576f	838	static uint8_t pinName2Num(PinName name);
Mike Fiore	7:683dba5d576f	839
Mike Fiore	7:683dba5d576f	840	// Convert pin name DIO2-DI8 to string
Mike Fiore	7:683dba5d576f	841	static std::string pinName2Str(PinName name);
Mike Fiore	7:683dba5d576f	842
mfiore	0:c62615f15125	843
mfiore	0:c62615f15125	844	uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
mfiore	0:c62615f15125	845
mfiore	0:c62615f15125	846	// MTS_RADIO_DEBUG_COMMANDS
Mike Fiore	7:683dba5d576f	847
Mike Fiore	7:683dba5d576f	848	void openRxWindow(uint32_t timeout, uint8_t bandwidth = 0);
Mike Fiore	6:390fc83d588d	849	void sendContinuous();
mfiore	0:c62615f15125	850	int32_t setDeviceId(const std::vector<uint8_t>& id);
mfiore	0:c62615f15125	851	int32_t setFrequencyBand(const uint8_t& band);
mfiore	0:c62615f15125	852	bool saveProtectedConfig();
mfiore	0:c62615f15125	853	void resetRadio();
mfiore	0:c62615f15125	854	int32_t setRadioMode(const uint8_t& mode);
mfiore	0:c62615f15125	855	std::map<uint8_t, uint8_t> dumpRegisters();
mfiore	0:c62615f15125	856	void eraseFlash();
mfiore	0:c62615f15125	857
Mike Fiore	7:683dba5d576f	858
Mike Fiore	7:683dba5d576f	859	// deprecated - use setWakeInterval
Mike Fiore	7:683dba5d576f	860	int32_t setSerialWakeInterval(const uint32_t& interval);
Mike Fiore	7:683dba5d576f	861	// deprecated - use getWakeInterval
Mike Fiore	7:683dba5d576f	862	uint32_t getSerialWakeInterval();
Mike Fiore	6:390fc83d588d	863
Mike Fiore	7:683dba5d576f	864	// deprecated - use setWakeDelay
Mike Fiore	7:683dba5d576f	865	int32_t setSerialWakeDelay(const uint32_t& delay);
Mike Fiore	7:683dba5d576f	866	// deprecated - use setWakeDelay
Mike Fiore	7:683dba5d576f	867	uint32_t getSerialWakeDelay();
Mike Fiore	7:683dba5d576f	868
Mike Fiore	7:683dba5d576f	869	// deprecated - use setWakeTimeout
Mike Fiore	7:683dba5d576f	870	int32_t setSerialReceiveTimeout(const uint16_t& timeout);
Mike Fiore	7:683dba5d576f	871	// deprecated - use getWakeTimeout
Mike Fiore	7:683dba5d576f	872	uint16_t getSerialReceiveTimeout();
mfiore	0:c62615f15125	873
mfiore	0:c62615f15125	874	private:
mfiore	0:c62615f15125	875	mdot_stats _stats;
mfiore	0:c62615f15125	876
mfiore	0:c62615f15125	877	};
mfiore	0:c62615f15125	878
mfiore	0:c62615f15125	879	#endif