Class ModuleConfig

Module Config

Generated

from message meshtastic.ModuleConfig

Hierarchy

Constructors

constructor

Properties

payloadVariant fields runtime typeName

Methods

clone equals fromBinary fromJson fromJsonString getType toBinary toJSON toJson toJsonString equals fromBinary fromJson fromJsonString

Constructors

constructor

  • new ModuleConfig(data?): ModuleConfig

  • Parameters

    Returns ModuleConfig

Properties

payloadVariant

payloadVariant: {
    case: "mqtt";
    value: ModuleConfig_MQTTConfig;
} | {
    case: "serial";
    value: ModuleConfig_SerialConfig;
} | {
    case: "externalNotification";
    value: ModuleConfig_ExternalNotificationConfig;
} | {
    case: "storeForward";
    value: ModuleConfig_StoreForwardConfig;
} | {
    case: "rangeTest";
    value: ModuleConfig_RangeTestConfig;
} | {
    case: "telemetry";
    value: ModuleConfig_TelemetryConfig;
} | {
    case: "cannedMessage";
    value: ModuleConfig_CannedMessageConfig;
} | {
    case: "audio";
    value: ModuleConfig_AudioConfig;
} | {
    case: "remoteHardware";
    value: ModuleConfig_RemoteHardwareConfig;
} | {
    case: "neighborInfo";
    value: ModuleConfig_NeighborInfoConfig;
} | {
    case: "ambientLighting";
    value: ModuleConfig_AmbientLightingConfig;
} | {
    case: "detectionSensor";
    value: ModuleConfig_DetectionSensorConfig;
} | {
    case: "paxcounter";
    value: ModuleConfig_PaxcounterConfig;
} | {
    case: undefined;
    value?: undefined;
}

TODO: REPLACE

Type declaration

  • case: "mqtt"
  • value: ModuleConfig_MQTTConfig

    TODO: REPLACE

    Generated

    from field: meshtastic.ModuleConfig.MQTTConfig mqtt = 1;

Type declaration

  • case: "serial"
  • value: ModuleConfig_SerialConfig

    TODO: REPLACE

    Generated

    from field: meshtastic.ModuleConfig.SerialConfig serial = 2;

Type declaration

Type declaration

  • case: "storeForward"
  • value: ModuleConfig_StoreForwardConfig

    TODO: REPLACE

    Generated

    from field: meshtastic.ModuleConfig.StoreForwardConfig store_forward = 4;

Type declaration

  • case: "rangeTest"
  • value: ModuleConfig_RangeTestConfig

    TODO: REPLACE

    Generated

    from field: meshtastic.ModuleConfig.RangeTestConfig range_test = 5;

Type declaration

  • case: "telemetry"
  • value: ModuleConfig_TelemetryConfig

    TODO: REPLACE

    Generated

    from field: meshtastic.ModuleConfig.TelemetryConfig telemetry = 6;

Type declaration

Type declaration

  • case: "audio"
  • value: ModuleConfig_AudioConfig

    TODO: REPLACE

    Generated

    from field: meshtastic.ModuleConfig.AudioConfig audio = 8;

Type declaration

Type declaration

  • case: "neighborInfo"
  • value: ModuleConfig_NeighborInfoConfig

    TODO: REPLACE

    Generated

    from field: meshtastic.ModuleConfig.NeighborInfoConfig neighbor_info = 10;

Type declaration

Type declaration

Type declaration

  • case: "paxcounter"
  • value: ModuleConfig_PaxcounterConfig

    TODO: REPLACE

    Generated

    from field: meshtastic.ModuleConfig.PaxcounterConfig paxcounter = 13;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof meshtastic.ModuleConfig.payload_variant

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "meshtastic.ModuleConfig" = "meshtastic.ModuleConfig"

Methods

clone

  • clone(): ModuleConfig

  • Create a deep copy.

    Returns ModuleConfig

equals

  • equals(other): boolean

  • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

    Parameters

    Returns boolean

fromBinary

  • fromBinary(bytes, options?): this

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

fromJson

  • fromJson(jsonValue, options?): this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

fromJsonString

  • fromJsonString(jsonString, options?): this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

getType

  • getType(): MessageType<ModuleConfig>

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<ModuleConfig>

toBinary

  • toBinary(options?): Uint8Array

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

Protected toJSON

  • toJSON(): JsonValue

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

toJson

  • toJson(options?): JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • toJsonString(options?): string

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

  • equals(a, b): boolean

  • Parameters

    Returns boolean

Static fromBinary

  • fromBinary(bytes, options?): ModuleConfig

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns ModuleConfig

Static fromJson

  • fromJson(jsonValue, options?): ModuleConfig

  • Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns ModuleConfig

Static fromJsonString

  • fromJsonString(jsonString, options?): ModuleConfig

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns ModuleConfig

Settings

Member Visibility

Theme

On This Page

constructorpayloadVariantfieldsruntimetypeNamecloneequalsfromBinaryfromJsonfromJsonStringgetTypetoBinarytoJSONtoJsontoJsonStringequalsfromBinaryfromJsonfromJsonString

Generated using TypeDoc