DeviceState class
This message is never sent over the wire, but it is used for serializing DB state to flash in the device code FIXME, since we write this each time we enter deep sleep (and have infinite flash) it would be better to use some sort of append only data structure for the receive queue and use the preferences store for the other stuff
- Available extensions
Constructors
-
DeviceState.new({MyNodeInfo? myNode, User? owner, Iterable<
MeshPacket> ? receiveQueue, MeshPacket? rxTextMessage, int? version, @Deprecated('This field is deprecated.') bool? noSave, @Deprecated('This field is deprecated.') bool? didGpsReset, MeshPacket? rxWaypoint, Iterable<NodeRemoteHardwarePin> ? nodeRemoteHardwarePins}) -
factory
-
DeviceState.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- DeviceState.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- didGpsReset ↔ bool
-
Previously used to manage GPS factory resets.
Deprecated in 2.5.23
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 - myNode ↔ MyNodeInfo
-
Read only settings/info about this node
getter/setter pair
-
nodeRemoteHardwarePins
→ PbList<
NodeRemoteHardwarePin> -
The mesh's nodes with their available gpio pins for RemoteHardware module
no setter
- noSave ↔ bool
-
Used only during development.
Indicates developer is testing and changes should never be saved to flash.
Deprecated in 2.3.1
getter/setter pair
- owner ↔ User
-
My owner info
getter/setter pair
-
receiveQueue
→ PbList<
MeshPacket> -
Received packets saved for delivery to the phone
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- rxTextMessage ↔ MeshPacket
-
We keep the last received text message (only) stored in the device flash,
so we can show it on the screen.
Might be null
getter/setter pair
- rxWaypoint ↔ MeshPacket
-
We keep the last received waypoint stored in the device flash,
so we can show it on the screen.
Might be null
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- version ↔ int
-
A version integer used to invalidate old save files when we make
incompatible changes This integer is set at build time and is private to
NodeDB.cpp in the device code.
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
-
clearDidGpsReset(
) → 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
-
clearMyNode(
) → void -
clearNoSave(
) → void -
clearOwner(
) → void -
clearRxTextMessage(
) → void -
clearRxWaypoint(
) → void -
clearVersion(
) → void -
clone(
) → DeviceState - Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
-
copyWith(
void updates(DeviceState)) → DeviceState -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → DeviceState - 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. -
ensureMyNode(
) → MyNodeInfo -
ensureOwner(
) → User -
ensureRxTextMessage(
) → MeshPacket -
ensureRxWaypoint(
) → MeshPacket -
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
-
hasDidGpsReset(
) → 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 -
hasMyNode(
) → bool -
hasNoSave(
) → bool -
hasOwner(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasRxTextMessage(
) → bool -
hasRxWaypoint(
) → bool -
hasVersion(
) → 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
Static Methods
-
create(
) → DeviceState -
createRepeated(
) → PbList< DeviceState> -
getDefault(
) → DeviceState