/*
* Copyright (C) 2015 by Multi-Tech Systems
*
* This file is part of libmts-io.
*
* libmts-io is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* libmts-io is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with libmts-io. If not, see .
*
*/
#ifndef MTS_IO_TELITRADIO_H_
#define MTS_IO_TELITRADIO_H_
#include
#include
#include
#include
#include
#include
#include
#include
namespace MTS {
namespace IO {
class TelitRadio : public CellularRadio {
public:
virtual ~TelitRadio();
virtual bool initialize(uint32_t iTimeoutMillis = 5000);
virtual bool resetRadio(uint32_t iTimeoutMillis = 5000);
virtual bool resetConnection(uint32_t iTimeoutMillis = 5000);
virtual void shutdown();
const std::string& getName() const;
virtual CODE getModel(std::string& sModel);
virtual CODE getFirmware(std::string& sFirmware);
virtual CODE getFirmwareBuild(std::string& sFirmwareBuild);
virtual CODE getHardware(std::string& sHardware);
virtual CODE getManufacturer(std::string& sManufacturer);
virtual CODE getImei(std::string& sImei);
virtual CODE getMeid(std::string& sMeid);
virtual CODE getImsi(std::string& sImsi);
virtual CODE getSimStatus(std::string& sSimStatus);
virtual CODE getIccid(std::string& sIccid);
virtual CODE getService(std::string& sService);
virtual CODE getLac(std::string& sLac);
virtual CODE getMdn(std::string& sMdn);
virtual CODE getMsid(std::string& sMsid);
virtual CODE getType(std::string& sType);
virtual CODE getCarrier(std::string& sCarrier);
virtual CODE getNetwork(std::string& sNetwork);
virtual CODE getTower(std::string& sTower);
virtual CODE getTime(std::string& sDate, std::string& sTime, std::string& sTimeZone);
virtual CODE getRoaming(bool& bRoaming);
virtual CODE getSignalStrength(int32_t& iRssi);
virtual CODE getModemLocation(std::string& sLocation);
virtual CODE convertSignalStrengthTodBm(const int32_t& iRssi, int32_t& dBm);
virtual CODE convertdBmToSignalStrength(const int32_t& dBm, int32_t& iRssi);
virtual CODE getRegistration(REGISTRATION& eRegistration);
virtual CODE convertRegistrationToString(REGISTRATION eRegistration, std::string& sRegistration);
//! Gather details of the radio's Mobile IP Profile
/*!
\param Json::Value object that will be populated with MIP data
\return Returns result code of gathering MIP
*/
virtual CODE getMipProfile(Json::Value& jMipProfile);
/*
* jArgs = {
* "msl" : "Master Subsidy Lock (Aeris, Sprint): STRING"
* }
*/
virtual CODE validateMsl(const Json::Value& jArgs);
/*
* jArgs = {
* "mdn" : "Mobile Directory Number : STRING",
* "msl" : "[OPTIONAL] Master Subsidy Lock (Aeris, Sprint): STRING"
* }
*/
virtual CODE setMdn(const Json::Value& jArgs);
/*
* jArgs = {
* "msid" : "Mobil Station ID (MSID) aka MIN aka MSIN : STRING",
* "msl" : "[OPTIONAL] Master Subsidy Lock (Aeris, Sprint): STRING"
* }
*/
virtual CODE setMsid(const Json::Value& jArgs);
/*
* jArgs = {
* "activeProfile" : "Set active profile: STRING"
* }
*/
virtual CODE setMipActiveProfile(const Json::Value& jArgs);
/*
* jArgs = {
* "nai" : "Network Access Identifier : STRING"
* }
*/
virtual CODE setMipNai(const Json::Value& jArgs);
/*
* jArgs = {
* "homeIp" : "Home Address : STRING"
* }
*/
virtual CODE setMipHomeIp(const Json::Value& jArgs);
/*
* jArgs = {
* "primaryHa" : "Primary Home Agent : STRING"
* }
*/
virtual CODE setMipPrimaryHa(const Json::Value& jArgs);
/*
* jArgs = {
* "secondaryHa" : "Secondary Home Agent : STRING"
* }
*/
virtual CODE setMipSecondaryHa(const Json::Value& jArgs);
/*
* jArgs = {
* "mnAaaSpi" : "Mobile Node Authentication, Authorization, and Accounting Server Security Parameter Index : STRING"
* }
*/
virtual CODE setMipMnAaaSpi(const Json::Value& jArgs);
/*
* jArgs = {
* "mnHaSpi" : "Mobile Node Home Agent Security Server Parameter Index : STRING"
* }
*/
virtual CODE setMipMnHaSpi(const Json::Value& jArgs);
/*
* jArgs = {
* "revTun" : "[DESCRIPTION] : STRING"
* }
*/
virtual CODE setMipRevTun(const Json::Value& jArgs);
/*
* jArgs = {
* "mnAaaSs" : "Mobile Node Authentication, Authorization, and Accounting Server Shared Secret : STRING"
* }
*/
virtual CODE setMipMnAaaSs(const Json::Value& jArgs);
/*
* jArgs = {
* "mnHaSs" : "Mobile Node Home Agent Shared Secret : STRING"
* }
*/
virtual CODE setMipMnHaSs(const Json::Value& jArgs);
/*
* jArgs = null
*/
virtual CODE updateDc(const Json::Value& jArgs, UpdateCb& stepCb);
/*
* jArgs = null
*/
virtual CODE updatePrl(const Json::Value& jArgs, UpdateCb& stepCb);
/*
* jArgs = null
*/
virtual CODE updateFumo(const Json::Value& jArgs, UpdateCb& stepCb);
/*
* jArgs = {
* "msl" : "Master Subsidy Lock (Sprint): STRING"
* }
*/
virtual CODE resetHfa(const Json::Value& jArgs, UpdateCb& stepCb);
/*
* jArgs = {
* "mdn" : "Mobile Directory Number (Aeris): STRING"
* "msid" : "Mobile Station ID (Aeris): STRING"
* }
*/
virtual CODE activate(const Json::Value& jArgs, UpdateCb& stepCb);
/*
* jArgs = {
* "enabled" : "RX Diversity Enabled ("0" or "1"): STRING"
* }
*/
virtual CODE setRxDiversity(const Json::Value& jArgs)=0;
/*
* jArgs = {
* "fwid" : "Firmware Image To Be Enabled: STRING"
* }
*/
virtual CODE setActiveFirmware(const Json::Value& jArgs);
virtual CODE getActiveFirmware(std::string& sFwId);
virtual CODE getEcho(bool& bEnabled);
virtual CODE setEcho(bool bEnabled = true);
virtual CODE getStaticInformation(Json::Value& jData);
virtual CODE getNetworkStatus(Json::Value& jData);
virtual CODE sendBasicCommand(const std::string& sCmd, int32_t timeoutMillis = 100, const char& ESC = CR);
virtual std::string sendCommand(const std::string& sCmd,
const std::vector& vBail = DEFAULT_BAIL_STRINGS,
int32_t timeoutMillis = 100,
const char& ESC = CR);
static std::string sendCommand(MTS::AutoPtr& apIo,
const std::string& sCmd,
const std::vector& vBail = DEFAULT_BAIL_STRINGS,
int32_t timeoutMillis = 100,
const char& ESC = CR);
virtual std::string sendCommand(const std::string& sCmd,
IsNeedMoreData& isNeedMoreData,
int32_t timeoutMillis = 100,
const char& ESC = CR);
static std::string sendCommand(MTS::AutoPtr& apIo,
const std::string& sCmd,
IsNeedMoreData& isNeedMoreData,
int32_t timeoutMillis = 100,
const char& ESC = CR);
static CODE test(MTS::AutoPtr& apIo, uint32_t timeoutSeconds = 30);
static std::string extractModelFromResult(const std::string& sResult);
static std::string getCodeAsString(CODE code);
protected:
TelitRadio(const std::string& sName, const std::string& sRadioPort);
virtual bool getCarrierFromFirmware(const std::string& sFirmware, std::string& sCarrier);
virtual bool getHardwareVersionFromFirmware(const std::string& sFirmware, std::string& sHardware);
virtual void getCommonNetworkStats(Json::Value& jData);
void initMipProfile(Json::Value& jData);
bool splitAndAssign(const std::string& sLine, const std::string& sKey, Json::Value& jParent, const std::string& sJsonKey, Json::ValueType eType = Json::ValueType::stringValue);
private:
class RadioBandMap : public MTS::NonCopyable {
public:
RadioBandMap()
{
m_sChannel = TelitRadio::VALUE_UNKNOWN;
m_iChannel = 0;
m_sRadioType = TelitRadio::VALUE_UNKNOWN;
}
RadioBandMap(const std::string &channel, const std::string &radioType) :
m_sChannel(channel),
m_sRadioType(radioType)
{
m_iChannel = strtol(m_sChannel.c_str(), NULL, 10);
}
virtual ~RadioBandMap() {}
const char *getRadioBandName();
const char *getRadioBandName(const std::string &channel, const std::string &radioType);
private:
const char *getLTEBand(const int channel);
const char *getCDMABand(const int channel);
const char *getGSMBand(const int channel);
std::string m_sChannel;
int m_iChannel;
std::string m_sRadioType;
};
std::string m_sName;
std::string m_sRadioPort;
std::string m_sFirmware;
std::string m_sCarrier;
MTS::AutoPtr m_apIo;
bool m_bEchoEnabled;
bool m_bEnableEchoOnClose;
std::string queryLteLac();
std::string queryCGREGstring();
void setCGREG(std::string value);
};
}
}
#endif