Serial Config

Generated

from message meshtastic.ModuleConfig.SerialConfig

Hierarchy

Constructors

  • Parameters

    Returns ModuleConfig_SerialConfig

Properties

Serial baud rate

Generated

from field: meshtastic.ModuleConfig.SerialConfig.Serial_Baud baud = 5;

echo: boolean

TODO: REPLACE

Generated

from field: bool echo = 2;

enabled: boolean

Preferences for the SerialModule

Generated

from field: bool enabled = 1;

Mode for serial module operation

Generated

from field: meshtastic.ModuleConfig.SerialConfig.Serial_Mode mode = 7;

overrideConsoleSerialPort: boolean

Overrides the platform's defacto Serial port instance to use with Serial module config settings This is currently only usable in output modes like NMEA / CalTopo and may behave strangely or not work at all in other modes Existing logging over the Serial Console will still be present

Generated

from field: bool override_console_serial_port = 8;

rxd: number

RX pin (should match Arduino gpio pin number)

Generated

from field: uint32 rxd = 3;

timeout: number

TODO: REPLACE

Generated

from field: uint32 timeout = 6;

txd: number

TX pin (should match Arduino gpio pin number)

Generated

from field: uint32 txd = 4;

fields: FieldList
runtime: ProtoRuntime
typeName: "meshtastic.ModuleConfig.SerialConfig" = "meshtastic.ModuleConfig.SerialConfig"

Methods

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • 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

  • Parse a message from a JSON value.

    Parameters

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

    Returns this

  • Parse a message from a JSON string.

    Parameters

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

    Returns this

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

    Returns MessageType<ModuleConfig_SerialConfig>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • 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

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

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

  • Parameters

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

    Returns ModuleConfig_SerialConfig

  • Parameters

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

    Returns ModuleConfig_SerialConfig

  • Parameters

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

    Returns ModuleConfig_SerialConfig

Generated using TypeDoc