mwalbeck/rtl_433
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add mqtt base topic option (closes )

Browse source
This commit is contained in:
Christian W. Zuckschwerdt 2023-12-28 21:17:22 +01:00
parent a863963a70
commit 86a39f2dfb
4 changed files with 13 additions and 5 deletions

3
README.md
View file

@ -430,11 +430,12 @@ E.g. -X "n=doorbell,m=OOK_PWM,s=400,l=800,r=7000,g=1000,match={24}0xa9878c,repea
Add MQTT options with e.g. -F "mqtt://host:1883,opt=arg"
MQTT options are: user=foo, pass=bar, retain[=0|1], <format>[=topic]
Default user and password are read from MQTT_USER and MQTT_PASSWORD env vars.
A base topic can be set with base=<topic>, default is "rtl_433/HOSTNAME".
Supported MQTT formats: (default is all)
events: posts JSON event data
states: posts JSON state data
devices: posts device and sensor info in nested topics
The topic string will expand keys like [/model]
Any topic string overrides the base topic and will expand keys like [/model]
E.g. -F "mqtt://localhost:1883,user=USERNAME,pass=PASSWORD,retain=0,devices=rtl_433[/id]"
With MQTT each rtl_433 instance needs a distinct driver selection. The MQTT Client-ID is computed from the driver string.
If you use multiple RTL-SDR, perhaps set a serial and select by that (helps not to get the wrong antenna).

5
man/man1/rtl_433.1
View file

@ -347,6 +347,9 @@ MQTT options are: user=foo, pass=bar, retain[=0|1], <format>[=topic]
Default user and password are read from MQTT_USER and MQTT_PASSWORD env vars.
.RE
.RS
A base topic can be set with base=<topic>, default is "rtl_433/HOSTNAME".
.RE
.RS
Supported MQTT formats: (default is all)
.RE
.RS
@ -359,7 +362,7 @@ Supported MQTT formats: (default is all)
devices: posts device and sensor info in nested topics
.RE
.RS
The topic string will expand keys like [/model]
Any topic string overrides the base topic and will expand keys like [/model]
.RE
.RS
E.g. \-F "mqtt://localhost:1883,user=USERNAME,pass=PASSWORD,retain=0,devices=rtl_433[/id]"

7
src/output_mqtt.c
View file

@ -505,8 +505,9 @@ struct data_output *data_output_mqtt_create(struct mg_mgr *mgr, char *param, cha
snprintf(client_id, sizeof(client_id), "rtl_433-%04x%04x%04x", host_crc, devq_crc, parm_crc);
// default base topic
char base_topic[8 + sizeof(mqtt->hostname)];
snprintf(base_topic, sizeof(base_topic), "rtl_433/%s", mqtt->hostname);
char default_base_topic[8 + sizeof(mqtt->hostname)];
snprintf(default_base_topic, sizeof(default_base_topic), "rtl_433/%s", mqtt->hostname);
char const *base_topic = default_base_topic;
// default topics
char const *path_devices = "devices[/type][/model][/subtype][/channel][/id]";
@ -545,6 +546,8 @@ struct data_output *data_output_mqtt_create(struct mg_mgr *mgr, char *param, cha
retain = atobv(val, 1);
else if (!strcasecmp(key, "q") || !strcasecmp(key, "qos"))
qos = atoiv(val, 1);
else if (!strcasecmp(key, "b") || !strcasecmp(key, "base"))
base_topic = val;
// Simple key-topic mapping
else if (!strcasecmp(key, "d") || !strcasecmp(key, "devices"))
mqtt->devices = mqtt_topic_default(val, base_topic, path_devices);

3
src/rtl_433.c
View file

@ -282,11 +282,12 @@ static void help_output(void)
"\tAdd MQTT options with e.g. -F \"mqtt://host:1883,opt=arg\"\n"
"\tMQTT options are: user=foo, pass=bar, retain[=0|1], <format>[=topic]\n"
"\tDefault user and password are read from MQTT_USER and MQTT_PASSWORD env vars.\n"
"\tA base topic can be set with base=<topic>, default is \"rtl_433/HOSTNAME\".\n"
"\tSupported MQTT formats: (default is all)\n"
"\t events: posts JSON event data\n"
"\t states: posts JSON state data\n"
"\t devices: posts device and sensor info in nested topics\n"
"\tThe topic string will expand keys like [/model]\n"
"\tAny topic string overrides the base topic and will expand keys like [/model]\n"
"\tE.g. -F \"mqtt://localhost:1883,user=USERNAME,pass=PASSWORD,retain=0,devices=rtl_433[/id]\"\n"
"\tWith MQTT each rtl_433 instance needs a distinct driver selection. The MQTT Client-ID is computed from the driver string.\n"
"\tIf you use multiple RTL-SDR, perhaps set a serial and select by that (helps not to get the wrong antenna).\n"