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
Methods for getting, posting, listing, deleting messages wtih http://goHACK.me. More...
Functions | |
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
Methods for getting, posting, listing, deleting messages wtih http://goHACK.me.
Function Documentation
WiconnectResult ghmDeleteMessage | ( | uint8_t | listIndex ) | [inherited] |
Delete message from http://goHACK.me.
- Note:
- ghmListMessages() must be called first before using this method.
- The WiFi module must first be activated. See ghmActivate()
- Parameters:
-
[in] listIndex The index of the message returned from ghmListMessages()
- Returns:
- Result of method. See WiconnectResult
WiconnectResult ghmDeleteMessage | ( | const char * | msgId ) | [inherited] |
Delete message from http://goHACK.me.
- Note:
- The WiFi module must first be activated. See ghmActivate()
- Parameters:
-
[in] msgId The http://goHACK.me message ID.
- Returns:
- Result of method. See WiconnectResult
WiconnectResult ghmGetMessage | ( | WiconnectSocket & | socket, |
GhmMessageGetType | getType = GHM_MSG_GET_DATA_ONLY |
||
) | [inherited] |
GET message from http://goHACK.me.
- Note:
- The WiFi module must first be activated. See ghmActivate()
- Parameters:
-
[out] socket WiconnectSocket used to receive message data from http://goHACK.me [in] getType The additional message data to receive. See GhmMessageGetType
- Returns:
- Result of method. See WiconnectResult
WiconnectResult ghmGetMessage | ( | WiconnectSocket & | socket, |
const char * | msgId, | ||
GhmMessageGetType | getType = GHM_MSG_GET_DATA_ONLY |
||
) | [inherited] |
GET message from http://goHACK.me.
- Note:
- The WiFi module must first be activated. See ghmActivate()
- Parameters:
-
[out] socket WiconnectSocket used to receive message data from http://goHACK.me [in] msgId The http://goHACK.me message ID. [in] getType The additional message data to receive. See GhmMessageGetType
- Returns:
- Result of method. See WiconnectResult
WiconnectResult ghmGetMessage | ( | WiconnectSocket & | socket, |
uint8_t | listIndex, | ||
GhmMessageGetType | getType = GHM_MSG_GET_DATA_ONLY |
||
) | [inherited] |
GET message from http://goHACK.me.
- Note:
- ghmListMessages() must be called first before using this method.
- The WiFi module must first be activated. See ghmActivate()
- Parameters:
-
[out] socket WiconnectSocket used to receive message data from http://goHACK.me [in] listIndex The index of the message returned from ghmListMessages() [in] getType The additional message data to receive. See GhmMessageGetType
- Returns:
- Result of method. See WiconnectResult
WiconnectResult ghmListMessages | ( | GhmMessageList & | msgList, |
uint8_t | maxCount = 0 |
||
) | [inherited] |
List available messages for device on http://goHACK.me.
- Note:
- The WiFi module must first be activated. See ghmActivate()
- Parameters:
-
[out] msgList GhmMessageList to hold received messages. [in] maxCount Optional, the maximum number of messages to receive. If 0, receive all messages (max of 25).
- Returns:
- Result of method. See WiconnectResult
WiconnectResult ghmPostMessage | ( | WiconnectSocket & | socket, |
bool | jsonFormatted = false |
||
) | [inherited] |
POST message to http://goHACK.me.
- Note:
- The WiFi module must first be activated. See ghmActivate()
- Parameters:
-
[out] socket WiconnectSocket used to send message data to http://goHACK.me [in] jsonFormatted If true, the input message data should be JSON formatted, else the message data should be ASCII formatted.
- Returns:
- Result of method. See WiconnectResult
Generated on Tue Jul 12 2022 17:35:59 by 1.7.2