LocalStats class

Local device mesh statistics

Available extensions

Constructors

LocalStats.new({int? uptimeSeconds, double? channelUtilization, double? airUtilTx, int? numPacketsTx, int? numPacketsRx, int? numPacketsRxBad, int? numOnlineNodes, int? numTotalNodes, int? numRxDupe, int? numTxRelay, int? numTxRelayCanceled, int? heapTotalBytes, int? heapFreeBytes})
factory
LocalStats.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
LocalStats.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

airUtilTx ↔ double
Percent of airtime for transmission used within the last hour.
getter/setter pair
channelUtilization ↔ double
Utilization for the current channel, including well formed TX, RX and malformed RX (aka noise).
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
heapFreeBytes ↔ int
Number of bytes free in the heap
getter/setter pair
heapTotalBytes ↔ int
Number of bytes used in the heap
getter/setter pair
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
numOnlineNodes ↔ int
Number of nodes online (in the past 2 hours)
getter/setter pair
numPacketsRx ↔ int
Number of packets received (both good and bad)
getter/setter pair
numPacketsRxBad ↔ int
Number of packets received that are malformed or violate the protocol
getter/setter pair
numPacketsTx ↔ int
Number of packets sent
getter/setter pair
numRxDupe ↔ int
Number of received packets that were duplicates (due to multiple nodes relaying). If this number is high, there are nodes in the mesh relaying packets when it's unnecessary, for example due to the ROUTER/REPEATER role.
getter/setter pair
numTotalNodes ↔ int
Number of nodes total
getter/setter pair
numTxRelay ↔ int
Number of packets we transmitted that were a relay for others (not originating from ourselves).
getter/setter pair
numTxRelayCanceled ↔ int
Number of times we canceled a packet to be relayed, because someone else did it before us. This will always be zero for ROUTERs/REPEATERs. If this number is high, some other node(s) is/are relaying faster than you.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
unknownFields → UnknownFieldSet
no setterinherited
uptimeSeconds ↔ int
How long the device has been running since the last reboot (in seconds)
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
clearAirUtilTx() → void
clearChannelUtilization() → 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
clearHeapFreeBytes() → void
clearHeapTotalBytes() → void
clearNumOnlineNodes() → void
clearNumPacketsRx() → void
clearNumPacketsRxBad() → void
clearNumPacketsTx() → void
clearNumRxDupe() → void
clearNumTotalNodes() → void
clearNumTxRelay() → void
clearNumTxRelayCanceled() → void
clearUptimeSeconds() → void
clone() → LocalStats
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
copyWith(void updates(LocalStats)) → LocalStats
Apply updates to a copy of this message.
createEmptyInstance() → LocalStats
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
hasAirUtilTx() → bool
hasChannelUtilization() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasHeapFreeBytes() → bool
hasHeapTotalBytes() → bool
hasNumOnlineNodes() → bool
hasNumPacketsRx() → bool
hasNumPacketsRxBad() → bool
hasNumPacketsTx() → bool
hasNumRxDupe() → bool
hasNumTotalNodes() → bool
hasNumTxRelay() → bool
hasNumTxRelayCanceled() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasUptimeSeconds() → 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 a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.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

Apply updates 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 given CodedBufferWriter.
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() → LocalStats
createRepeated() → PbList<LocalStats>
getDefault() → LocalStats