Type Alias ModuleConfig_MQTTConfig

Type declaration

• address: string

  The server to use for our MQTT global message gateway feature. If not set, the default server will be used

  Generated

  from field: string address = 2;

• enabled: boolean

  If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as is_uplink_enabled or is_downlink_enabled.

  Generated

  from field: bool enabled = 1;

• encryptionEnabled: boolean

  Whether to send encrypted or decrypted packets to MQTT. This parameter is only honoured if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets) Decrypted packets may be useful for external systems that want to consume meshtastic packets

  Generated

  from field: bool encryption_enabled = 5;

• jsonEnabled: boolean

  Whether to send / consume json packets on MQTT

  Generated

  from field: bool json_enabled = 6;

• mapReportingEnabled: boolean

  If true, we will periodically report unencrypted information about our node to a map via MQTT

  Generated

  from field: bool map_reporting_enabled = 10;

• OptionalmapReportSettings?: ModuleConfig_MapReportSettings

  Settings for reporting information about our node to a map via MQTT

  Generated

  from field: meshtastic.ModuleConfig.MapReportSettings map_report_settings = 11;

• password: string

  MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default password

  Generated

  from field: string password = 4;

• proxyToClientEnabled: boolean

  If true, we can use the connected phone / client to proxy messages to MQTT instead of a direct connection

  Generated

  from field: bool proxy_to_client_enabled = 9;

• root: string

  The root topic to use for MQTT messages. Default is "msh". This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs

  Generated

  from field: string root = 8;

• tlsEnabled: boolean

  If true, we attempt to establish a secure connection using TLS

  Generated

  from field: bool tls_enabled = 7;

• username: string

  MQTT username to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default username

  Generated

  from field: string username = 3;