ModuleConfig_CannedMessageConfig class
Canned Messages Module Config
- Available extensions
Constructors
- ModuleConfig_CannedMessageConfig.new({bool? rotary1Enabled, int? inputbrokerPinA, int? inputbrokerPinB, int? inputbrokerPinPress, ModuleConfig_CannedMessageConfig_InputEventChar? inputbrokerEventCw, ModuleConfig_CannedMessageConfig_InputEventChar? inputbrokerEventCcw, ModuleConfig_CannedMessageConfig_InputEventChar? inputbrokerEventPress, bool? updown1Enabled, @Deprecated('This field is deprecated.') bool? enabled, @Deprecated('This field is deprecated.') String? allowInputSource, bool? sendBell})
-
factory
-
ModuleConfig_CannedMessageConfig.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- ModuleConfig_CannedMessageConfig.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- allowInputSource ↔ String
-
Input event origin accepted by the canned message module.
Can be e.g. "rotEnc1", "upDownEnc1", "scanAndSelect", "cardkb", "serialkb", or keyword "_any"
getter/setter pair
- enabled ↔ bool
-
Enable/disable CannedMessageModule.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setter
- inputbrokerEventCcw ↔ ModuleConfig_CannedMessageConfig_InputEventChar
-
Generate input event on CCW of this kind.
getter/setter pair
- inputbrokerEventCw ↔ ModuleConfig_CannedMessageConfig_InputEventChar
-
Generate input event on CW of this kind.
getter/setter pair
- inputbrokerEventPress ↔ ModuleConfig_CannedMessageConfig_InputEventChar
-
Generate input event on Press of this kind.
getter/setter pair
- inputbrokerPinA ↔ int
-
GPIO pin for rotary encoder A port.
getter/setter pair
- inputbrokerPinB ↔ int
-
GPIO pin for rotary encoder B port.
getter/setter pair
- inputbrokerPinPress ↔ int
-
GPIO pin for rotary encoder Press port.
getter/setter pair
- isFrozen → bool
-
Returns
true
if this message is marked read-only. Otherwisefalse
.no setterinherited - rotary1Enabled ↔ bool
-
Enable the rotary encoder #1. This is a 'dumb' encoder sending pulses on both A and B pins while rotating.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sendBell ↔ bool
-
CannedMessageModule also sends a bell character with the messages.
ExternalNotificationModule can benefit from this feature.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- updown1Enabled ↔ bool
-
Enable the Up/Down/Select input device. Can be RAK rotary encoder or 3 buttons. Uses the a/b/press definitions from inputbroker.
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
-
clearAllowInputSource(
) → 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
-
clearInputbrokerEventCcw(
) → void -
clearInputbrokerEventCw(
) → void -
clearInputbrokerEventPress(
) → void -
clearInputbrokerPinA(
) → void -
clearInputbrokerPinB(
) → void -
clearInputbrokerPinPress(
) → void -
clearRotary1Enabled(
) → void -
clearSendBell(
) → void -
clearUpdown1Enabled(
) → void -
clone(
) → ModuleConfig_CannedMessageConfig - Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
-
copyWith(
void updates(ModuleConfig_CannedMessageConfig)) → ModuleConfig_CannedMessageConfig -
Apply
updates
to a copy of this message. -
createEmptyInstance(
) → ModuleConfig_CannedMessageConfig - 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
-
hasAllowInputSource(
) → bool -
hasEnabled(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
true
if a value ofextension
is present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber
.inherited -
hasInputbrokerEventCcw(
) → bool -
hasInputbrokerEventCw(
) → bool -
hasInputbrokerEventPress(
) → bool -
hasInputbrokerPinA(
) → bool -
hasInputbrokerPinB(
) → bool -
hasInputbrokerPinPress(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasRotary1Enabled(
) → bool -
hasSendBell(
) → bool -
hasUpdown1Enabled(
) → 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 aCodedBufferReader
input.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
other
into 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
Applyupdates
to 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