ModuleConfig_MQTTConfig class

MQTT Client Config

Available extensions

Constructors

ModuleConfig_MQTTConfig.new({bool? enabled, String? address, String? username, String? password, bool? encryptionEnabled, bool? jsonEnabled, bool? tlsEnabled, String? root, bool? proxyToClientEnabled, bool? mapReportingEnabled, ModuleConfig_MapReportSettings? mapReportSettings})
factory
ModuleConfig_MQTTConfig.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
ModuleConfig_MQTTConfig.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

address ↔ String
The server to use for our MQTT global message gateway feature. If not set, the default server will be used
getter/setter pair
enabled ↔ bool
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.
getter/setter pair
encryptionEnabled ↔ bool
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
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
jsonEnabled ↔ bool
Whether to send / consume json packets on MQTT
getter/setter pair
mapReportingEnabled ↔ bool
If true, we will periodically report unencrypted information about our node to a map via MQTT
getter/setter pair
mapReportSettings ↔ ModuleConfig_MapReportSettings
Settings for reporting information about our node to a map via MQTT
getter/setter pair
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
getter/setter pair
proxyToClientEnabled ↔ bool
If true, we can use the connected phone / client to proxy messages to MQTT instead of a direct connection
getter/setter pair
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
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tlsEnabled ↔ bool
If true, we attempt to establish a secure connection using TLS
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
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
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearAddress() → void
clearEnabled() → void
clearEncryptionEnabled() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearJsonEnabled() → void
clearMapReportingEnabled() → void
clearMapReportSettings() → void
clearPassword() → void
clearProxyToClientEnabled() → void
clearRoot() → void
clearTlsEnabled() → void
clearUsername() → void
clone() → ModuleConfig_MQTTConfig
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
copyWith(void updates(ModuleConfig_MQTTConfig)) → ModuleConfig_MQTTConfig
Apply updates to a copy of this message.
createEmptyInstance() → ModuleConfig_MQTTConfig
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
ensureMapReportSettings() → ModuleConfig_MapReportSettings
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasAddress() → bool
hasEnabled() → bool
hasEncryptionEnabled() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasJsonEnabled() → bool
hasMapReportingEnabled() → bool
hasMapReportSettings() → bool
hasPassword() → bool
hasProxyToClientEnabled() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasRoot() → bool
hasTlsEnabled() → bool
hasUsername() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited