ACKme / WiConnect

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

Read/Write
Functions

Read/Write
[goHACK.me]

Methods for reading & writing data from/to http://goHACK.me. More...

Functions

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.

Detailed Description

Methods for reading & writing data from/to http://goHACK.me.

Function Documentation

WiconnectResult ghmRead ( const char *  controlName,
const char **  valueStrPtr 
) [inherited]

Read control data from http://goHACK.me.

Note:
The WiFi module must first be activated. See ghmActivate()
Parameters:
[in]controlNameThe name of the control in the activated capabilities file.
[in]valueStrPtrPointer to pointer to hold control's string value
Returns:
Result of method. See WiconnectResult
WiconnectResult ghmRead ( const char *  controlName,
uint32_t *  valueIntPtr 
) [inherited]

Read control data from http://goHACK.me.

Note:
The WiFi module must first be activated. See ghmActivate()
Parameters:
[in]controlNameThe name of the control in the activated capabilities file.
[in]valueIntPtrPointer hold control's integer value
Returns:
Result of method. See WiconnectResult
WiconnectResult ghmRead ( const char *  controlName,
char *  valueBuffer,
uint16_t  valueBufferLen 
) [inherited]

Read control data from http://goHACK.me.

Note:
The WiFi module must first be activated. See ghmActivate()
Parameters:
[in]controlNameThe name of the control in the activated capabilities file.
[in]valueBufferBuffer to hold control's string value
[in]valueBufferLenLength of valueBuffer
Returns:
Result of method. See WiconnectResult
WiconnectResult ghmSynchronize ( GhmSyncType  type = GHM_SYNC_ALL ) [inherited]

Synchronize WiFi module with http://goHACK.me.

Note:
The WiFi module must first be activated. See ghmActivate()
Parameters:
[in]typeType of synchronization. See GhmSyncType
Returns:
Result of method. See WiconnectResult
WiconnectResult ghmWrite ( const char *  elementName,
uint32_t  uintValue 
) [inherited]

Write stream or control data to http://goHACK.me.

Note:
The WiFi module must first be activated. See ghmActivate()
Parameters:
[in]elementNameThe name of the control or stream in the activated capabilities file.
[in]uintValueUnsigned integer value of control or stream
Returns:
Result of method. See WiconnectResult
WiconnectResult ghmWrite ( const char *  elementName,
const char *  strValue 
) [inherited]

Write stream or control data to http://goHACK.me.

Note:
The WiFi module must first be activated. See ghmActivate()
Parameters:
[in]elementNameThe name of the control or stream in the activated capabilities file.
[in]strValueString value of control or stream
Returns:
Result of method. See WiconnectResult
WiconnectResult ghmWrite ( const GhmElementArray *  elementArray ) [inherited]

Write stream or control data to http://goHACK.me.

Note:
The WiFi module must first be activated. See ghmActivate()
Parameters:
[in]elementArrayArray of stream and/or control values to send to http://goHACK.me
Returns:
Result of method. See WiconnectResult
WiconnectResult ghmWrite ( const char *  elementName,
int32_t  intValue 
) [inherited]

Write stream or control data to http://goHACK.me.

Note:
The WiFi module must first be activated. See ghmActivate()
Parameters:
[in]elementNameThe name of the control or stream in the activated capabilities file.
[in]intValuesigned integer value of control or stream
Returns:
Result of method. See WiconnectResult
Generated on Tue Jul 12 2022 17:35:59 by  doxygen 1.7.2