Use unavailable and unknown states consistently when dealing with sensors and entities

app/src/full/java/io/homeassistant/companion/android/sensors/ActivitySensorManager.kt

@@ -17,6 +17,7 @@ import com.google.android.gms.location.SleepSegmentRequest
 import dagger.hilt.android.AndroidEntryPoint
 import io.homeassistant.companion.android.common.sensors.SensorManager
 import io.homeassistant.companion.android.common.sensors.SensorReceiverBase
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import java.util.concurrent.TimeUnit
 import io.homeassistant.companion.android.common.R as commonR
 
@@ -168,8 +169,8 @@ class ActivitySensorManager : BroadcastReceiver(), SensorManager {
             DetectedActivity.STILL -> "still"
             DetectedActivity.TILTING -> "tilting"
             DetectedActivity.WALKING -> "walking"
-            DetectedActivity.UNKNOWN -> "unknown"
-            else -> "unknown"
+            DetectedActivity.UNKNOWN -> STATE_UNKNOWN
+            else -> STATE_UNKNOWN
         }
     }
 
@@ -184,7 +185,7 @@ class ActivitySensorManager : BroadcastReceiver(), SensorManager {
             SleepSegmentEvent.STATUS_SUCCESSFUL -> "successful"
             SleepSegmentEvent.STATUS_MISSING_DATA -> "missing data"
             SleepSegmentEvent.STATUS_NOT_DETECTED -> "not detected"
-            else -> "unknown"
+            else -> STATE_UNKNOWN
         }
     }
 

app/src/full/java/io/homeassistant/companion/android/sensors/GeocodeSensorManager.kt

@@ -9,6 +9,7 @@ import android.os.Build.VERSION.SDK_INT
 import android.util.Log
 import com.google.android.gms.location.LocationServices
 import io.homeassistant.companion.android.common.sensors.SensorManager
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import io.homeassistant.companion.android.database.AppDatabase
 import io.homeassistant.companion.android.database.sensor.SensorSetting
 import io.homeassistant.companion.android.database.sensor.SensorSettingType
