|
|
|
|
- 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. Remark: 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 = SAI_Adresse_Broker
gMqttSession.Port = SAI_Port
gMqttSession.Option = INT_SSL
gMqttSession.ConnectionTimeout = SAI_Timeout_Connexion
gMqttSession.User = SAI_Login
gMqttSession.UserPassword = SAI_PSW
gMqttSession.PrivateKey = SAI_Clé_Privée
gMqttSession.PrivateKeyPassword = SAI_PSW_Clé_Privée
gMqttSession.ClientID = SAI_IDClient
gMqttSession.CleanSession = INT_Session_Vierge
IF MQTTConnect(gMqttSession) THEN
Message("Connexion OK")
ELSE
Error("Problème de connexion. '" + ErrorInfo() + "')")
END
Observaciones 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 given in the following format:- 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 to clean 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).
| Novedad versión 2024IgnoreError | Integer constant | Specifies the ignored errors. Corresponds to a constant or to a combination of constants: - mqttIgnoreExpiredCertificate: The certificate date is ignored.
- mqttIgnoreInvalidCertificate: The certificate is ignored.
- mqttIgnoreInvalidCertificateName: The site name specified in the certificate is ignored.
- mqttIgnoreRevocation: The certificate revocation is ignored.
| Option | Integer constant | Connection options. This property can correspond to the optionSSL constant for an SSL connection. | Port | entier | 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 specified, an authentication by key is performed: only the User, PrivateKey and PrivateKeyPassword properties are taken into account. | PrivateKeyPassword | Character string | Password of key file (for a connection by private key). The PrivateKey property corresponds to the private key to be used. | User | Character string | User name. | UserPassword | Character string | User's password used in password authentication (the User property is the user's name). |
Authentication mode The authentication by key has priority over the authentication by password. Key authentication is used if: - the server supports this authentication mode.
- the PrivateKey property is specified.
Password authentication is used if: - the server supports this authentication mode.
- the UserPassword is specified.
Functions that use mqttSession variables The following functions are used to handle mqttSession variables: | | MQTTConnect | Se utiliza para conectarse a un servidor MQTT (también llamado "Broker"). | MQTTDesconectar | Le permite desconectarse de un servidor MQTT (también llamado "Broker"). | MQTTPublicar | Publica un mensaje en el broker MQTT. | MQTTTSubscribe | Se utiliza para suscribirse a un MQTT Notification. | MQTTUnsubscribe | Se utiliza para cancelar la suscripción de un MQTT Notification. | MQTTUnsubscribeAll | Le permite darse de baja de todas las suscripciones existentes. |
Esta página también está disponible para…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|