Configuration

Generated

from message meshtastic.Config.DeviceConfig

Hierarchy

Constructors

  • Parameters

    Returns Config_DeviceConfig

Properties

buttonGpio: number

For boards without a hard wired button, this is the pin number that will be used Boards that have more than one button can swap the function with this one. defaults to BUTTON_PIN if defined.

Generated

from field: uint32 button_gpio = 4;

buzzerGpio: number

For boards without a PWM buzzer, this is the pin number that will be used Defaults to PIN_BUZZER if defined.

Generated

from field: uint32 buzzer_gpio = 5;

debugLogEnabled: boolean

By default we turn off logging as soon as an API client connects (to keep shared serial link quiet). Set this to true to leave the debug log outputting even when API is active.

Generated

from field: bool debug_log_enabled = 3;

disableTripleClick: boolean

Disables the triple-press of user button to enable or disable GPS

Generated

from field: bool disable_triple_click = 10;

doubleTapAsButtonPress: boolean

Treat double tap interrupt on supported accelerometers as a button press if set to true

Generated

from field: bool double_tap_as_button_press = 8;

isManaged: boolean

If true, device is considered to be "managed" by a mesh administrator Clients should then limit available configuration and administrative options inside the user interface

Generated

from field: bool is_managed = 9;

ledHeartbeatDisabled: boolean

If true, disable the default blinking LED (LED_PIN) behavior on the device

Generated

from field: bool led_heartbeat_disabled = 12;

nodeInfoBroadcastSecs: number

Send our nodeinfo this often Defaults to 900 Seconds (15 minutes)

Generated

from field: uint32 node_info_broadcast_secs = 7;

Sets the role of node

Generated

from field: meshtastic.Config.DeviceConfig.RebroadcastMode rebroadcast_mode = 6;

Sets the role of node

Generated

from field: meshtastic.Config.DeviceConfig.Role role = 1;

serialEnabled: boolean

Disabling this will disable the SerialConsole by not initilizing the StreamAPI

Generated

from field: bool serial_enabled = 2;

tzdef: string

Generated

from field: string tzdef = 11;

fields: FieldList
runtime: ProtoRuntime
typeName: "meshtastic.Config.DeviceConfig" = "meshtastic.Config.DeviceConfig"

Methods

  • Create a deep copy.

    Returns Config_DeviceConfig

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

    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<Config_DeviceConfig>

  • 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

    Returns boolean

  • Parameters

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

    Returns Config_DeviceConfig

  • Parameters

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

    Returns Config_DeviceConfig

  • Parameters

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

    Returns Config_DeviceConfig

Generated using TypeDoc