@@ -132,7 +133,7 @@ class GeocodeSensorManager : SensorManager {
         onSensorUpdated(
             context,
             geocodedLocation,
-            if (!prettyAddress.isNullOrEmpty()) prettyAddress else "Unknown",
+            if (!prettyAddress.isNullOrEmpty()) prettyAddress else STATE_UNKNOWN,
             geocodedLocation.statelessIcon,
             attributes
         )

app/src/main/java/io/homeassistant/companion/android/controls/CameraControl.kt

@@ -15,6 +15,7 @@ import io.homeassistant.companion.android.R
 import io.homeassistant.companion.android.common.data.integration.Entity
 import io.homeassistant.companion.android.common.data.integration.IntegrationRepository
 import io.homeassistant.companion.android.common.data.websocket.impl.entities.AreaRegistryResponse
+import io.homeassistant.companion.android.common.util.STATE_UNAVAILABLE
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withContext
@@ -47,7 +48,7 @@ object CameraControl : HaControl {
         control.setControlTemplate(
             ThumbnailTemplate(
                 entity.entityId,
-                entity.state != "unavailable" && image != null,
+                entity.state != STATE_UNAVAILABLE && image != null,
                 icon,
                 context.getString(commonR.string.widget_camera_contentdescription)
             )

app/src/main/java/io/homeassistant/companion/android/sensors/CarSensorManager.kt

@@ -16,6 +16,8 @@ import androidx.lifecycle.DefaultLifecycleObserver
 import io.homeassistant.companion.android.BuildConfig
 import io.homeassistant.companion.android.common.R
 import io.homeassistant.companion.android.common.sensors.SensorManager
+import io.homeassistant.companion.android.common.util.STATE_UNAVAILABLE
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import io.homeassistant.companion.android.vehicle.HaCarAppService
 
 @RequiresApi(Build.VERSION_CODES.O)
@@ -173,7 +175,7 @@ class CarSensorManager :
                         onSensorUpdated(
                             context,
                             it,
-                            "unavailable",
+                            STATE_UNAVAILABLE,
                             it.statelessIcon,
                             mapOf()
                         )
@@ -257,7 +259,7 @@ class CarSensorManager :
             onSensorUpdated(
                 context,
                 fuelLevel,
-                if (fuelStatus == "success") data.fuelPercent.value!! else "unknown",
+                if (fuelStatus == "success") data.fuelPercent.value!! else STATE_UNKNOWN,
                 fuelLevel.statelessIcon,
                 mapOf(
                     "status" to fuelStatus
@@ -270,7 +272,7 @@ class CarSensorManager :
             onSensorUpdated(
                 context,
                 batteryLevel,
-                if (batteryStatus == "success") data.batteryPercent.value!! else "unknown",
+                if (batteryStatus == "success") data.batteryPercent.value!! else STATE_UNKNOWN,
                 batteryLevel.statelessIcon,
                 mapOf(
                     "status" to batteryStatus
@@ -288,7 +290,7 @@ class CarSensorManager :
             onSensorUpdated(
                 context,
                 carName,
-                if (status == "success") data.name.value!! else "unknown",
+                if (status == "success") data.name.value!! else STATE_UNKNOWN,
                 carName.statelessIcon,
                 mapOf(
                     "car_manufacturer" to data.manufacturer.value,
@@ -309,7 +311,7 @@ class CarSensorManager :
             onSensorUpdated(
                 context,
                 carStatus,
-                if (status == "success") (data.evChargePortConnected.value == true) else "unknown",
+                if (status == "success") (data.evChargePortConnected.value == true) else STATE_UNKNOWN,
                 carStatus.statelessIcon,
                 mapOf(
                     "car_charge_port_open" to (data.evChargePortOpen.value == true),
@@ -329,7 +331,7 @@ class CarSensorManager :
             onSensorUpdated(
                 context,
                 odometerValue,
-                if (status == "success") data.odometerMeters.value!! else "unknown",
+                if (status == "success") data.odometerMeters.value!! else STATE_UNKNOWN,
                 odometerValue.statelessIcon,
                 mapOf(
                     "status" to status
@@ -348,7 +350,7 @@ class CarSensorManager :
             onSensorUpdated(
                 context,
                 fuelType,
-                if (fuelTypeStatus == "success") getFuelType(data.fuelTypes.value!!) else "unknown",
+                if (fuelTypeStatus == "success") getFuelType(data.fuelTypes.value!!) else STATE_UNKNOWN,
                 fuelType.statelessIcon,
                 mapOf(
                     "status" to fuelTypeStatus
@@ -360,7 +362,7 @@ class CarSensorManager :
             onSensorUpdated(
                 context,
                 evConnector,
-                if (evConnectorTypeStatus == "success") getEvConnectorType(data.evConnectorTypes.value!!) else "unknown",
+                if (evConnectorTypeStatus == "success") getEvConnectorType(data.evConnectorTypes.value!!) else STATE_UNKNOWN,
                 evConnector.statelessIcon,
                 mapOf(
                     "status" to evConnectorTypeStatus
@@ -373,8 +375,8 @@ class CarSensorManager :
     private fun carValueStatus(value: Int): String? {
         return when (value) {
             CarValue.STATUS_SUCCESS -> "success"
-            CarValue.STATUS_UNAVAILABLE -> "unavailable"
-            CarValue.STATUS_UNKNOWN -> "unknown"
+            CarValue.STATUS_UNAVAILABLE -> STATE_UNAVAILABLE
+            CarValue.STATUS_UNKNOWN -> STATE_UNKNOWN
             CarValue.STATUS_UNIMPLEMENTED -> "unimplemented"
             else -> null
         }
@@ -395,9 +397,9 @@ class CarSensorManager :
                 EnergyProfile.FUEL_TYPE_LNG -> "Liquified natural gas"
                 EnergyProfile.FUEL_TYPE_LPG -> "Liquified petroleum gas"
                 EnergyProfile.FUEL_TYPE_OTHER -> "Other"
-                EnergyProfile.FUEL_TYPE_UNKNOWN -> "unknown"
+                EnergyProfile.FUEL_TYPE_UNKNOWN -> STATE_UNKNOWN
                 EnergyProfile.FUEL_TYPE_UNLEADED -> "Unleaded gasoline"
-                else -> "unknown"
+                else -> STATE_UNKNOWN
             }
         }
         return fuelTypeList.toString()
@@ -419,8 +421,8 @@ class CarSensorManager :
                 EnergyProfile.EVCONNECTOR_TYPE_TESLA_HPWC -> "High Power Wall Charger of Tesla"
                 EnergyProfile.EVCONNECTOR_TYPE_TESLA_ROADSTER -> "Connector of Tesla Roadster"
                 EnergyProfile.EVCONNECTOR_TYPE_TESLA_SUPERCHARGER -> "Supercharger of Tesla"
-                EnergyProfile.EVCONNECTOR_TYPE_UNKNOWN -> "unknown"
-                else -> "unknown"
+                EnergyProfile.EVCONNECTOR_TYPE_UNKNOWN -> STATE_UNKNOWN
+                else -> STATE_UNKNOWN
             }
         }
         return evConnectorList.toString()

app/src/main/java/io/homeassistant/companion/android/sensors/LastAppSensorManager.kt

@@ -9,6 +9,7 @@ import android.util.Log
 import androidx.annotation.RequiresApi
 import androidx.core.content.getSystemService
 import io.homeassistant.companion.android.common.sensors.SensorManager
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import io.homeassistant.companion.android.common.R as commonR
 
 class LastAppSensorManager : SensorManager {
@@ -64,7 +65,7 @@ class LastAppSensorManager : SensorManager {
         val current = System.currentTimeMillis()
         val lastApp = usageStats.queryUsageStats(UsageStatsManager.INTERVAL_DAILY, current - 1000 * 1000, current).maxByOrNull { it.lastTimeUsed }?.packageName ?: "none"
 
-        var appLabel = "unknown"
+        var appLabel = STATE_UNKNOWN
 
         try {
             val pm = context.packageManager

app/src/main/java/io/homeassistant/companion/android/sensors/NotificationSensorManager.kt

@@ -17,6 +17,8 @@ import android.util.Log
 import androidx.core.app.NotificationManagerCompat
 import androidx.core.content.getSystemService
 import io.homeassistant.companion.android.common.sensors.SensorManager
+import io.homeassistant.companion.android.common.util.STATE_UNAVAILABLE
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import io.homeassistant.companion.android.database.sensor.SensorSettingType
 import io.homeassistant.companion.android.common.R as commonR
 
@@ -266,7 +268,7 @@ class NotificationSensorManager : NotificationListenerService(), SensorManager {
         val mediaSessionManager = context.getSystemService<MediaSessionManager>()!!
         val mediaList = mediaSessionManager.getActiveSessions(ComponentName(context, NotificationSensorManager::class.java))
         val sessionCount = mediaList.size
-        val primaryPlaybackState = if (sessionCount > 0) getPlaybackState(mediaList[0].playbackState?.state) else "Unavailable"
+        val primaryPlaybackState = if (sessionCount > 0) getPlaybackState(mediaList[0].playbackState?.state) else STATE_UNAVAILABLE
         val attr: MutableMap<String, Any?> = mutableMapOf()
         if (mediaList.size > 0) {
             for (item in mediaList) {
@@ -306,7 +308,7 @@ class NotificationSensorManager : NotificationListenerService(), SensorManager {
             PlaybackState.STATE_SKIPPING_TO_NEXT -> "Skip to Next"
             PlaybackState.STATE_SKIPPING_TO_PREVIOUS -> "Skip to Previous"
             PlaybackState.STATE_SKIPPING_TO_QUEUE_ITEM -> "Skip to Queue Item"
-            else -> "Unknown"
+            else -> STATE_UNKNOWN
         }
     }
 

common/src/main/java/io/homeassistant/companion/android/common/sensors/AndroidOsSensorManager.kt

@@ -2,6 +2,7 @@ package io.homeassistant.companion.android.common.sensors
 
 import android.content.Context
 import android.os.Build
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import io.homeassistant.companion.android.common.R as commonR
 
 class AndroidOsSensorManager : SensorManager {
@@ -67,10 +68,10 @@ class AndroidOsSensorManager : SensorManager {
                 osSecurityPatch.id -> if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
                     Build.VERSION.SECURITY_PATCH
                 } else {
-                    "unknown"
+                    STATE_UNKNOWN
                 }
                 else -> {
-                    "unknown"
+                    STATE_UNKNOWN
                 }
             },
             sensor.statelessIcon,

common/src/main/java/io/homeassistant/companion/android/common/sensors/AudioSensorManager.kt

@@ -6,6 +6,7 @@ import android.media.AudioManager
 import android.os.Build
 import androidx.annotation.RequiresApi
 import androidx.core.content.getSystemService
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import io.homeassistant.companion.android.common.R as commonR
 
 class AudioSensorManager : SensorManager {
@@ -187,7 +188,7 @@ class AudioSensorManager : SensorManager {
             AudioManager.RINGER_MODE_NORMAL -> "normal"
             AudioManager.RINGER_MODE_SILENT -> "silent"
             AudioManager.RINGER_MODE_VIBRATE -> "vibrate"
-            else -> "unknown"
+            else -> STATE_UNKNOWN
         }
 
         val icon = when (audioManager.ringerMode) {
@@ -216,7 +217,7 @@ class AudioSensorManager : SensorManager {
             AudioManager.MODE_IN_CALL -> "in_call"
             AudioManager.MODE_IN_COMMUNICATION -> "in_communication"
             AudioManager.MODE_CALL_SCREENING -> "call_screening"
-            else -> "unknown"
+            else -> STATE_UNKNOWN
         }
 
         val icon = when (audioManager.mode) {

common/src/main/java/io/homeassistant/companion/android/common/sensors/BatterySensorManager.kt

@@ -4,6 +4,7 @@ import android.content.Context
 import android.content.Intent
 import android.content.IntentFilter
 import android.os.BatteryManager
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import java.math.RoundingMode
 import io.homeassistant.companion.android.common.R as commonR
 
@@ -314,7 +315,7 @@ class BatterySensorManager : SensorManager {
             BatteryManager.BATTERY_STATUS_CHARGING -> "charging"
             BatteryManager.BATTERY_STATUS_DISCHARGING -> "discharging"
             BatteryManager.BATTERY_STATUS_NOT_CHARGING -> "not_charging"
-            else -> "unknown"
+            else -> STATE_UNKNOWN
         }
     }
 
@@ -326,7 +327,7 @@ class BatterySensorManager : SensorManager {
             BatteryManager.BATTERY_HEALTH_OVERHEAT -> "overheated"
             BatteryManager.BATTERY_HEALTH_OVER_VOLTAGE -> "over_voltage"
             BatteryManager.BATTERY_HEALTH_UNSPECIFIED_FAILURE -> "failed"
-            else -> "unknown"
+            else -> STATE_UNKNOWN
         }
     }
 

common/src/main/java/io/homeassistant/companion/android/common/sensors/BluetoothSensorManager.kt

@@ -14,6 +14,7 @@ import io.homeassistant.companion.android.common.bluetooth.ble.KalmanFilter
 import io.homeassistant.companion.android.common.bluetooth.ble.MonitoringManager
 import io.homeassistant.companion.android.common.bluetooth.ble.TransmitterManager
 import io.homeassistant.companion.android.common.bluetooth.ble.name
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import io.homeassistant.companion.android.database.AppDatabase
 import io.homeassistant.companion.android.database.sensor.SensorSetting
 import io.homeassistant.companion.android.database.sensor.SensorSettingType
@@ -353,7 +354,7 @@ class BluetoothSensorManager : SensorManager {
             TransmitterManager.stopTransmitting(bleTransmitterDevice)
         }
 
-        val lastState = AppDatabase.getInstance(context).sensorDao().get(bleTransmitter.id).firstOrNull()?.state ?: "unknown"
+        val lastState = AppDatabase.getInstance(context).sensorDao().get(bleTransmitter.id).firstOrNull()?.state ?: STATE_UNKNOWN
         val state = if (isBtOn(context)) bleTransmitterDevice.state else "Bluetooth is turned off"
         val icon = if (bleTransmitterDevice.transmitting) "mdi:bluetooth" else "mdi:bluetooth-off"
         onSensorUpdated(

common/src/main/java/io/homeassistant/companion/android/common/sensors/DNDSensorManager.kt

@@ -7,6 +7,7 @@ import android.os.Build
 import androidx.annotation.ChecksSdkIntAtLeast
 import androidx.annotation.RequiresApi
 import androidx.core.content.getSystemService
+import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
 import io.homeassistant.companion.android.common.R as commonR
 
 @RequiresApi(Build.VERSION_CODES.M)
@@ -67,8 +68,8 @@ class DNDSensorManager : SensorManager {
             NotificationManager.INTERRUPTION_FILTER_ALL -> "off"
             NotificationManager.INTERRUPTION_FILTER_NONE -> "total_silence"
             NotificationManager.INTERRUPTION_FILTER_PRIORITY -> "priority_only"
-            NotificationManager.INTERRUPTION_FILTER_UNKNOWN -> "unknown"
-            else -> "unknown"
+            NotificationManager.INTERRUPTION_FILTER_UNKNOWN -> STATE_UNKNOWN
+            else -> STATE_UNKNOWN
         }
 
         onSensorUpdated(

common/src/main/java/io/homeassistant/companion/android/common/sensors/LastRebootSensorManager.kt

@@ -4,6 +4,7 @@ import android.annotation.SuppressLint
 import android.content.Context
 import android.os.SystemClock
 import android.util.Log
+import io.homeassistant.companion.android.common.util.STATE_UNAVAILABLE
 import io.homeassistant.companion.android.database.AppDatabase
 import io.homeassistant.companion.android.database.sensor.SensorSetting
 import io.homeassistant.companion.android.database.sensor.SensorSettingType
@@ -62,7 +63,7 @@ class LastRebootSensorManager : SensorManager {
 
         var timeInMillis = 0L
         var local = ""
-        var utc = "unavailable"
+        var utc = STATE_UNAVAILABLE
 
         val sensorDao = AppDatabase.getInstance(context).sensorDao()
         val fullSensor = sensorDao.getFull(lastRebootSensor.id).toSensorWithAttributes()