description: ''
format_extension: null
is_fileset: false
schema:
  $schema: https://json-schema.org/draft/2020-12/schema
  type: object
  additionalProperties: false
  description: Configuration settings for connecting to an MQTT broker
  order:
    - broker
    - port
    - credentials
    - tls
  properties:
    broker:
      type: string
      description: The hostname or IP address of the MQTT broker
      default: ''
      examples:
        - mqtt.example.com
        - 192.168.1.100
    credentials:
      type: object
      description: Authentication credentials for the MQTT broker
      order:
        - username
        - password
      properties:
        password:
          type: string
          description: Password for broker authentication
          format: password
        username:
          type: string
          description: Username for broker authentication
    port:
      type: integer
      description: The port number for the MQTT broker connection
      default: 1883
      examples:
        - 1883
        - 8883
    tls:
      type: object
      description: TLS/SSL configuration for secure connections. For standard TLS,
        only the 'enabled' property needs to be set to true. For mutual TLS
        (mTLS) with client authentication, the CA certificate, client
        certificate, and certificate password are also required.
      order:
        - enabled
        - ca_certificate
        - pkcs12_client_certificate
        - pkcs12_certificate_password
      properties:
        ca_certificate:
          type: string
          description: CA certificate in PEM format for verifying the broker identity.
            Optional for standard TLS, required for mTLS.
          default: ''
        enabled:
          type: boolean
          description: Enable TLS/SSL for the connection
          default: false
        pkcs12_certificate_password:
          type: string
          description: Password used to decrypt and access the protected PKCS#12 client
            certificate
          format: password
        pkcs12_client_certificate:
          type: string
          description: DER-formatted PKCS#12 certificate encoded in Base64. Contains both
            the client certificate and private key for authentication
          contentEncoding: base64
          default: ''
  required:
    - broker
    - port
  title: MQTT resource