5,838
edits
Cumulus.ini (preserving history): Difference between revisions
m
→MQTT: corrections
(→Section: MQTT: new) |
m (→MQTT: corrections) |
||
|
=== MQTT ===
MQTT (Message Queuing Telemetry Transport) is a machine-to-machine (M2M)
[[File:Badge vMx.png]] This section is only applicable to Cumulus MX and only available from version 3.5.0 (build 3071)
Most settings are on the '''Internet Settings''' screen in either the MQTT section or one of the two '''Send message''' sections (the section is named for each parameter), but
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
!style="width:150px" | Where to Edit
|-
|style="background:lightgray;"|[
|style="background:lightgray;"|Cumulus.ini Section Name
|style="background:lightgray;"|Settings Section Name
|-
|Server=
|Note there is no default.
|MQTT section
|-
|Username=
|This is optional.This
|MQTT section
|-
|Password=
|This is optional.
|MQTT section
|-
|Port=1883
|Note default.
|MQTT section
|-
|UseTLS=0
|Transport Layer Security (TLS), and its now-deprecated predecessor, Secure Sockets Layer (SSL), are cryptographic protocols designed to provide communications security over a computer network. This tick box on settings screen indicates whether TLS support is required, default is not (0), set to 1 if modern security protocol is being used
|MQTT section tick box
|-
|IPversion=0
|
|In file only
|-
|EnableDataUpdate=0
|This
|tick box in '''Send message on data update''' section
|-
|UpdateTopic=CumulusMX/DataUpdate
|This feature in the '''Send message on data update''' section is where you specify the name to give to the update message
|'''Send message on data update''' section
|-
|UpdateTemplate=DataUpdateTemplate.txt
|In the CumulusMX/mqtt folder there is a default template with a file name specified by the default value of this parameter. In that default file <tt>{"time":"<#timehhmmss>","windspeed":<#wlatest rc=y>,"winddir":<#bearing>}</tt> will send wind readings in case for example you want to close something when it is windy. If you create your own file, you can put its name
|'''Send message on data update''' section
|-
|EnableInterval=0
|This tick box
|tick box in '''Send message at fixed intervals''' section
|-
|IntervalTime=600
|This text box
|'''Send message at fixed intervals''' section
|-
|IntervalTopic=CumulusMX/Interval
|This
|'''Send message at fixed intervals''' section
|-
|IntervalTemplate=IntervalTemplate.txt
|In the CumulusMX/mqtt folder there is a default template with a file name specified by the default value of this parameter. In that default file <tt>{"time":"<#timehhmmss>","temp":<#temp rc=y>,"humidity":<#hum>}</tt> will send temperature and humidity readings in case for example you want to open something when it feels uncomfortable. If you create your own file, you can put its name
|'''Send message at fixed intervals''' section
|}
| |||