|
|
|
|
|
|
|
|
|
|
- Properties specific to mqttSession variables
- Authentication mode
- Functions that use mqttSession variables
mqttSession (Variable type)
The mqttSession type is used to define the parameters for connecting to the MQTT broker. These connection parameters can be defined and changed by several WLanguage properties. Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
gMqttSession is mqttSession
gMqttSession.Address = EDT_Broker_Address
gMqttSession.Port = EDT_Port
gMqttSession.Option = CBOX_SSL
gMqttSession.ConnectionTimeout = EDT_Connection_Timeout
gMqttSession.User = EDT_Login
gMqttSession.UserPassword = EDT_PSW
gMqttSession.PrivateKey = EDT_Private_Key
gMqttSession.PrivateKeyPassword = EDT_Private_Key_PSW
gMqttSession.ClientID = EDT_ClientID
gMqttSession.CleanSession = CBOX_Clean_Session
IF MQTTConnect(gMqttSession) THEN
Message("Connection OK")
ELSE
Error("Connection problem. '" + ErrorInfo() + "')")
END
Propiedades Properties specific to mqttSession variables The following properties can be used to handle a MQTT session: | | | | Property name | Type used | Effect |
|---|
| Address | Character string | Address of MQTT server (also called "MQTT broker"). This address can be specified as follows:- IP address in XXX.XXX.XXX.XXX format (125.5.110.100 for example).
- IP address containing the server name (MQTTServer for example). This syntax is recommended.
| | CleanSession | Boolean | - True if it is necessary to empty the generic global parameters on the server,
- False otherwise.
| | ClientID | Character string | Client identifier. This property must not be left empty. | | ConnectionTimeout | Integer or Duration | Connection timeout in seconds. This property can correspond to: - an integer corresponding to the number of seconds,
- a Duration variable,
- the duration in a readable format (e.g., 10 s).
| | IgnoreError | Integer constant | Specifies the ignored errors. Corresponds to a constant or to a combination of constants: - mqttIgnoreCertificateExpired The certificate date is ignored.
- mqttIgnoreCertificateInvalid The certificate is ignored.
- mqttIgnoreCertificateNameInvalid: The site name in the certificate is ignored.
- mqttIgnoreRevocation: Certificate revocation is ignored.
| | Option | Integer constant | Connection options. This property can correspond to the optionSSL constant for an SSL connection. | | Port | Integer | Port of MQTT server. This port correspondsn to 1883 by default (or 8883 for an SSL connection). | | PrivateKey | Character string or Certificate variable | Name of the Certificate variable or path of the pem file (to make a private key connection). If this property is set, authentication by key is performed: only the properties User, PrivateKey and PrivateKeyPassword are taken into account.. | | PrivateKeyPassword | Character string or Secret string | Password of the key file (for a private-key based authentication). The PrivateKey property corresponds to the private key to be used.
 Novedad versión 2025Cadenas secretas: Si utiliza el almacén de cadenas secretas, el tipo de cadena secreta utilizado para este parámetro debe ser "ANSI string - Latin". Para obtener más información sobre las cadenas secretas y el almacén, consulte Almacén de cadenas secretas. | | User | Character string | Username. | | UserPassword | Character string or Secret string | User password (the User property corresponds to the user's name).
Novedad versión 2025Cadenas secretas: Si utiliza el almacén de cadenas secretas, el tipo de cadena secreta utilizado para este parámetro debe ser "ANSI o Unicode string". Para obtener más información sobre las cadenas secretas y el almacén, consulte Almacén de cadenas secretas. |
Observaciones Authentication mode Key-based authentication takes precedence over password-based authentication. Key-based authentication is used if: - the server supports this authentication mode.
- the PrivateKey property is specified.
Password-based authentication is used if: - the server supports this authentication mode.
- property UserPassword is set.
Functions that use mqttSession variables Functions manipulating variables of type mqttSession are as follows: | | | MQTTConnect | Se utiliza para conectarse a un servidor MQTT (también llamado "Broker"). | | MQTTDisconnect | Permite desconectarse de un servidor MQTT (también llamado "Broker"). | | MQTTPublish | Publishes a message on the MQTT broker. | | MQTTSubscribe | Used to subscribe to a MQTT notification. | | MQTTUnsubscribe | Se utiliza para darse de baja de una notificación MQTT. | | MQTTUnsubscribeAll | Permite darse de baja de todas las suscripciones existentes. |
Esta página también está disponible para…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|