Cumulus Wiki

Cumulus.ini (preserving history): Difference between revisions

Cumulus.ini (preserving history) (view source)

Revision as of 07:26, 22 May 2020

122 bytes added ,  07:26, 22 May 2020
m
→‎MQTT: corrections
m (→‎MQTT: corrections)
Line 2,703: Line 2,703:
=== MQTT ===
=== MQTT ===


MQTT (Message Queuing Telemetry Transport) is a machine-to-machine (M2M)/"Internet of Things" connectivity protocol.
MQTT (Message Queuing Telemetry Transport) is a machine-to-machine (M2M), also known as "Internet of Things", connectivity protocol.


[[File:Badge vMx.png]] This section is only applicable to Cumulus MX and only available from version 3.5.0 (build 3071)
[[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, but some require editing Cumulus.ini while MX is stopped.
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 as indicated one requires editing Cumulus.ini while MX is stopped.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Parameter Line Entry
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function  
!style="width:600px" | Function  
!style="width:150px" | Where to Edit
|-
|-
|style="background:lightgray;"|[Solar]
|style="background:lightgray;"|[MQTT]
|style="background:lightgray;"|Section Name - the following parameters are set from the Solar Setup dialog in Cumulus
|style="background:lightgray;"|Cumulus.ini Section Name
|style="background:lightgray;"|Settings Section Name
|-
|-
|Server=
|Server=
|Note there is no default. The MQTT section is used to enter your server name or the IPv4 or IPv6 address to find your server
|Note there is no default. This text box is to enter your server name or the IPv4 or IPv6 address to find your server
|MQTT section
|-
|-
|Username=
|Username=
|This is optional. The MQTT section is used to enter the username if one is needed for updating your server
|This is optional.This text box is to enter the username if one is needed for updating your server
|MQTT section
|-
|-
|Password=
|Password=
|This is optional. The MQTT section is used to enter any password needed for that username
|This is optional. This text box is to enter any password needed for that username
|MQTT section
|-
|-
|Port=1883
|Port=1883
|Note default. The  settings screen is used to enter which port is used to connect to your server
|Note default. To edit which port is used to connect to your server
|MQTT section
|-
|-
|UseTLS=0
|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
|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
|IPversion=0
|   (0=default, 4=IPv4, 6=IPv6) - This parameter must be added to this Cumulus.ini section, it cannot be edited on a screen.
|(0=default, 4=IPv4, 6=IPv6) - This parameter must be added to this Cumulus.ini section, it cannot be edited on a screen.
|In file only
|-
|-
|EnableDataUpdate=0
|EnableDataUpdate=0
|This tick box on the settings screen in the '''Send message on data update''' section provides an easy way to stop/start the updating without losing other settings. Default is unticked as most people do not use this functionality.
|This provides an easy way to stop/start the updating without losing other settings. Default is unticked as most people do not use this functionality.
|tick box in '''Send message on data update''' section
|-
|-
|UpdateTopic=CumulusMX/DataUpdate
|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
|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
|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 in the '''Send message on data update''' section
|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 here.
|'''Send message on data update''' section
|-
|-
|EnableInterval=0
|EnableInterval=0
|This tick box on the settings screen in the '''Send message at fixed intervals''' section provides an easy way to stop/start this type of updating without losing other settings. Default is unticked as most people do not use this functionality.
|This tick box provides an easy way to stop/start this type of updating without losing other settings. Default is unticked as most people do not use this functionality.
|tick box in '''Send message at fixed intervals''' section
|-
|-
|IntervalTime=600
|IntervalTime=600
|This text box in the '''Send message at fixed intervals''' section is where you enter the time between messages in seconds, the default is 600 meaning every ten minutes.
|This text box is where you enter the time between messages in seconds, the default is 600 meaning every ten minutes.
|'''Send message at fixed intervals''' section
|-
|-
|IntervalTopic=CumulusMX/Interval
|IntervalTopic=CumulusMX/Interval
|This feature in the '''Send message at fixed intervals''' section is where you specify the name to give to the fixed interval update message
|This text box is where you specify the name to give to the fixed interval update message
|'''Send message at fixed intervals''' section
|-
|-
|IntervalTemplate=IntervalTemplate.txt
|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 in the '''Send message at fixed intervals''' section
|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 here.
|'''Send message at fixed intervals''' section
|}
|}
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/5713"