Display Config

Generated

from message meshtastic.Config.DisplayConfig

Hierarchy

Constructors

  • Parameters

    Returns Config_DisplayConfig

Properties

autoScreenCarouselSecs: number

Automatically toggles to the next page on the screen like a carousel, based the specified interval in seconds. Potentially useful for devices without user buttons.

Generated

from field: uint32 auto_screen_carousel_secs = 3;

compassNorthTop: boolean

If this is set, the displayed compass will always point north. if unset, the old behaviour (top of display is heading direction) is used.

Generated

from field: bool compass_north_top = 4;

Display Mode

Generated

from field: meshtastic.Config.DisplayConfig.DisplayMode displaymode = 8;

flipScreen: boolean

Flip screen vertically, for cases that mount the screen upside down

Generated

from field: bool flip_screen = 5;

How the GPS coordinates are formatted on the OLED screen.

Generated

from field: meshtastic.Config.DisplayConfig.GpsCoordinateFormat gps_format = 2;

headingBold: boolean

Print first line in pseudo-bold? FALSE is original style, TRUE is bold

Generated

from field: bool heading_bold = 9;

Override auto-detect in screen

Generated

from field: meshtastic.Config.DisplayConfig.OledType oled = 7;

screenOnSecs: number

Number of seconds the screen stays on after pressing the user button or receiving a message 0 for default of one minute MAXUINT for always on

Generated

from field: uint32 screen_on_secs = 1;

Perferred display units

Generated

from field: meshtastic.Config.DisplayConfig.DisplayUnits units = 6;

wakeOnTapOrMotion: boolean

Should we wake the screen up on accelerometer detected motion or tap

Generated

from field: bool wake_on_tap_or_motion = 10;

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

Methods

  • Create a deep copy.

    Returns Config_DisplayConfig

  • 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<Config_DisplayConfig>

  • 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 Config_DisplayConfig

  • Parameters

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

    Returns Config_DisplayConfig

  • Parameters

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

    Returns Config_DisplayConfig

Generated using TypeDoc