Meshtastic-Android/app/src/main/java/com/geeksville/mesh/NodeInfo.kt

161 lines
5.3 KiB
Kotlin
Raw Normal View History

package com.geeksville.mesh
import android.os.Parcelable
2022-05-20 11:20:13 -03:00
import com.geeksville.mesh.util.bearing
import com.geeksville.mesh.util.latLongToMeter
2020-05-30 14:38:16 -07:00
import com.geeksville.util.anonymize
import kotlinx.parcelize.Parcelize
import kotlinx.serialization.Serializable
//
// model objects that directly map to the corresponding protobufs
//
@Serializable
@Parcelize
2021-03-14 11:42:04 +08:00
data class MeshUser(
val id: String,
val longName: String,
val shortName: String,
val hwModel: MeshProtos.HardwareModel
2022-03-26 18:10:40 -03:00
) : Parcelable {
override fun toString(): String {
2021-03-14 11:42:04 +08:00
return "MeshUser(id=${id.anonymize}, longName=${longName.anonymize}, shortName=${shortName.anonymize}, hwModel=${hwModelString})"
}
2021-03-14 11:42:04 +08:00
/** a string version of the hardware model, converted into pretty lowercase and changing _ to -, and p to dot
* or null if unset
* */
val hwModelString: String?
get() =
2022-03-26 18:10:40 -03:00
if (hwModel == MeshProtos.HardwareModel.UNSET) null
else hwModel.name.replace('_', '-').replace('p', '.').lowercase()
}
@Serializable
@Parcelize
2020-02-19 10:53:36 -08:00
data class Position(
val latitude: Double,
val longitude: Double,
val altitude: Int,
2022-03-26 18:10:40 -03:00
val time: Int = currentTime() // default to current time in secs (NOT MILLISECONDS!)
) : Parcelable {
companion object {
/// Convert to a double representation of degrees
fun degD(i: Int) = i * 1e-7
fun degI(d: Double) = (d * 1e7).toInt()
fun currentTime() = (System.currentTimeMillis() / 1000).toInt()
}
/** Create our model object from a protobuf. If time is unspecified in the protobuf, the provided default time will be used.
*/
constructor(p: MeshProtos.Position, defaultTime: Int = currentTime()) : this(
// We prefer the int version of lat/lon but if not available use the depreciated legacy version
degD(p.latitudeI),
degD(p.longitudeI),
p.altitude,
2022-03-26 18:10:40 -03:00
if (p.time != 0) p.time else defaultTime
)
2020-02-17 15:03:34 -08:00
/// @return distance in meters to some other node (or null if unknown)
fun distance(o: Position) = latLongToMeter(latitude, longitude, o.latitude, o.longitude)
/// @return bearing to the other position in degrees
fun bearing(o: Position) = bearing(latitude, longitude, o.latitude, o.longitude)
2022-02-03 18:15:06 -08:00
// If GPS gives a crap position don't crash our app
fun isValid(): Boolean {
2022-06-22 22:02:56 -03:00
return latitude != 0.0 && longitude != 0.0 &&
(latitude >= -90 && latitude <= 90.0) &&
(longitude >= -180 && longitude <= 180)
2022-02-03 18:15:06 -08:00
}
override fun toString(): String {
2022-03-26 18:10:40 -03:00
return "Position(lat=${latitude.anonymize}, lon=${longitude.anonymize}, alt=${altitude.anonymize}, time=${time})"
}
}
@Serializable
@Parcelize
2022-04-04 19:10:15 -03:00
data class DeviceMetrics(
2022-03-28 15:48:27 -03:00
val time: Int = currentTime(), // default to current time in secs (NOT MILLISECONDS!)
2022-03-26 18:10:40 -03:00
val batteryLevel: Int = 0,
val voltage: Float,
val channelUtilization: Float,
2022-03-28 15:48:27 -03:00
val airUtilTx: Float
2022-03-26 18:10:40 -03:00
) : Parcelable {
2022-03-28 15:48:27 -03:00
companion object {
fun currentTime() = (System.currentTimeMillis() / 1000).toInt()
}
2022-03-26 18:10:40 -03:00
/** Create our model object from a protobuf.
*/
2022-04-04 19:10:15 -03:00
constructor(p: TelemetryProtos.DeviceMetrics, telemetryTime: Int = currentTime()) : this(
telemetryTime,
p.batteryLevel,
p.voltage,
p.channelUtilization,
p.airUtilTx
2022-03-26 18:10:40 -03:00
)
override fun toString(): String {
2022-04-04 19:10:15 -03:00
return "DeviceMetrics(time=${time}, batteryLevel=${batteryLevel}, voltage=${voltage}, channelUtilization=${channelUtilization}, airUtilTx=${airUtilTx})"
}
}
@Serializable
@Parcelize
data class NodeInfo(
val num: Int, // This is immutable, and used as a key
var user: MeshUser? = null,
var position: Position? = null,
2021-03-22 21:10:58 -07:00
var snr: Float = Float.MAX_VALUE,
var rssi: Int = Int.MAX_VALUE,
2022-03-28 15:48:27 -03:00
var lastHeard: Int = 0, // the last time we've seen this node in secs since 1970
2022-04-04 19:10:15 -03:00
var deviceMetrics: DeviceMetrics? = null
) : Parcelable {
2022-04-04 19:10:15 -03:00
val batteryPctLevel get() = deviceMetrics?.batteryLevel
2020-02-19 10:53:36 -08:00
/**
* true if the device was heard from recently
*
* Note: if a node has never had its time set, it will have a time of zero. In that
* case assume it is online - so that we will start sending GPS updates
*/
val isOnline: Boolean
get() {
val now = System.currentTimeMillis() / 1000
// FIXME - use correct timeout from the device settings
2020-02-19 15:28:15 -08:00
val timeout =
15 * 60 // Don't set this timeout too tight, or otherwise we will stop sending GPS helper positions to our device
return (now - lastHeard <= timeout) || lastHeard == 0
2020-02-19 10:53:36 -08:00
}
/// return the position if it is valid, else null
val validPosition: Position?
get() {
2022-02-03 18:15:06 -08:00
return position?.takeIf { it.isValid() }
}
2020-02-17 15:03:34 -08:00
/// @return distance in meters to some other node (or null if unknown)
fun distance(o: NodeInfo?): Int? {
val p = validPosition
val op = o?.validPosition
2022-06-22 22:02:56 -03:00
return if (p != null && op != null) p.distance(op).toInt() else null
2020-02-17 15:03:34 -08:00
}
/// @return a nice human readable string for the distance, or null for unknown
fun distanceStr(o: NodeInfo?) = distance(o)?.let { dist ->
when {
dist == 0 -> null // same point
dist < 1000 -> "%.0f m".format(dist.toDouble())
else -> "%.1f km".format(dist / 1000.0)
}
2020-02-17 15:03:34 -08:00
}
}