Detection Sensor Module Config

Generated

from message meshtastic.ModuleConfig.DetectionSensorConfig

Hierarchy

Constructors

Properties

detectionTriggeredHigh: boolean

Whether or not the GPIO pin state detection is triggered on HIGH (1) Otherwise LOW (0)

Generated

from field: bool detection_triggered_high = 7;

enabled: boolean

Whether the Module is enabled

Generated

from field: bool enabled = 1;

minimumBroadcastSecs: number

Interval in seconds of how often we can send a message to the mesh when a state change is detected

Generated

from field: uint32 minimum_broadcast_secs = 2;

monitorPin: number

GPIO pin to monitor for state changes

Generated

from field: uint32 monitor_pin = 6;

name: string

Friendly name used to format message sent to mesh Example: A name "Motion" would result in a message "Motion detected" Maximum length of 20 characters

Generated

from field: string name = 5;

sendBell: boolean

Send ASCII bell with alert message Useful for triggering ext. notification on bell

Generated

from field: bool send_bell = 4;

stateBroadcastSecs: number

Interval in seconds of how often we should send a message to the mesh with the current state regardless of changes When set to 0, only state changes will be broadcasted Works as a sort of status heartbeat for peace of mind

Generated

from field: uint32 state_broadcast_secs = 3;

usePullup: boolean

Whether or not use INPUT_PULLUP mode for GPIO pin Only applicable if the board uses pull-up resistors on the pin

Generated

from field: bool use_pullup = 8;

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

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

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

  • Parameters

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

    Returns ModuleConfig_DetectionSensorConfig

  • Parameters

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

    Returns ModuleConfig_DetectionSensorConfig

Generated using TypeDoc