TODO: REPLACE

Generated

from message meshtastic.ModuleConfig.CannedMessageConfig

Hierarchy

Constructors

Properties

allowInputSource: string

Input event origin accepted by the canned message module. Can be e.g. "rotEnc1", "upDownEnc1" or keyword "_any"

Generated

from field: string allow_input_source = 10;

enabled: boolean

Enable/disable CannedMessageModule.

Generated

from field: bool enabled = 9;

Generate input event on CCW of this kind.

Generated

from field: meshtastic.ModuleConfig.CannedMessageConfig.InputEventChar inputbroker_event_ccw = 6;

Generate input event on CW of this kind.

Generated

from field: meshtastic.ModuleConfig.CannedMessageConfig.InputEventChar inputbroker_event_cw = 5;

Generate input event on Press of this kind.

Generated

from field: meshtastic.ModuleConfig.CannedMessageConfig.InputEventChar inputbroker_event_press = 7;

inputbrokerPinA: number

GPIO pin for rotary encoder A port.

Generated

from field: uint32 inputbroker_pin_a = 2;

inputbrokerPinB: number

GPIO pin for rotary encoder B port.

Generated

from field: uint32 inputbroker_pin_b = 3;

inputbrokerPinPress: number

GPIO pin for rotary encoder Press port.

Generated

from field: uint32 inputbroker_pin_press = 4;

rotary1Enabled: boolean

Enable the rotary encoder #1. This is a 'dumb' encoder sending pulses on both A and B pins while rotating.

Generated

from field: bool rotary1_enabled = 1;

sendBell: boolean

CannedMessageModule also sends a bell character with the messages. ExternalNotificationModule can benefit from this feature.

Generated

from field: bool send_bell = 11;

updown1Enabled: boolean

Enable the Up/Down/Select input device. Can be RAK rotary encoder or 3 buttons. Uses the a/b/press definitions from inputbroker.

Generated

from field: bool updown1_enabled = 8;

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

Methods

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

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

  • Parameters

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

    Returns ModuleConfig_CannedMessageConfig

  • Parameters

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

    Returns ModuleConfig_CannedMessageConfig

Generated using TypeDoc