CmdMaximumPower.cpp

00001 /* Copyright (c) <2016> <MultiTech Systems>, MIT License
00002  *
00003  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
00004  * and associated documentation files (the "Software"), to deal in the Software without restriction, 
00005  * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
00006  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is 
00007  * furnished to do so, subject to the following conditions:
00008  *
00009  * The above copyright notice and this permission notice shall be included in all copies or 
00010  * substantial portions of the Software.
00011  *
00012  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING 
00013  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
00014  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
00015  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
00016  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017  */
00018 
00019 #include "CmdMaximumPower.h"
00020 
00021 //SPECIAL NOTE: Maximum power is stored in the LoraConfig WakeMode field. We decided to use 5 LoRaConfig locations,
00022 // that are not used for the DotBox, for the 5 DotBox settings... +minsize, +maxsize, +minpwr, +maxpwr and +data.
00023 CmdMaximumPower::CmdMaximumPower(mDot* dot, mts::MTSSerial& serial) :
00024         Command(dot, "Maximum Power", "AT+MAXPWR", "Set the maximum transmit power for survey sweep mode"), _serial(serial)
00025 {
00026     _help = std::string(text()) + ": " + std::string(desc());
00027     _usage = "(2-20)";
00028     _queryable = true;
00029 }
00030 
00031 uint32_t CmdMaximumPower::action(std::vector<std::string> args)
00032 {
00033     if (args.size() == 1)
00034     {
00035         if (_dot->getVerbose())
00036             _serial.writef("Maximum Power: ");
00037         _serial.writef("%lu\r\n", _dot->getWakeMode());
00038     }
00039     else if (args.size() == 2)
00040     {
00041         int32_t code;
00042         uint32_t power = 0;
00043         sscanf(args[1].c_str(), "%lu", &power);
00044         if ((code = _dot->setWakeMode(power)) != mDot::MDOT_OK)
00045         {
00046             std::string error = mDot::getReturnCodeString(code) + " - " + _dot->getLastError();
00047             setErrorMessage(error);
00048             return 1;
00049         }
00050     }
00051 
00052     return 0;
00053 }
00054 
00055 bool CmdMaximumPower::verify(std::vector<std::string> args)
00056 {
00057     if (args.size() == 1)
00058         return true;
00059 
00060     if (args.size() == 2)
00061     {
00062         uint32_t power = 0;
00063         if (sscanf(args[1].c_str(), "%lu", &power) != 1) {
00064             setErrorMessage("Invalid argument");
00065             return false;
00066         }
00067 
00068         if (power < 2 || power > 20)
00069         {
00070             setErrorMessage("Invalid maximum transmit power for sweep survey mode, expects (2-20)");
00071             return false;
00072         }
00073         if (power < _dot->getWakeTimeout()) //WakeTimeout holds the MinPower setting.
00074         {
00075             setErrorMessage("+MAXPWR cannot be less than +MINPWR. Please decrease +MINPWR first.");
00076             return false;
00077         }
00078 
00079         return true;
00080     }
00081 
00082     setErrorMessage("Invalid arguments");
00083     return false;
00084 }
00085