ModuleConfig_ExternalNotificationConfig class
External Notifications Config
- Available extensions
Constructors
- ModuleConfig_ExternalNotificationConfig.new({bool? enabled, int? outputMs, int? output, bool? active, bool? alertMessage, bool? alertBell, bool? usePwm, int? outputVibra, int? outputBuzzer, bool? alertMessageVibra, bool? alertMessageBuzzer, bool? alertBellVibra, bool? alertBellBuzzer, int? nagTimeout, bool? useI2sAsBuzzer})
-
factory
-
ModuleConfig_ExternalNotificationConfig.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- ModuleConfig_ExternalNotificationConfig.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- active ↔ bool
-
IF this is true, the 'output' Pin will be pulled active high, false
means active low.
getter/setter pair
- alertBell ↔ bool
-
True: Alert when the bell character is received (output)
getter/setter pair
- alertBellBuzzer ↔ bool
-
True: Alert when the bell character is received (output_buzzer)
getter/setter pair
- alertBellVibra ↔ bool
-
True: Alert when the bell character is received (output_vibra)
getter/setter pair
- alertMessage ↔ bool
-
True: Alert when a text message arrives (output)
getter/setter pair
- alertMessageBuzzer ↔ bool
-
True: Alert when a text message arrives (output_buzzer)
getter/setter pair
- alertMessageVibra ↔ bool
-
True: Alert when a text message arrives (output_vibra)
getter/setter pair
- enabled ↔ bool
-
Enable the ExternalNotificationModule
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - nagTimeout ↔ int
-
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
getter/setter pair
- output ↔ int
-
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.
getter/setter pair
- outputBuzzer ↔ int
-
Optional: Define a tertiary output pin for an active buzzer
This is used in standalone devices to to match the UI.
getter/setter pair
- outputMs ↔ int
-
When using in On/Off mode, keep the output on for this many
milliseconds. Default 1000ms (1 second).
getter/setter pair
- outputVibra ↔ int
-
Optional: Define a secondary output pin for a vibra motor
This is used in standalone devices to match the UI.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- unknownFields → UnknownFieldSet
-
no setterinherited
- useI2sAsBuzzer ↔ bool
-
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
getter/setter pair
- usePwm ↔ bool
-
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.
getter/setter pair
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
Throws a StateError if the message has required fields without a value.
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearActive(
) → void -
clearAlertBell(
) → void -
clearAlertBellBuzzer(
) → void -
clearAlertBellVibra(
) → void -
clearAlertMessage(
) → void -
clearAlertMessageBuzzer(
) → void -
clearAlertMessageVibra(
) → void -
clearEnabled(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearNagTimeout(
) → void -
clearOutput(
) → void -
clearOutputBuzzer(
) → void -
clearOutputMs(
) → void -
clearOutputVibra(
) → void -
clearUseI2sAsBuzzer(
) → void -
clearUsePwm(
) → void -
clone(
) → ModuleConfig_ExternalNotificationConfig - Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
-
copyWith(
void updates(ModuleConfig_ExternalNotificationConfig)) → ModuleConfig_ExternalNotificationConfig -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → ModuleConfig_ExternalNotificationConfig - Creates an empty instance of the same message type as this.
-
deepCopy(
) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message. -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasActive(
) → bool -
hasAlertBell(
) → bool -
hasAlertBellBuzzer(
) → bool -
hasAlertBellVibra(
) → bool -
hasAlertMessage(
) → bool -
hasAlertMessageBuzzer(
) → bool -
hasAlertMessageVibra(
) → bool -
hasEnabled(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasNagTimeout(
) → bool -
hasOutput(
) → bool -
hasOutputBuzzer(
) → bool -
hasOutputMs(
) → bool -
hasOutputVibra(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasUseI2sAsBuzzer(
) → bool -
hasUsePwm(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Same as
mergeFromBuffer, but takes aCodedBufferReaderinput.inherited -
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
void updates(T)) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Applyupdatesto a copy of this message. -
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.inherited -
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited