wn/pubsubc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

api docs

Browse Source
This commit is contained in:
Wolfgang Hottgenroth 2020-11-13 14:52:25 +01:00
parent dab7dd22a5
commit f27e286e57
Signed by: wn
GPG Key ID: 6C1E5E531E0D5D7F
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -26,6 +26,8 @@ all blame for bugs in the C port shall go to me.
The library provides the following functions:
### Initialization
void mqttClientInit(mqttClient_t *mqttClient, client_t *client, callback_t callback);
Initializes the MQTT client, handover a client handle according to the definition
@ -35,8 +37,7 @@ Implement this callback function for incoming messages with this footprint:
typedef void (*callback_t)(char*, uint8_t*, uint16_t);
### Connect
bool mqttConnect(mqttClient_t *mqttClient,
uint8_t *address, uint16_t port,
@ -47,21 +48,33 @@ Implement this callback function for incoming messages with this footprint:
bool cleanSession);
### Disconnect
void mqttDisconnect(mqttClient_t *mqttClient);
### Publish
bool publish(mqttClient_t *mqttClient,
const char *topic,
const uint8_t *payload, uint16_t plength,
bool retained);
### Subscribe and Unsubscribe
bool subscribe(mqttClient_t *mqttClient,
const char *topic, uint8_t qos);
bool unsubscribe(mqttClient_t *mqttClient,
const char* topic);
### Loop
bool mqttLoop(mqttClient_t *mqttClient);
Call this function in your idle loop. For my own part, I've implemented a time-triggered system
and call it with a period of 100ms.
### Connection status
bool mqttConnected(mqttClient_t *mqttClient);