MapReport class

Information about a node intended to be reported unencrypted to a map using MQTT.

Available extensions

Constructors

MapReport.new({String? longName, String? shortName, Config_DeviceConfig_Role? role, HardwareModel? hwModel, String? firmwareVersion, Config_LoRaConfig_RegionCode? region, Config_LoRaConfig_ModemPreset? modemPreset, bool? hasDefaultChannel, int? latitudeI, int? longitudeI, int? altitude, int? positionPrecision, int? numOnlineLocalNodes, bool? hasOptedReportLocation})
factory
MapReport.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
MapReport.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

altitude ↔ int
Altitude in meters above MSL
getter/setter pair
firmwareVersion ↔ String
Device firmware version string
getter/setter pair
hasDefaultChannel ↔ bool
Whether the node has a channel with default PSK and name (LongFast, MediumSlow, etc...) and it uses the default frequency slot given the region and modem preset.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
hasOptedReportLocation ↔ bool
User has opted in to share their location (map report) with the mqtt server Controlled by map_report.should_report_location
getter/setter pair
hwModel ↔ HardwareModel
Hardware model of the node, i.e. T-Beam, Heltec V3, etc...
getter/setter pair
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
latitudeI ↔ int
Latitude: multiply by 1e-7 to get degrees in floating point
getter/setter pair
longitudeI ↔ int
Longitude: multiply by 1e-7 to get degrees in floating point
getter/setter pair
longName ↔ String
A full name for this user, i.e. "Kevin Hester"
getter/setter pair
modemPreset ↔ Config_LoRaConfig_ModemPreset
Modem preset used by the radio (LongFast, MediumSlow, etc...)
getter/setter pair
numOnlineLocalNodes ↔ int
Number of online nodes (heard in the last 2 hours) this node has in its list that were received locally (not via MQTT)
getter/setter pair
positionPrecision ↔ int
Indicates the bits of precision for latitude and longitude set by the sending node
getter/setter pair
region ↔ Config_LoRaConfig_RegionCode
The region code for the radio (US, CN, EU433, etc...)
getter/setter pair
role ↔ Config_DeviceConfig_Role
Role of the node that applies specific settings for a particular use-case
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shortName ↔ String
A VERY short name, ideally two characters. Suitable for a tiny OLED screen
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

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
clearAltitude() → 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
clearFirmwareVersion() → void
clearHasDefaultChannel() → void
clearHasOptedReportLocation() → void
clearHwModel() → void
clearLatitudeI() → void
clearLongitudeI() → void
clearLongName() → void
clearModemPreset() → void
clearNumOnlineLocalNodes() → void
clearPositionPrecision() → void
clearRegion() → void
clearRole() → void
clearShortName() → void
clone() → MapReport
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
copyWith(void updates(MapReport)) → MapReport
Apply updates to a copy of this message.
createEmptyInstance() → MapReport
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
hasAltitude() → 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
hasFirmwareVersion() → bool
hasHasDefaultChannel() → bool
hasHasOptedReportLocation() → bool
hasHwModel() → bool
hasLatitudeI() → bool
hasLongitudeI() → bool
hasLongName() → bool
hasModemPreset() → bool
hasNumOnlineLocalNodes() → bool
hasPositionPrecision() → bool
hasRegion() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasRole() → bool
hasShortName() → 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() → MapReport
createRepeated() → PbList<MapReport>
getDefault() → MapReport