日本語

SINETStream User Guide

MQTT-specific parameters

These are messaging system-specific parameters that can be specified with type_spec:. (In config version 1 or 2, they are specified as other parameters.)

• clean_session (MQTTv3 only)
  • Whether to remember the state on reboot and reconnect.
• protocol
  • MQTT Version.
  • Choose either MQTTv31, MQTTv311, or MQTTv5.
  • In the MicroPython, the only value that can be specified is MQTTv311 (upython)
• transport
  • Choose either tcp or websockets.
  • In the MicroPython platform, the only value that can be specified is tcp (upython)
• qos
  • The QoS for sending and receiving messages.
  • Choose one of 0, 1, or 2, which correspond to AT_MOST_ONCE, AT_LEAST_ONCE, EXACTLY_ONCE of Consistency, respectively.
  • The QoS setting takes precedence over the consistency setting.
  • The value of qos affects the value obtained by getConsistency() from MessageReader and MessageWriter.
  • The EXACTLY_ONCE flag is not available in the MicroPython platform (upython).
• retain
  • Whether the server keeps this message.
• max_inflight_messages (if config version < 3, max_inflight_messages_set)
  • The following parameters can be specified.
  • inflight
    • The maximum number of messages with QoS > 0 that can pass through network flows at once.
  • not available in the MicroPython platform (upython).
• ws_set_options
  • Options for the WebSocket connection.
  • The following parameters can be specified.
    • path
      • The WebSocket path.
    • headers
      • The additional header to the standard WebSocket header. Specify by a mapping.
• tls (if config version < 3, tls_set)
  • Parameters for TLS connection. Specify by a mapping.
  • The following parameters can be specified.
    • ca_certs
      • The path of the CA certificate file (PEM).
    • certfile
      • The path of the client certificate file (PEM).
    • keyfile
      • The path of the private key file of the client certificate (PEM).
    • keyfilePassword
      • The password of the private key file of the client certificate (PEM).
    • tls_version
      • The TLS protocol version.
    • ciphers
      • The ciphers allowed for this connection.
    • trustStore (*)
      • The path of the trust store.
    • trustStoreType (*)
      • The file format of the trust store, e.g., jks, pkcs12, etc.
    • trustStorePassword (*)
      • The password of the trust store.
    • keyStore (*)
      • The path of the keyStore.
    • keyStoreType (*)
      • The file format of the keyStore, e.g., jks, pkcs12, etc.
    • keyStorePassword (*)
      • The password of the keyStore.
  • not implemented in the MicroPython platform (upython).

    (*) trustStore, trustStoreType, trustStorePassword, keyStore, keyStoreType, keyStorePassword, and keyfilePassword are valid only in the Java API.

• tls_insecure (if config version < 3, tls_insecure_set)
  • Configuration of host name verification on TLS connections.
    • value
      • Whether to skip host name verification.
  • not implemented in the MicroPython platform (upython).
• username_pw (if config version < 3, username_pw_set)
  • The user and the password for authentication. Specify by a mapping.
  • The following parameters can be specified.
    • username
    • password
• will (if config version < 3, will_set)
  • Parameters related to Last Will and Testament (LWT). Specify by a mapping.
  • If the client is disconnected unexpectedly, instead the broker issues the message set in LWT.
  • The following parameters can be specified.
    • topic (required)
    • payload (required)
    • qos
    • retain
  • delay_interval (MQTTv5 only)
• reconnect_delay (if config version < 3, reconnect_delay_set)
  • Parameters related to the waiting time before reconnecting. Specify by a mapping.
  • The following parameters can be specified.
    • max_delay
      • Maximum waiting time (in seconds).
    • min_delay
      • Minimum waiting time (in seconds).
  • not available in the MicroPython platform (upython).
• connect
  • Connection parameters. Specify by a mapping.
  • The following parameters can be specified.
    • keepalive
      • The keep alive interval (in seconds).
    • automatic_reconnect (*)
      • Whether to automatically reconnect when connection is lost.
    • connection_timeout (*)
      • The timeout value of connection (in seconds).

        (*) automatic_reconnect and connection_timeout are valid only in the Java API.

• receive_maximum (MQTTv5 only)
  • default: 65Ki
  • the limit of QoS 1 and QoS 2 publications that the client is willing to process concurrently.
• maximum_packet_size (MQTTv5 only)
  • default: no limit
  • the Maximum Packet Size the client is willing to accept.
• topic_alias_maximum (MQTTv5 only)
  • default: 0
  • the highest value that the Client will accept as a Topic Alias sent by the Server.
• request_response_info (MQTTv5 only)
  • default: false
  • the server MAY return response information in the CONNACK.
• request_problem_info (MQTTv5 only)
  • default: true
  • If set to false, the server MAY return a Reason String or User Properties on a CONNACK or DISCONNECT, but must not send a Reason String or User Properties on any packet other than PUBLISH, CONNACK or DISCONNECT.
  • If set to true, the server MAY return a Reason String or User Properties on any packet where it is allowed.
• user_property
• auth_method
  • default: null
  • If set, this value contains the name of the authentication method to be used for extended authentication.
• auth_data
  • default: null
  • If set, this byte array contains the extended authentication data, defined by the Authenticated Method. It is a protocol error to include Authentication Data if there is no Authentication Method.
• clean_start (MQTTv5 only)
  • default: true
  • Sets whether the client and server should remember state across restarts and reconnects.
• session_expiry_interval (MQTTv5 only)
  • default: null(unlimited)
  • This value, measured in seconds, defines the maximum time that the broker will maintain the session for once the client disconnects. Clients should only connect with a long Session Expiry interval if they intend to connect to the server at some later point in time.
• connect
  • max_reconnect_delay (Java&MQTTv5 only)
    • default: 128000
    • Set the maximum time to wait between reconnects
  • use_subscription_identifiers (Java&MQTTv5 only)
    • default: true
    • Sets whether to automatically assign subscription identifiers when subscribing to a topic.
  • send_reason_messages (Java&MQTTv5 only)
    • default: false
  • Append Reason String property on error.
• max_queued_messages (Python only) (if config version <3, max_queued_messages_set)
  • queue_size
    • default: 0
    • Set the maximum number of messages in the outgoing message queue.
    • 0 means unlimited.
  • not available in the MicroPython platform (upython).

The configuration example of MQTT

When using WebSocket instead of TCP to connect with an MQTT broker, set the transport parameter as follows.

header:
  version: 3
config:
  service-mqtt:
    type: mqtt
    brokers: mqtt.example.org
    type_spec:
      transport: websockets