BenR: /* Detailed description */

2023-12-11T16:36:48Z

Detailed description

Wiki bot at 15:07, 5 December 2023

2023-12-05T15:07:36Z

BenR: /* Temperature and Humidity HTTPS */

2023-12-01T17:19:36Z

Temperature and Humidity HTTPS

BenR: /* Temperature and Humidity */

2023-12-01T17:15:30Z

Temperature and Humidity

BenR: /* Examples */

2023-12-01T17:13:08Z

Examples

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | MatrixTSL |- | width="20%" style="color:gray;" | Version | 0.1 |- | width="20%" style="color:gray;..."

2023-11-27T14:10:39Z

Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | MatrixTSL |- | width="20%" style="color:gray;" | Version | 0.1 |- | width="20%" style="color:gray;..."

New page

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 0.1
|-
| width="20%" style="color:gray;" | Category
| Comms
|}

==MQTT Client component==
A component providing access to MQTT IoT client. The client can connect to a MQTT server such as ThingSpeak via WebSockets. Allows IoT type data to be published and read back.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_MQTT.fcsx FC_Comp_Source_WEBEXP_MQTT.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_MQTT.fcsx FC_Comp_Source_WEBEXP_MQTT.fcsx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''<span style="color:red;">No additional examples</span>''

==Macro reference==

===Connect===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connect'''
|-
| colspan="2" | Connects to the MQTT server (returns false if already connected) 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Disconnect===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Disconnect'''
|-
| colspan="2" | Disconnect from the MQTT server (returns false if client is already disconnected) 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GetClientId===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetClientId'''
|-
| colspan="2" | Returns the unique identifier currently used when communicating with the server. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Publish===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Publish'''
|-
| colspan="2" | Publish a message to the MQTT server (returns false in the client is not connected) 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Topic
|-
| colspan="2" | The name of the topic for the message 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Message
|-
| colspan="2" | The message to publish 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | QoS
|-
| colspan="2" | The quality of service used to deliver the message (0, 1 or 2) 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Retained
|-
| colspan="2" | If true. the message is to be retained by the server and delivered to future subscribers as well as current ones 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===PublishBuffer===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PublishBuffer'''
|-
| colspan="2" | Publish an array of bytes to the MQTT server (returns false in the client is not connected) 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Topic
|-
| colspan="2" | The name of the topic for the message 
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Buffer
|-
| colspan="2" | The message to publish (as an array buffer) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | QoS
|-
| colspan="2" | The quality of service used to deliver the message (0, 1 or 2) 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Retained
|-
| colspan="2" | If true. the message is to be retained by the server and delivered to future subscribers as well as current ones 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Subscribe===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Subscribe'''
|-
| colspan="2" | Subscribe to messages from the MQTT server (returns false in the client is not connected) 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Topic
|-
| colspan="2" | A filter for the topic name(s) to receive 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | QoS
|-
| colspan="2" | The quality of service used to deliver the message (0, 1 or 2) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Timeout
|-
| colspan="2" | The number of seconds to wait before assuming this operation failed 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Unsubscribe===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Unsubscribe'''
|-
| colspan="2" | Unsubscribe from messages from the MQTT server (returns false in the client is not connected) 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Topic
|-
| colspan="2" | A filter for the topic name(s) to stop receiving 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Timeout
|-
| colspan="2" | The number of seconds to wait before assuming this operation failed 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Host
|-
| colspan="2" | The address of the messaging server, as a fully qualified WebSocket URI, as a DNS name or dotted decimal IP address 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Port
|-
| colspan="2" | The port number to connect to 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Directory
|-
| colspan="2" | An optional subdirectory off the host address (e.g. "/mqtt") 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Client Id
|-
| colspan="2" | A unique identifier for this client, between 1 and 23 characters in length 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Use SSL
|-
| colspan="2" | Use a secure (SSL) connection 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Use authentication
|-
| colspan="2" | Use authentication 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Connection timeout
|-
| colspan="2" | If connection has not succeeded within this time (in seconds), it is deemed to have failed 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Keep Alive Interval
|-
| colspan="2" | The server will disconnect this client if there is no activity for this time period (in seconds) 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Clean Session
|-
| colspan="2" | If true, a non-persistent connection is created, meaning subscription information and undelivered messages are not retained when this connection ends 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Reconnect
|-
| colspan="2" | If true, this client will attempt to reconnect to the server if the connection is lost 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Send LWT
|-
| colspan="2" | Send a 'Last Will and Testament' message if unexpected disconnection occurs 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | MQTT Version
|-
| colspan="2" | Which version of MQTT to use 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Debug
|-
| colspan="2" | Determines if additional logging information is sent to the JavaScript console 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Callbacks
|-
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnSuccess
|-
| colspan="2" | Called when an MQTT operation is successful 
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnFailure
|-
| colspan="2" | Called when an MQTT operation is unsuccessful  
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnConnected
|-
| colspan="2" | Called when an MQTT connection is successfully made to the server  
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnConnectionLost
|-
| colspan="2" | Called when an MQTT connection has been lost  
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnMessageDelivered
|-
| colspan="2" | Called when an MQTT message has been delivered  
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnMessageArrived
|-
| colspan="2" | Called when an MQTT message has arrived at this client  
|}

← Older revision		Revision as of 15:07, 5 December 2023
Line 50:		Line 50:

	An example of this can be seen via the URL: https://flowcode.co.uk/example/index.htm		An example of this can be seen via the URL: https://flowcode.co.uk/example/index.htm
		+
		+

	==Macro reference==		==Macro reference==

@@ Line 49: / Line 49: @@
 {{Fcfile|WebApp_MQTT_Client_Demo_Https.fcsx|MQTT Web App Client HTTPS Demo}}
-An example of this can be seen via the URL: https://flowcode.co.uk/test/ben/index.htm
+An example of this can be seen via the URL: https://flowcode.co.uk/example/index.htm
 ==Macro reference==

← Older revision		Revision as of 17:15, 1 December 2023
Line 41:		Line 41:

	{{Fcfile\|ESP_MQTT_Client_TempHumidityDemo.fcfx\|MQTT ESP32 Client Demo}}		{{Fcfile\|ESP_MQTT_Client_TempHumidityDemo.fcfx\|MQTT ESP32 Client Demo}}
		+
		+
		+	===Temperature and Humidity HTTPS===
		+
		+	Here is the temperature and humidity example again but this time set to use HTTPS so that it can be ran from a enabled HTTPS webserver.
		+
		+	{{Fcfile\|WebApp_MQTT_Client_Demo_Https.fcsx\|MQTT Web App Client HTTPS Demo}}
		+
		+	An example of this can be seen via the URL: https://flowcode.co.uk/test/ben/index.htm

	==Macro reference==		==Macro reference==

@@ Line 23: / Line 23: @@
 ==Detailed description==
-''No detailed description exists yet for this component''
+Please note this component currently only supports Web Sockets and must be connected to the Web Socket enabled port of the broker.
 ==Examples==