WiConnect | Mbed

ACKme » Code » Documentation

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

Embed: (wiki syntax)

« Back to documentation index

GhmInterface Class Reference

The provides an interface for http://goHACK.me. More...

#include <GhmInterface.h>

Inherited by Wiconnect.

Public Member Functions
WiconnectResult	ghmDownloadCapabilities (const char *capsNameOrCustomUrl=NULL, uint32_t version=0)
	Download a device capabilities file to WiFi module's internal file system.
WiconnectResult	ghmActivate (const char userName, const char password, const char *capsFilename=NULL)
	Activate WiFi module with http://goHACK.me.
WiconnectResult	ghmDeactivate (const char userName, const char password)
	Deactivate WiFi module with http://goHACK.me.
WiconnectResult	ghmIsActivated (bool *statusPtr)
	Return if WiFi module is activated with http://goHACK.me.
WiconnectResult	ghmRead (const char controlName, const char *valueStrPtr)
	Read control data from http://goHACK.me.
WiconnectResult	ghmRead (const char controlName, uint32_t valueIntPtr)
	Read control data from http://goHACK.me.
WiconnectResult	ghmRead (const char controlName, char valueBuffer, uint16_t valueBufferLen)
	Read control data from http://goHACK.me.
WiconnectResult	ghmWrite (const char elementName, const char strValue)
	Write stream or control data to http://goHACK.me.
WiconnectResult	ghmWrite (const char *elementName, uint32_t uintValue)
	Write stream or control data to http://goHACK.me.
WiconnectResult	ghmWrite (const char *elementName, int32_t intValue)
	Write stream or control data to http://goHACK.me.
WiconnectResult	ghmWrite (const GhmElementArray *elementArray)
	Write stream or control data to http://goHACK.me.
WiconnectResult	ghmSynchronize (GhmSyncType type=GHM_SYNC_ALL)
	Synchronize WiFi module with http://goHACK.me.
WiconnectResult	ghmPostMessage (WiconnectSocket &socket, bool jsonFormatted=false)
	POST message to http://goHACK.me.
WiconnectResult	ghmGetMessage (WiconnectSocket &socket, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)
	GET message from http://goHACK.me.
WiconnectResult	ghmGetMessage (WiconnectSocket &socket, uint8_t listIndex, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)
	GET message from http://goHACK.me.
WiconnectResult	ghmGetMessage (WiconnectSocket &socket, const char *msgId, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)
	GET message from http://goHACK.me.
WiconnectResult	ghmDeleteMessage (uint8_t listIndex)
	Delete message from http://goHACK.me.
WiconnectResult	ghmDeleteMessage (const char *msgId)
	Delete message from http://goHACK.me.
WiconnectResult	ghmListMessages (GhmMessageList &msgList, uint8_t maxCount=0)
	List available messages for device on http://goHACK.me.

Detailed Description

The provides an interface for http://goHACK.me.

The goHACK.me API provided by WiConnect enables monitoring and control of your ACKme device. You can set up a goHACK.me account, then using goHACK.me commands and goHACK.me variables, you can activate your device and synchronize data, control and messages with the goHACK.me cloud service.

More information here: http://wiconnect.ack.me/2.0/gohackme