Optional
data: PartialMessage<ModuleConfig_ExternalNotificationConfig>IF this is true, the 'output' Pin will be pulled active high, false means active low.
from field: bool active = 4;
True: Alert when the bell character is received (output)
from field: bool alert_bell = 6;
True: Alert when the bell character is received (output_buzzer)
from field: bool alert_bell_buzzer = 13;
True: Alert when the bell character is received (output_vibra)
from field: bool alert_bell_vibra = 12;
True: Alert when a text message arrives (output)
from field: bool alert_message = 5;
True: Alert when a text message arrives (output_buzzer)
from field: bool alert_message_buzzer = 11;
True: Alert when a text message arrives (output_vibra)
from field: bool alert_message_vibra = 10;
Enable the ExternalNotificationModule
from field: bool enabled = 1;
The notification will toggle with 'output_ms' for this time of seconds. Default is 0 which means don't repeat at all. 60 would mean blink and/or beep for 60 seconds
from field: uint32 nag_timeout = 14;
Define the output pin GPIO setting Defaults to EXT_NOTIFY_OUT if set for the board. In standalone devices this pin should drive the LED to match the UI.
from field: uint32 output = 3;
Optional: Define a tertiary output pin for an active buzzer This is used in standalone devices to to match the UI.
from field: uint32 output_buzzer = 9;
When using in On/Off mode, keep the output on for this many milliseconds. Default 1000ms (1 second).
from field: uint32 output_ms = 2;
Optional: Define a secondary output pin for a vibra motor This is used in standalone devices to match the UI.
from field: uint32 output_vibra = 8;
When true, enables devices with native I2S audio output to use the RTTTL over speaker like a buzzer T-Watch S3 and T-Deck for example have this capability
from field: bool use_i2s_as_buzzer = 15;
use a PWM output instead of a simple on/off output. This will ignore the 'output', 'output_ms' and 'active' settings and use the device.buzzer_gpio instead.
from field: bool use_pwm = 7;
Static
Readonly
fieldsStatic
Readonly
runtimeStatic
Readonly
typeCreate a deep copy.
Compare with a message of the same type.
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.
Optional
options: Partial<BinaryReadOptions>Parse a message from a JSON value.
Optional
options: Partial<JsonReadOptions>Parse a message from a JSON string.
Optional
options: Partial<JsonReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Protected
toJSONOverride 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.
Static
equalsStatic
fromOptional
options: Partial<BinaryReadOptions>Static
fromOptional
options: Partial<JsonReadOptions>Static
fromOptional
options: Partial<JsonReadOptions>Generated using TypeDoc
External Notifications Config
Generated
from message meshtastic.ModuleConfig.ExternalNotificationConfig