MultiTech / Mbed OS Dot-AT-Firmware

AT command firmware for MultiTech Dot devices.

Fork of mDot_AT_firmware by MultiTech

Dot Library Not Included!

Because these example programs can be used for both mDot and xDot devices, the LoRa stack is not included. The libmDot library should be imported if building for mDot devices. The libxDot library should be imported if building for xDot devices. The AT firmware was last tested with mbed-os-5.4.7. Using a version past mbed-os-5.4.7 will cause the build to fail. The library used with the AT firmware has to match the mbed-os version.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. The Dot-Examples and Dot-AT-Firmware do this by defining a macro called "CHANNEL_PLAN" that controls the channel plan that will be used in the examples. Available channel plans will be in the Dot Library repository in the plans folder.

Revision 20 and earlier of Dot-Examples and revision 15 and earlier of Dot-AT-Firmware should be used with Dot Library versions prior to 3.0.0.

Fota Library

Th Fota Library must be added to compile for mDot 3.1.0 with Fota support. Latest dev libraries and 3.2.0 release will include Fota with libmDot/libxDot.

AT Firmware Description

This AT Firmware is what ships on mDot and xDot devices. It provides an AT command interface for using the mDot or xDot for LoRa communication.

AT command documentation can be found on Multitech.com.

The firmware changelog can be found here. The library changelog can be found here.

Dot Libraries

Dot Library Limitations

The commit messages in libmDot-mbed5 and libmDot-dev-mbed5 specify the version of the Dot library the commit contains and the version of mbed-os it was compiled against. We recommend building your application with the version of mbed-os specified in the commit message of the version of the Dot library you're using. This will ensure that you don't run into any runtime issues caused by differences in the mbed-os versions.

Stable and development libraries are available for both mDot and xDot platforms. The library chosen must match the target platform. Compiling for the mDot platform with the xDot library or vice versa will not succeed.

mDot Library

Development library for mDot.

libmDot-dev

Stable library for mDot.

libmDot

xDot Library

Development library for xDot.

libxDot-dev

Stable library for xDot.

libxDot

CommandTerminal/CommandTerminal.h@4:666017851052, 2015-08-18 (annotated)

