Compare commits
10 Commits
477f3e2e3f
...
master
Author | SHA1 | Date | |
---|---|---|---|
9e22556d36 | |||
1ac129a027
|
|||
44647d686f | |||
3d52c14d53
|
|||
f27e286e57
|
|||
dab7dd22a5
|
|||
7497aa9921
|
|||
931eddce41
|
|||
796b25b7ad
|
|||
e4d9be0106 |
3
Makefile
3
Makefile
@@ -1,11 +1,10 @@
|
|||||||
# Makefile - A simple client for MQTT in C
|
# Makefile - A simple client for MQTT in C
|
||||||
# Derived from the PubSubClient from Nick O'Leary
|
|
||||||
# Wolfgang Hottgenroth <woho@hottis.de>
|
# Wolfgang Hottgenroth <woho@hottis.de>
|
||||||
# https://home.hottis.de/gitlab/wolutator/pubsubc
|
# https://home.hottis.de/gitlab/wolutator/pubsubc
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
CFLAGS?=-mcpu=cortex-m3 -mthumb -Og -fdata-sections -ffunction-sections -g -gdwarf-2
|
CFLAGS?=-mcpu=cortex-m3 -mthumb -Og -fdata-sections -ffunction-sections -g -gdwarf-2 -Wall -Werror
|
||||||
|
|
||||||
CC=arm-none-eabi-gcc
|
CC=arm-none-eabi-gcc
|
||||||
AR=arm-none-eabi-ar
|
AR=arm-none-eabi-ar
|
||||||
|
80
README.md
80
README.md
@@ -1,5 +1,85 @@
|
|||||||
|
# pubsubc
|
||||||
|
|
||||||
|
This is a minimal MQTT client library in C.
|
||||||
|
|
||||||
|
It comes with an adaption layer for the ioLibrary_Driver for the
|
||||||
|
WizNet chips which can be found here https://github.com/Wiznet/ioLibrary_Driver.
|
||||||
|
|
||||||
|
You find a fork with a Makefile a STMCubeMX generated project here
|
||||||
|
https://home.hottis.de/gitlab/wolutator/ioLibrary_Driver/-/tree/WolfgangsOwnBranch.
|
||||||
|
|
||||||
|
Using this adaption layer you should find it easy to adjust it for
|
||||||
|
other platforms.
|
||||||
|
|
||||||
This work is directly derived from the famous PubSubClient library
|
This work is directly derived from the famous PubSubClient library
|
||||||
of Nick O'Leary, which can be found at https://pubsubclient.knolleary.net/
|
of Nick O'Leary, which can be found at https://pubsubclient.knolleary.net/
|
||||||
|
|
||||||
It is most or less a plain C rewrite.
|
It is most or less a plain C rewrite.
|
||||||
|
|
||||||
|
All honour for this working MQTT client library goes to Nick O'Leary,
|
||||||
|
all blame for bugs in the C port shall go to me.
|
||||||
|
|
||||||
|
|
||||||
|
## API
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
from ``platformAdaption.h`` and a callback function for incoming messages.
|
||||||
|
|
||||||
|
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,
|
||||||
|
const char *id,
|
||||||
|
const char *user, const char *pass,
|
||||||
|
const char *willTopic, uint8_t willQos,
|
||||||
|
bool willRetain, const char *willMessage,
|
||||||
|
bool cleanSession);
|
||||||
|
|
||||||
|
In the original C++ implementation multiple variants of the ``connect``method are available
|
||||||
|
with less and lesser arguments. Unfortunately, in C this is no option. If you don't care
|
||||||
|
about authentication and the whole will stuff you can call it
|
||||||
|
|
||||||
|
mqttConnect(&mqttClient, brokerAddress, brokerPort, clientId, NULL, NULL, NULL, 0, false, NULL, false);
|
||||||
|
|
||||||
|
### 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);
|
||||||
|
|
||||||
|
@@ -46,7 +46,7 @@ void clientStop(client_t *client) {
|
|||||||
|
|
||||||
if (res != SOCK_BUSY) {
|
if (res != SOCK_BUSY) {
|
||||||
close(client->sockNum);
|
close(client->sockNum);
|
||||||
logMsg("clientStop: disconnect returns 0x%02x, invalid response, ignore it", res);
|
logMsg("clientStop: disconnect returns %d, invalid response, ignore it", res);
|
||||||
} else {
|
} else {
|
||||||
bool successfullyClosed = false;
|
bool successfullyClosed = false;
|
||||||
uint32_t startTime = HAL_GetTick();
|
uint32_t startTime = HAL_GetTick();
|
||||||
@@ -72,7 +72,7 @@ int clientRead(client_t *client) {
|
|||||||
int res = -1;
|
int res = -1;
|
||||||
if (clientAvailable(client) >= 1) {
|
if (clientAvailable(client) >= 1) {
|
||||||
uint8_t buf;
|
uint8_t buf;
|
||||||
int32_t res = recv(client->sockNum, &buf, 1);
|
res = recv(client->sockNum, &buf, 1);
|
||||||
if (res == 1) {
|
if (res == 1) {
|
||||||
res = (int) buf;
|
res = (int) buf;
|
||||||
}
|
}
|
||||||
@@ -100,3 +100,5 @@ bool clientConnected(client_t *client) {
|
|||||||
uint32_t millis() {
|
uint32_t millis() {
|
||||||
return HAL_GetTick();
|
return HAL_GetTick();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@@ -22,7 +22,7 @@
|
|||||||
|
|
||||||
// MQTT_MAX_PACKET_SIZE : Maximum packet size. Override with setBufferSize().
|
// MQTT_MAX_PACKET_SIZE : Maximum packet size. Override with setBufferSize().
|
||||||
#ifndef MQTT_MAX_PACKET_SIZE
|
#ifndef MQTT_MAX_PACKET_SIZE
|
||||||
#define MQTT_MAX_PACKET_SIZE 256
|
#define MQTT_MAX_PACKET_SIZE 512
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// MQTT_KEEPALIVE : keepAlive interval in Seconds. Override with setKeepAlive()
|
// MQTT_KEEPALIVE : keepAlive interval in Seconds. Override with setKeepAlive()
|
||||||
|
Reference in New Issue
Block a user