ExpressLinkConfig Class Reference

#include <ExpressLink.h>

Public Member Functions
	ExpressLinkConfig (ExpressLink &el)
bool	get (String key)
bool	set (String key, String value)
String	getAbout ()
	equivalent to: AT+CONF? About More...
String	getVersion ()
	equivalent to: AT+CONF? Version More...
String	getTechSpec ()
	equivalent to: AT+CONF? TechSpec More...
String	getThingName ()
	equivalent to: AT+CONF? ThingName More...
String	getCertificate ()
	equivalent to: AT+CONF? Certificate pem More...
String	getCustomName ()
	equivalent to: AT+CONF? CustomName More...
bool	setCustomName (const String &value)
	equivalent to: AT+CONF CustomName={value} More...
String	getEndpoint ()
	equivalent to: AT+CONF? Endpoint More...
bool	setEndpoint (const String &value)
	equivalent to: AT+CONF Endpoin={value} More...
String	getRootCA ()
	equivalent to: AT+CONF? Endpoint pem More...
bool	setRootCA (const String &value)
	equivalent to: AT+CONF RootCA={value} More...
String	getShadowToken ()
	equivalent to: AT+CONF? ShadowToken More...
bool	setShadowToken (const String &value)
uint32_t	getDefenderPeriod ()
	equivalent to: AT+CONF? DefenderPeriod More...
bool	setDefenderPeriod (const uint32_t value)
String	getHOTAcertificate ()
	equivalent to: AT+CONF? HOTAcertificate pem More...
bool	setHOTAcertificate (const String &value)
String	getOTAcertificate ()
	equivalent to: AT+CONF? OTAcertificate pem More...
bool	setOTAcertificate (const String &value)
String	getSSID ()
	equivalent to: AT+CONF? SSID More...
bool	setSSID (const String &value)
	equivalent to: AT+CONF SSID={value} More...
bool	setPassphrase (const String &value)
	equivalent to: AT+CONF Passphrase={value} More...
String	getAPN ()
	equivalent to: AT+CONF? APN More...
bool	setAPN (const String &value)
String	getTopic (uint8_t index)
bool	setTopic (uint8_t index, String topic)
String	getShadow (uint8_t index)
bool	setShadow (uint8_t index, String topic)

Constructor & Destructor Documentation

ExpressLinkConfig()

ExpressLinkConfig::ExpressLinkConfig

(

ExpressLink &

el

)

Member Function Documentation

get()

bool ExpressLinkConfig::get

(

String

key

)

getAbout()

String ExpressLinkConfig::getAbout

(

)

equivalent to: AT+CONF? About

Returns

value from the configuration dictionary

getAPN()

String ExpressLinkConfig::getAPN

(

)

equivalent to: AT+CONF? APN

Returns

value from the configuration dictionary

getCertificate()

String ExpressLinkConfig::getCertificate

(

)

equivalent to: AT+CONF? Certificate pem

Returns

value from the configuration dictionary

getCustomName()

String ExpressLinkConfig::getCustomName

(

)

equivalent to: AT+CONF? CustomName

Returns

value from the configuration dictionary

getDefenderPeriod()

uint32_t ExpressLinkConfig::getDefenderPeriod

(

)

equivalent to: AT+CONF? DefenderPeriod

Returns

value from the configuration dictionary

getEndpoint()

String ExpressLinkConfig::getEndpoint

(

)

equivalent to: AT+CONF? Endpoint

Returns

value from the configuration dictionary

getHOTAcertificate()

String ExpressLinkConfig::getHOTAcertificate

(

)

equivalent to: AT+CONF? HOTAcertificate pem

Returns

value from the configuration dictionary as multi-line PEM-formatted string

getOTAcertificate()

String ExpressLinkConfig::getOTAcertificate

(

)

equivalent to: AT+CONF? OTAcertificate pem

Returns

value from the configuration dictionary as multi-line PEM-formatted string

getRootCA()

String ExpressLinkConfig::getRootCA

(

)

equivalent to: AT+CONF? Endpoint pem

Returns

value from the configuration dictionary as multi-line PEM-formatted string

getShadow()

String ExpressLinkConfig::getShadow

(

uint8_t

index

)

getShadowToken()

String ExpressLinkConfig::getShadowToken

(

)

equivalent to: AT+CONF? ShadowToken

Returns

value from the configuration dictionary

getSSID()

String ExpressLinkConfig::getSSID

(

)

equivalent to: AT+CONF? SSID

Returns

value from the configuration dictionary

getTechSpec()

String ExpressLinkConfig::getTechSpec

(

)

equivalent to: AT+CONF? TechSpec

Returns

value from the configuration dictionary

getThingName()

String ExpressLinkConfig::getThingName

(

)

equivalent to: AT+CONF? ThingName

Returns

value from the configuration dictionary

getTopic()

String ExpressLinkConfig::getTopic

(

uint8_t

index

)

getVersion()

String ExpressLinkConfig::getVersion

(

)

equivalent to: AT+CONF? Version

Returns

value from the configuration dictionary

set()

bool ExpressLinkConfig::set	(	String	key,
		String	value
	)

setAPN()

bool ExpressLinkConfig::setAPN

(

const String &

value

)

setCustomName()

bool ExpressLinkConfig::setCustomName

(

const String &

value

)

equivalent to: AT+CONF CustomName={value}

Parameters

value

to be written to configuration dictionary

Returns

true on success, false on error

setDefenderPeriod()

bool ExpressLinkConfig::setDefenderPeriod

(

const uint32_t

value

)

setEndpoint()

bool ExpressLinkConfig::setEndpoint

(

const String &

value

)

equivalent to: AT+CONF Endpoin={value}

Parameters

value

to be written to configuration dictionary

Returns

true on success, false on error

setHOTAcertificate()

bool ExpressLinkConfig::setHOTAcertificate

(

const String &

value

)

setOTAcertificate()

bool ExpressLinkConfig::setOTAcertificate

(

const String &

value

)

setPassphrase()

bool ExpressLinkConfig::setPassphrase

(

const String &

value

)

equivalent to: AT+CONF Passphrase={value}

Parameters

value

to be written to configuration dictionary

Returns

true on success, false on error

setRootCA()

bool ExpressLinkConfig::setRootCA

(

const String &

value

)

equivalent to: AT+CONF RootCA={value}

Parameters

value

to be written to configuration dictionary as multi-line PEM-formatted string

Returns

true on success, false on error

setShadow()

bool ExpressLinkConfig::setShadow	(	uint8_t	index,
		String	topic
	)

setShadowToken()

bool ExpressLinkConfig::setShadowToken

(

const String &

value

)

setSSID()

bool ExpressLinkConfig::setSSID

(

const String &

value

)

equivalent to: AT+CONF SSID={value}

Parameters

value

to be written to configuration dictionary

Returns

true on success, false on error

setTopic()

bool ExpressLinkConfig::setTopic	(	uint8_t	index,
		String	topic
	)

---

The documentation for this class was generated from the following files:

• src/ExpressLink.h
• src/ExpressLink.cpp