Custom Channel Plan version of MTDOT Box firmware
Dependencies: DOGS102 GpsParser ISL29011 MMA845x MPL3115A2 MTS-Serial NCP5623B libmDot-Custom mDot_Channel_Plans
Fork of MTDOT-BOX-EVB-Factory-Firmware by
CommandTerminal/Command.h@13:0e9c1b42621b, 2017-03-06 (annotated)
- Committer:
- jreiss
- Date:
- Mon Mar 06 13:52:26 2017 +0000
- Revision:
- 13:0e9c1b42621b
- Parent:
- 1:71125aa00e33
Update libmDot, Channel Plans and mbed-os to 5.3.3
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Mike Fiore |
1:71125aa00e33 | 1 | /* Copyright (c) <2016> <MultiTech Systems>, MIT License |
Mike Fiore |
1:71125aa00e33 | 2 | * |
Mike Fiore |
1:71125aa00e33 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
Mike Fiore |
1:71125aa00e33 | 4 | * and associated documentation files (the "Software"), to deal in the Software without restriction, |
Mike Fiore |
1:71125aa00e33 | 5 | * including without limitation the rights to use, copy, modify, merge, publish, distribute, |
Mike Fiore |
1:71125aa00e33 | 6 | * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is |
Mike Fiore |
1:71125aa00e33 | 7 | * furnished to do so, subject to the following conditions: |
Mike Fiore |
1:71125aa00e33 | 8 | * |
Mike Fiore |
1:71125aa00e33 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
Mike Fiore |
1:71125aa00e33 | 10 | * substantial portions of the Software. |
Mike Fiore |
1:71125aa00e33 | 11 | * |
Mike Fiore |
1:71125aa00e33 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
Mike Fiore |
1:71125aa00e33 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
Mike Fiore |
1:71125aa00e33 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
Mike Fiore |
1:71125aa00e33 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
Mike Fiore |
1:71125aa00e33 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
Mike Fiore |
1:71125aa00e33 | 17 | */ |
Mike Fiore |
1:71125aa00e33 | 18 | |
Mike Fiore |
1:71125aa00e33 | 19 | /** |
Mike Fiore |
1:71125aa00e33 | 20 | ****************************************************************************** |
Mike Fiore |
1:71125aa00e33 | 21 | * File Name : Command.h |
Mike Fiore |
1:71125aa00e33 | 22 | * Date : 18/04/2014 10:57:12 |
Mike Fiore |
1:71125aa00e33 | 23 | * Description : This file provides code for command line prompt |
Mike Fiore |
1:71125aa00e33 | 24 | ****************************************************************************** |
Mike Fiore |
1:71125aa00e33 | 25 | * |
Mike Fiore |
1:71125aa00e33 | 26 | * COPYRIGHT(c) 2014 MultiTech Systems, Inc. |
Mike Fiore |
1:71125aa00e33 | 27 | * |
Mike Fiore |
1:71125aa00e33 | 28 | * Redistribution and use in source and binary forms, with or without modification, |
Mike Fiore |
1:71125aa00e33 | 29 | * are permitted provided that the following conditions are met: |
Mike Fiore |
1:71125aa00e33 | 30 | * 1. Redistributions of source code must retain the above copyright notice, |
Mike Fiore |
1:71125aa00e33 | 31 | * this list of conditions and the following disclaimer. |
Mike Fiore |
1:71125aa00e33 | 32 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
Mike Fiore |
1:71125aa00e33 | 33 | * this list of conditions and the following disclaimer in the documentation |
Mike Fiore |
1:71125aa00e33 | 34 | * and/or other materials provided with the distribution. |
Mike Fiore |
1:71125aa00e33 | 35 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
Mike Fiore |
1:71125aa00e33 | 36 | * may be used to endorse or promote products derived from this software |
Mike Fiore |
1:71125aa00e33 | 37 | * without specific prior written permission. |
Mike Fiore |
1:71125aa00e33 | 38 | * |
Mike Fiore |
1:71125aa00e33 | 39 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
Mike Fiore |
1:71125aa00e33 | 40 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
Mike Fiore |
1:71125aa00e33 | 41 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
Mike Fiore |
1:71125aa00e33 | 42 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
Mike Fiore |
1:71125aa00e33 | 43 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
Mike Fiore |
1:71125aa00e33 | 44 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
Mike Fiore |
1:71125aa00e33 | 45 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
Mike Fiore |
1:71125aa00e33 | 46 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
Mike Fiore |
1:71125aa00e33 | 47 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
Mike Fiore |
1:71125aa00e33 | 48 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Mike Fiore |
1:71125aa00e33 | 49 | * |
Mike Fiore |
1:71125aa00e33 | 50 | ****************************************************************************** |
Mike Fiore |
1:71125aa00e33 | 51 | */ |
Mike Fiore |
1:71125aa00e33 | 52 | |
Mike Fiore |
1:71125aa00e33 | 53 | #include "mbed.h" |
Mike Fiore |
1:71125aa00e33 | 54 | #include "mDot.h" |
Mike Fiore |
1:71125aa00e33 | 55 | #include "MTSSerial.h" |
Mike Fiore |
1:71125aa00e33 | 56 | #include "MTSText.h" |
Mike Fiore |
1:71125aa00e33 | 57 | #include <cstdlib> |
Mike Fiore |
1:71125aa00e33 | 58 | #include <string> |
Mike Fiore |
1:71125aa00e33 | 59 | #include <vector> |
Mike Fiore |
1:71125aa00e33 | 60 | #include "limits.h" |
Mike Fiore |
1:71125aa00e33 | 61 | |
Mike Fiore |
1:71125aa00e33 | 62 | /* Define to prevent recursive inclusion -------------------------------------*/ |
Mike Fiore |
1:71125aa00e33 | 63 | #ifndef __command_H |
Mike Fiore |
1:71125aa00e33 | 64 | #define __command_H |
Mike Fiore |
1:71125aa00e33 | 65 | |
Mike Fiore |
1:71125aa00e33 | 66 | #define KEY_LENGTH 16 |
Mike Fiore |
1:71125aa00e33 | 67 | #define EUI_LENGTH 8 |
Mike Fiore |
1:71125aa00e33 | 68 | #define PASSPHRASE_LENGTH 128 |
Mike Fiore |
1:71125aa00e33 | 69 | |
Mike Fiore |
1:71125aa00e33 | 70 | class Command { |
Mike Fiore |
1:71125aa00e33 | 71 | |
Mike Fiore |
1:71125aa00e33 | 72 | public: |
Mike Fiore |
1:71125aa00e33 | 73 | |
Mike Fiore |
1:71125aa00e33 | 74 | Command(mDot* dot); |
Mike Fiore |
1:71125aa00e33 | 75 | Command(mDot* dot, const char* name, const char* text, const char* desc); |
Mike Fiore |
1:71125aa00e33 | 76 | virtual ~Command() {}; |
Mike Fiore |
1:71125aa00e33 | 77 | |
Mike Fiore |
1:71125aa00e33 | 78 | const char* name() const { return _name; }; |
Mike Fiore |
1:71125aa00e33 | 79 | const char* text() const { return _text; }; |
Mike Fiore |
1:71125aa00e33 | 80 | const char* desc() const { return _desc; }; |
Mike Fiore |
1:71125aa00e33 | 81 | const char* help() const { return _help.c_str(); }; |
Mike Fiore |
1:71125aa00e33 | 82 | |
Mike Fiore |
1:71125aa00e33 | 83 | virtual uint32_t action(std::vector<std::string> args) = 0; |
Mike Fiore |
1:71125aa00e33 | 84 | virtual bool verify(std::vector<std::string> args); |
Mike Fiore |
1:71125aa00e33 | 85 | const std::string usage() const; |
Mike Fiore |
1:71125aa00e33 | 86 | std::string& errorMessage(); |
Mike Fiore |
1:71125aa00e33 | 87 | const bool queryable(); |
Mike Fiore |
1:71125aa00e33 | 88 | |
Mike Fiore |
1:71125aa00e33 | 89 | static const char newline[]; |
Mike Fiore |
1:71125aa00e33 | 90 | static void readByteArray(const std::string& input, std::vector<uint8_t>& out, size_t len); |
Mike Fiore |
1:71125aa00e33 | 91 | |
Mike Fiore |
1:71125aa00e33 | 92 | static bool isHexString(const std::string& str, size_t bytes); |
Mike Fiore |
1:71125aa00e33 | 93 | static bool isBaudRate(uint32_t baud); |
Mike Fiore |
1:71125aa00e33 | 94 | |
Mike Fiore |
1:71125aa00e33 | 95 | protected: |
Mike Fiore |
1:71125aa00e33 | 96 | |
Mike Fiore |
1:71125aa00e33 | 97 | void setErrorMessage(const char* message); |
Mike Fiore |
1:71125aa00e33 | 98 | void setErrorMessage(const std::string& message); |
Mike Fiore |
1:71125aa00e33 | 99 | std::string _help; |
Mike Fiore |
1:71125aa00e33 | 100 | std::string _usage; |
Mike Fiore |
1:71125aa00e33 | 101 | bool _queryable; |
Mike Fiore |
1:71125aa00e33 | 102 | mDot* _dot; |
Mike Fiore |
1:71125aa00e33 | 103 | |
Mike Fiore |
1:71125aa00e33 | 104 | private: |
Mike Fiore |
1:71125aa00e33 | 105 | |
Mike Fiore |
1:71125aa00e33 | 106 | const char* _name; |
Mike Fiore |
1:71125aa00e33 | 107 | const char* _text; |
Mike Fiore |
1:71125aa00e33 | 108 | const char* _desc; |
Mike Fiore |
1:71125aa00e33 | 109 | std::string _errorMessage; |
Mike Fiore |
1:71125aa00e33 | 110 | |
Mike Fiore |
1:71125aa00e33 | 111 | }; |
Mike Fiore |
1:71125aa00e33 | 112 | |
Mike Fiore |
1:71125aa00e33 | 113 | #endif /*__ command_H */ |
Mike Fiore |
1:71125aa00e33 | 114 | |
Mike Fiore |
1:71125aa00e33 | 115 | /************************ (C) COPYRIGHT MultiTech Systems, Inc *****END OF FILE****/ |