Committer:
Mike Fiore
Date:
Tue Aug 18 11:21:43 2015 -0500
Revision:
4:666017851052
Parent:
1:e52ae6584f1c
Child:
9:ff62b20f7000
update mdot-firmware to 0.1.2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 /**
Mike Fiore 1:e52ae6584f1c 2 ******************************************************************************
Mike Fiore 1:e52ae6584f1c 3 * File Name : command.h
Mike Fiore 1:e52ae6584f1c 4 * Date : 18/04/2014 10:57:12
Mike Fiore 1:e52ae6584f1c 5 * Description : This file provides code for command line prompt
Mike Fiore 1:e52ae6584f1c 6 ******************************************************************************
Mike Fiore 1:e52ae6584f1c 7 *
Mike Fiore 1:e52ae6584f1c 8 * COPYRIGHT(c) 2014 MultiTech Systems, Inc.
Mike Fiore 1:e52ae6584f1c 9 *
Mike Fiore 1:e52ae6584f1c 10 * Redistribution and use in source and binary forms, with or without modification,
Mike Fiore 1:e52ae6584f1c 11 * are permitted provided that the following conditions are met:
Mike Fiore 1:e52ae6584f1c 12 * 1. Redistributions of source code must retain the above copyright notice,
Mike Fiore 1:e52ae6584f1c 13 * this list of conditions and the following disclaimer.
Mike Fiore 1:e52ae6584f1c 14 * 2. Redistributions in binary form must reproduce the above copyright notice,
Mike Fiore 1:e52ae6584f1c 15 * this list of conditions and the following disclaimer in the documentation
Mike Fiore 1:e52ae6584f1c 16 * and/or other materials provided with the distribution.
Mike Fiore 1:e52ae6584f1c 17 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Mike Fiore 1:e52ae6584f1c 18 * may be used to endorse or promote products derived from this software
Mike Fiore 1:e52ae6584f1c 19 * without specific prior written permission.
Mike Fiore 1:e52ae6584f1c 20 *
Mike Fiore 1:e52ae6584f1c 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Mike Fiore 1:e52ae6584f1c 22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Mike Fiore 1:e52ae6584f1c 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Mike Fiore 1:e52ae6584f1c 24 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Mike Fiore 1:e52ae6584f1c 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Mike Fiore 1:e52ae6584f1c 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Mike Fiore 1:e52ae6584f1c 27 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Mike Fiore 1:e52ae6584f1c 28 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Mike Fiore 1:e52ae6584f1c 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Mike Fiore 1:e52ae6584f1c 30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Mike Fiore 1:e52ae6584f1c 31 *
Mike Fiore 1:e52ae6584f1c 32 ******************************************************************************
Mike Fiore 1:e52ae6584f1c 33 */
Mike Fiore 1:e52ae6584f1c 34
Mike Fiore 1:e52ae6584f1c 35 #include "mbed.h"
Mike Fiore 1:e52ae6584f1c 36 #include "MTSSerial.h"
Mike Fiore 1:e52ae6584f1c 37 #include "Commands.h"
Mike Fiore 1:e52ae6584f1c 38 #include "mDot.h"
Mike Fiore 1:e52ae6584f1c 39
Mike Fiore 1:e52ae6584f1c 40 /* Define to prevent recursive inclusion -------------------------------------*/
Mike Fiore 1:e52ae6584f1c 41 #ifndef __command_terminal_H__
Mike Fiore 1:e52ae6584f1c 42 #define __command_terminal_H__
Mike Fiore 1:e52ae6584f1c 43
Mike Fiore 1:e52ae6584f1c 44 class CommandTerminal {
Mike Fiore 1:e52ae6584f1c 45
Mike Fiore 1:e52ae6584f1c 46 public:
Mike Fiore 1:e52ae6584f1c 47
Mike Fiore 1:e52ae6584f1c 48 enum WaitType {
Mike Fiore 1:e52ae6584f1c 49 WAIT_JOIN,
Mike Fiore 1:e52ae6584f1c 50 WAIT_RECV,
Mike Fiore 1:e52ae6584f1c 51 WAIT_LINK,
Mike Fiore 1:e52ae6584f1c 52 WAIT_SEND,
Mike Fiore 1:e52ae6584f1c 53 WAIT_NA
Mike Fiore 1:e52ae6584f1c 54 };
Mike Fiore 1:e52ae6584f1c 55
Mike Fiore 1:e52ae6584f1c 56 CommandTerminal(mts::MTSSerial& serial, mDot* dot);
Mike Fiore 1:e52ae6584f1c 57
Mike Fiore 1:e52ae6584f1c 58 // Command prompt text...
Mike Fiore 1:e52ae6584f1c 59 static const char banner[];
Mike Fiore 1:e52ae6584f1c 60 static const char helpline[];
Mike Fiore 1:e52ae6584f1c 61 static const char prompt[];
Mike Fiore 1:e52ae6584f1c 62
Mike Fiore 1:e52ae6584f1c 63 // Command error text...
Mike Fiore 1:e52ae6584f1c 64 static const char command_error[];
Mike Fiore 1:e52ae6584f1c 65
Mike Fiore 1:e52ae6584f1c 66 // Response texts...
Mike Fiore 1:e52ae6584f1c 67 static const char help[];
Mike Fiore 1:e52ae6584f1c 68 static const char cmd_error[];
Mike Fiore 1:e52ae6584f1c 69 static const char newline[];
Mike Fiore 1:e52ae6584f1c 70 static const char done[];
Mike Fiore 1:e52ae6584f1c 71 static const char error[];
Mike Fiore 1:e52ae6584f1c 72
Mike Fiore 1:e52ae6584f1c 73 // Escape sequence
Mike Fiore 1:e52ae6584f1c 74 static const char escape_sequence[];
Mike Fiore 1:e52ae6584f1c 75
Mike Fiore 1:e52ae6584f1c 76 static std::string formatPacketData(const std::vector<uint8_t>& data, const uint8_t& format);
Mike Fiore 1:e52ae6584f1c 77 static bool waitForEscape(int timeout, mDot* dot=NULL, WaitType wait=WAIT_NA);
Mike Fiore 1:e52ae6584f1c 78
Mike Fiore 1:e52ae6584f1c 79 void start();
Mike Fiore 1:e52ae6584f1c 80
Mike Fiore 1:e52ae6584f1c 81 private:
Mike Fiore 1:e52ae6584f1c 82
Mike Fiore 4:666017851052 83 static void idle(void const* args) {
Mike Fiore 4:666017851052 84 while (1)
Mike Fiore 4:666017851052 85 __WFI();
Mike Fiore 4:666017851052 86 }
Mike Fiore 4:666017851052 87
Mike Fiore 1:e52ae6584f1c 88 mts::MTSSerial& _serial;
Mike Fiore 1:e52ae6584f1c 89 static mts::MTSSerial* _serialp;
Mike Fiore 1:e52ae6584f1c 90
Mike Fiore 1:e52ae6584f1c 91 mDot* _dot;
Mike Fiore 1:e52ae6584f1c 92 mDot::Mode _mode;
Mike Fiore 1:e52ae6584f1c 93 std::vector<Command*> _commands;
Mike Fiore 4:666017851052 94 Thread _idle_thread;
Mike Fiore 1:e52ae6584f1c 95 bool _sleep_standby;
Mike Fiore 1:e52ae6584f1c 96 DigitalOut _xbee_on_sleep;
Mike Fiore 1:e52ae6584f1c 97 bool _serial_up;
Mike Fiore 1:e52ae6584f1c 98
Mike Fiore 1:e52ae6584f1c 99 void addCommand(Command* cmd);
Mike Fiore 1:e52ae6584f1c 100
Mike Fiore 1:e52ae6584f1c 101 void serial_loop();
Mike Fiore 1:e52ae6584f1c 102 bool autoJoinCheck();
Mike Fiore 1:e52ae6584f1c 103
Mike Fiore 1:e52ae6584f1c 104 void printHelp();
Mike Fiore 1:e52ae6584f1c 105
Mike Fiore 1:e52ae6584f1c 106 bool readable();
Mike Fiore 1:e52ae6584f1c 107 bool writeable();
Mike Fiore 1:e52ae6584f1c 108 char read();
Mike Fiore 1:e52ae6584f1c 109 void write(const char* message);
Mike Fiore 1:e52ae6584f1c 110 void writef(const char* format, ... );
Mike Fiore 1:e52ae6584f1c 111
Mike Fiore 1:e52ae6584f1c 112 void sleep(bool standby);
Mike Fiore 1:e52ae6584f1c 113 void wakeup(bool standby);
Mike Fiore 1:e52ae6584f1c 114
Mike Fiore 1:e52ae6584f1c 115 };
Mike Fiore 1:e52ae6584f1c 116
Mike Fiore 1:e52ae6584f1c 117 #endif // __command_terminal_H__
Mike Fiore 1:e52ae6584f1c 118