FromRadio class
Packets from the radio to the phone will appear on the fromRadio characteristic. It will support READ and NOTIFY. When a new packet arrives the device will BLE notify? It will sit in that descriptor until consumed by the phone, at which point the next item in the FIFO will be populated.
- Available extensions
Constructors
- FromRadio.new({int? id, MeshPacket? packet, MyNodeInfo? myInfo, NodeInfo? nodeInfo, Config? config, LogRecord? logRecord, int? configCompleteId, bool? rebooted, ModuleConfig? moduleConfig, Channel? channel, QueueStatus? queueStatus, XModem? xmodemPacket, DeviceMetadata? metadata, MqttClientProxyMessage? mqttClientProxyMessage, FileInfo? fileInfo, ClientNotification? clientNotification, DeviceUIConfig? deviceuiConfig})
-
factory
-
FromRadio.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- FromRadio.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- channel ↔ Channel
-
One packet is sent for each channel
getter/setter pair
- clientNotification ↔ ClientNotification
-
Notification message to the client
getter/setter pair
- config ↔ Config
-
Include a part of the config (was: RadioConfig radio)
getter/setter pair
- configCompleteId ↔ int
-
Sent as true once the device has finished sending all of the responses to want_config
recipient should check if this ID matches our original request nonce, if
not, it means your config responses haven't started yet.
NOTE: This ID must not change - to keep (minimal) compatibility with <1.2 version of android apps.
getter/setter pair
- deviceuiConfig ↔ DeviceUIConfig
-
Persistent data for device-ui
getter/setter pair
- fileInfo ↔ FileInfo
-
File system manifest messages
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- id ↔ int
-
The packet id, used to allow the phone to request missing read packets from the FIFO,
see our bluetooth docs
getter/setter pair
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - logRecord ↔ LogRecord
-
Set to send debug console output over our protobuf stream
getter/setter pair
- metadata ↔ DeviceMetadata
-
Device metadata message
getter/setter pair
- moduleConfig ↔ ModuleConfig
-
Include module config
getter/setter pair
- mqttClientProxyMessage ↔ MqttClientProxyMessage
-
MQTT Client Proxy Message (device sending to client / phone for publishing to MQTT)
getter/setter pair
- myInfo ↔ MyNodeInfo
-
Tells the phone what our node number is, can be -1 if we've not yet joined a mesh.
NOTE: This ID must not change - to keep (minimal) compatibility with <1.2 version of android apps.
getter/setter pair
- nodeInfo ↔ NodeInfo
-
One packet is sent for each node in the on radio DB
starts over with the first node in our DB
getter/setter pair
- packet ↔ MeshPacket
-
Log levels, chosen to match python logging conventions.
getter/setter pair
- queueStatus ↔ QueueStatus
-
Queue status info
getter/setter pair
- rebooted ↔ bool
-
Sent to tell clients the radio has just rebooted.
Set to true if present.
Not used on all transports, currently just used for the serial console.
NOTE: This ID must not change - to keep (minimal) compatibility with <1.2 version of android apps.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- unknownFields → UnknownFieldSet
-
no setterinherited
- xmodemPacket ↔ XModem
-
File Transfer Chunk
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
-
clearChannel(
) → void -
clearClientNotification(
) → void -
clearConfig(
) → void -
clearConfigCompleteId(
) → void -
clearDeviceuiConfig(
) → 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
-
clearFileInfo(
) → void -
clearId(
) → void -
clearLogRecord(
) → void -
clearMetadata(
) → void -
clearModuleConfig(
) → void -
clearMqttClientProxyMessage(
) → void -
clearMyInfo(
) → void -
clearNodeInfo(
) → void -
clearPacket(
) → void -
clearPayloadVariant(
) → void -
clearQueueStatus(
) → void -
clearRebooted(
) → void -
clearXmodemPacket(
) → void -
clone(
) → FromRadio - Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
-
copyWith(
void updates(FromRadio)) → FromRadio -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → FromRadio - 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. -
ensureChannel(
) → Channel -
ensureClientNotification(
) → ClientNotification -
ensureConfig(
) → Config -
ensureDeviceuiConfig(
) → DeviceUIConfig -
ensureFileInfo(
) → FileInfo -
ensureLogRecord(
) → LogRecord -
ensureMetadata(
) → DeviceMetadata -
ensureModuleConfig(
) → ModuleConfig -
ensureMqttClientProxyMessage(
) → MqttClientProxyMessage -
ensureMyInfo(
) → MyNodeInfo -
ensureNodeInfo(
) → NodeInfo -
ensurePacket(
) → MeshPacket -
ensureQueueStatus(
) → QueueStatus -
ensureXmodemPacket(
) → XModem -
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
-
hasChannel(
) → bool -
hasClientNotification(
) → bool -
hasConfig(
) → bool -
hasConfigCompleteId(
) → bool -
hasDeviceuiConfig(
) → 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 -
hasFileInfo(
) → bool -
hasId(
) → bool -
hasLogRecord(
) → bool -
hasMetadata(
) → bool -
hasModuleConfig(
) → bool -
hasMqttClientProxyMessage(
) → bool -
hasMyInfo(
) → bool -
hasNodeInfo(
) → bool -
hasPacket(
) → bool -
hasQueueStatus(
) → bool -
hasRebooted(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasXmodemPacket(
) → 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
-
whichPayloadVariant(
) → FromRadio_PayloadVariant -
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(
) → FromRadio -
createRepeated(
) → PbList< FromRadio> -
getDefault(
) → FromRadio