Skip to content

Commit

Permalink
docs: Update readme info
Browse files Browse the repository at this point in the history
  • Loading branch information
zuckschwerdt committed Jan 17, 2025
1 parent d05debc commit 5e8f1d0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -450,14 +450,15 @@ E.g. -X "n=doorbell,m=OOK_PWM,s=400,l=800,r=7000,g=1000,match={24}0xa9878c,repea
Without this option the default is LOG and KV output. Use "-F null" to remove the default.
Append output to file with :<filename> (e.g. -F csv:log.csv), defaults to stdout.
Specify MQTT server with e.g. -F mqtt://localhost:1883
Default user and password are read from MQTT_USERNAME and MQTT_PASSWORD env vars.
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_USERNAME 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
events: posts JSON event data, default "<base>/events"
states: posts JSON state data, default "<base>/states"
devices: posts device and sensor info in nested topics,
default "<base>/devices[/type][/model][/subtype][/channel][/id]"
A base topic can be set with base=<topic>, default is "rtl_433/HOSTNAME".
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.
Expand Down
15 changes: 9 additions & 6 deletions man/man1/rtl_433.1
Original file line number Diff line number Diff line change
Expand Up @@ -338,28 +338,31 @@ Append output to file with :<filename> (e.g. \-F csv:log.csv), defaults to stdou
Specify MQTT server with e.g. \-F mqtt://localhost:1883
.RE
.RS
Default user and password are read from MQTT_USERNAME and MQTT_PASSWORD env vars.
.RE
.RS
Add MQTT options with e.g. \-F "mqtt://host:1883,opt=arg"
.RE
.RS
MQTT options are: user=foo, pass=bar, retain[=0|1], <format>[=topic]
.RE
.RS
Default user and password are read from MQTT_USERNAME and MQTT_PASSWORD env vars.
Supported MQTT formats: (default is all)
.RE
.RS
A base topic can be set with base=<topic>, default is "rtl_433/HOSTNAME".
events: posts JSON event data, default "<base>/events"
.RE
.RS
Supported MQTT formats: (default is all)
states: posts JSON state data, default "<base>/states"
.RE
.RS
events: posts JSON event data
devices: posts device and sensor info in nested topics,
.RE
.RS
states: posts JSON state data
default "<base>/devices[/type][/model][/subtype][/channel][/id]"
.RE
.RS
devices: posts device and sensor info in nested topics
A base topic can be set with base=<topic>, default is "rtl_433/HOSTNAME".
.RE
.RS
Any topic string overrides the base topic and will expand keys like [/model]
Expand Down

0 comments on commit 5e8f1d0

Please sign in to comment.