Update changelog and version

Update changelog and version

CHANGELOG.md

@@ -1,7 +1,51 @@
 # Changelog
 
 <!--next-version-placeholder-->
-## 2023.08.1 (2023-08-21)
+## 2024.9.1 (2024-09-26)
+### Feature
+* Now includes French translation, thanks [`@Julien80`](https://github.com/Julien80) ([`f3c853e`](https://github.com/ryanbdclark/owlet/commit/f3c853e2d7243d766889f2d18c718819da30e4be))
+
+## 2024.6.1 (2024-06-17)
+### Fix
+* Bumping pyowletapi to 2024.6.1 to resolve setup errors ([`52710ba`](https://github.com/ryanbdclark/owlet/commit/52710ba7de53fd07195537c2a5fd2f95bc7dfd1a))
+
+## 2024.5.1 (2024-05-13)
+### Feature
+* As per HA core patterns, certain sensors will now show as unavailable when sock is charging ([`ceade24`](https://github.com/ryanbdclark/owlet/commit/ceade24851479b8c9bc60b7b8bed74a7bdb927e9))
+* Oxygen 10 minute average now only shows a figure if it is between 0 and 100 this avoids skewing by 255 values before the 10 minutes is reached, thanks @coreywillwhat ([`5e17ecd`](https://github.com/ryanbdclark/owlet/commit/5e17ecdeb2aca5bbb35f19ca5795a2c5e0f776ab))
+### Fix
+* Refactoring as per core maintainers suggestions ([`ceade24`](https://github.com/ryanbdclark/owlet/commit/ceade24851479b8c9bc60b7b8bed74a7bdb927e9))
+
+
+## 2024.3.1
+### Feature
+* Base station on added as binary sensor ([`50c55dc`](https://github.com/ryanbdclark/owlet/commit/50c55dcfd30d15027155a8f1d05340238501522d))
+
+### Fix
+* Bumping pyowletapi to 2024.3.2 ([`50c55dc`](https://github.com/ryanbdclark/owlet/commit/50c55dcfd30d15027155a8f1d05340238501522d))
+* UI config now allows you to set interval to 5 seconds, previously the minimum was 10 ([`50c55dc`](https://github.com/ryanbdclark/owlet/commit/50c55dcfd30d15027155a8f1d05340238501522d))
+
+## 2023.11.2 (2023-11-23)
+### Feature
+* Support added for V2 sock ([`50fe1a8`](https://github.com/ryanbdclark/owlet/commit/50fe1a87656b7d6413d06f06f3650fd0bfb48e02))
+* Added tests for binary sensors ([`50fe1a8`](https://github.com/ryanbdclark/owlet/commit/50fe1a87656b7d6413d06f06f3650fd0bfb48e02))
+### Fix
+* Bumping pyowletapi to 2023.11.4 to allow V2 support ([`50fe1a8`](https://github.com/ryanbdclark/owlet/commit/50fe1a87656b7d6413d06f06f3650fd0bfb48e02))
+* Refactoring ([`50fe1a8`](https://github.com/ryanbdclark/owlet/commit/50fe1a87656b7d6413d06f06f3650fd0bfb48e02))
+* Corrected spelling of sock disconnected sensor ([`50fe1a8`](https://github.com/ryanbdclark/owlet/commit/50fe1a87656b7d6413d06f06f3650fd0bfb48e02))
+
+## 2023.11.1 (2023-11-16)
+### Fix
+* Bumping pyowletapi to 2023.11.1 ([`3acf847`](https://github.com/ryanbdclark/owlet/commit/3acf8473526665382b44ef6325d708a6c62fff45))
+* Sensors and binary sensors are now only created where the sock contains that property, this stops errors where different sock versions have different properties ([`3acf847`](https://github.com/ryanbdclark/owlet/commit/3acf8473526665382b44ef6325d708a6c62fff45))
+
+## 2023.9.1 (2023-09-20)
+### Fix
+* Bumping pyowletapi to 2023.9.1 to allow for revisions ([`0a7f703`](https://github.com/ryanbdclark/owlet/commit/0a7f70310080a129c988e9607331baa2f6c691e0))
+* New revision of sock, revision 5 doesn't report all vitals as before, this would cause the integration to fail to update. Have adjusted the integration to detect the revision and ignore the vitals that are no longer reported ([`0a7f703`](https://github.com/ryanbdclark/owlet/commit/0a7f70310080a129c988e9607331baa2f6c691e0))
+
+
+## 2023.8.1 (2023-08-21)
 ### Feature
 * 2 new sensors, movement and movement bucket disabled by default, thanks [`@seanford`](https://github.com/seanford) ([`575b213`](https://github.com/ryanbdclark/owlet/commit/575b213ddd732779cd7938e575fc87c8881a69b0))
 
@@ -17,11 +61,11 @@
 ### Fix
 *  Bumping pyowletapi to 2023.7.1 ([`c693fef`](https://github.com/ryanbdclark/owlet/commit/c693fefbf3dba8f35802b87d064401dadbb211b5))
   
-## 2023.05.7 (2023-05-30)
+## 2023.5.7 (2023-05-30)
 ### Fix
 * Fixed issue with binary sensors not loading, caused by change to way the coordinators are stored ([`8d17317`](https://github.com/ryanbdclark/owlet/commit/8d173174e286b0451cbb2c0d4ae3087028d1ea23))
 
-## 2023.05.6 (2023-05-30)
+## 2023.5.6 (2023-05-30)
 ### Fix
 * In light of submitting this as a pull request to the core of HA there have been some refactoring changes to comply with HA's style requirements
 * Sensor names now moved to strings file to allow for translations
@@ -31,25 +75,25 @@
 ### Feature
 * Tests added
 
-## 2023.05.5 (2023-05-19)
+## 2023.5.5 (2023-05-19)
 #### Fix
 * Owlet refresh token becomes invalid after 24 hours. Meant that after 1 day the integration would stop working. Moved to pyowletapi v2023.5.28 which uses different refresh token, should no longer need reconfiguring after 24 hours ([`dc58b19`](https://github.com/ryanbdclark/owlet/commit/0141f7d01a9ac9b3e1dcc74cabb896e19bd4a821))
 
-## 2023.05.4 (2023-05-17)
+## 2023.5.4 (2023-05-17)
 #### Fix
 * Bumping to pyowletapi 2023.5.25
 
-## 2023.05.3 (2023-05-17)
+## 2023.5.3 (2023-05-17)
 #### Fix
 * Bumping to pyowletapi 2023.5.24
 * Reauthing now no longer re adds users' password to config entry
 
-## 2023.05.2 (2023-05-16)
+## 2023.5.2 (2023-05-16)
 #### Feature
 * Integration now makes use of refresh token from pyowletapi to reauthenticate, user password in no longer stored by integration ([`dc710a1`](https://github.com/ryanbdclark/owlet/commit/dc710a1783a4cad9d6cf355240fe12ac779a87ef))
 * New sensors create for baby sleep state ([`9b3392b`](https://github.com/ryanbdclark/owlet/commit/9b3392bdbcd82015ed31d3a50a517e4e22905684))
  
-## 2023.05.1 (2023-05-15)
+## 2023.5.1 (2023-05-15)
 #### Feature
 * Changed versioning to date based
 ### Fix

README.md

@@ -8,13 +8,11 @@
 [![hacs][hacsbadge]][hacs]
 [![Project Maintenance][maintenance-shield]][user_profile]
 
-A custom component for the Owlet smart sock, currently this only supports the owlet smart sock 3.
-
-If you have a smart sock 2 and would like to contribute then please do so.
+A custom component for the Owlet smart sock
 
 ## Installation
 
-1. Use [HACS](https://hacs.xyz/docs/setup/download), in `HACS > Integrations > Explore & Add Repositories` search for "Owlet". After adding this `https://github.com/ryanbdclark/owlet` as a custom repository.
+1. Use [HACS](https://hacs.xyz/docs/setup/download), in `HACS > Integrations > Explore & Add Repositories` search for "Owlet".
 2. Restart Home Assistant.
 3. [![Add Integration][add-integration-badge]][add-integration] or in the HA UI go to "Settings" -> "Devices & Services" then click "+" and search for "Owlet Smart Sock".
 

custom_components/owlet/__init__.py

@@ -1,4 +1,5 @@
 """The Owlet Smart Sock integration."""
+
 from __future__ import annotations
 
 import asyncio
@@ -72,15 +73,12 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
             entry, data={**entry.data, **devices["tokens"]}
         )
 
-    socks = {
-        device["device"]["dsn"]: Sock(owlet_api, device["device"])
-        for device in devices["response"]
-    }
-
     scan_interval = entry.options.get(CONF_SCAN_INTERVAL)
     coordinators = {
-        serial: OwletCoordinator(hass, sock, scan_interval, entry)
-        for (serial, sock) in socks.items()
+        device["device"]["dsn"]: OwletCoordinator(
+            hass, Sock(owlet_api, device["device"]), scan_interval, entry
+        )
+        for device in devices["response"]
     }
 
     await asyncio.gather(

custom_components/owlet/binary_sensor.py

@@ -1,4 +1,5 @@
 """Support for Owlet binary sensors."""
+
 from __future__ import annotations
 
 from dataclasses import dataclass
@@ -17,62 +18,85 @@ from .coordinator import OwletCoordinator
 from .entity import OwletBaseEntity
 
 
-@dataclass
+@dataclass(kw_only=True)
 class OwletBinarySensorEntityDescription(BinarySensorEntityDescription):
     """Represent the owlet binary sensor entity description."""
 
+    available_during_charging: bool
+
 
 SENSORS: tuple[OwletBinarySensorEntityDescription, ...] = (
     OwletBinarySensorEntityDescription(
         key="charging",
         translation_key="charging",
         device_class=BinarySensorDeviceClass.BATTERY_CHARGING,
+        available_during_charging=True,
     ),
     OwletBinarySensorEntityDescription(
         key="high_heart_rate_alert",
         translation_key="high_hr_alrt",
         device_class=BinarySensorDeviceClass.SOUND,
+        available_during_charging=True,
     ),
     OwletBinarySensorEntityDescription(
         key="low_heart_rate_alert",
         translation_key="low_hr_alrt",
         device_class=BinarySensorDeviceClass.SOUND,
+        available_during_charging=True,
     ),
     OwletBinarySensorEntityDescription(
         key="high_oxygen_alert",
         translation_key="high_ox_alrt",
         device_class=BinarySensorDeviceClass.SOUND,
-        entity_registry_enabled_default=False,
+        available_during_charging=True,
     ),
     OwletBinarySensorEntityDescription(
         key="low_oxygen_alert",
         translation_key="low_ox_alrt",
         device_class=BinarySensorDeviceClass.SOUND,
+        available_during_charging=True,
+    ),
+    OwletBinarySensorEntityDescription(
+        key="critical_oxygen_alert",
+        translation_key="crit_ox_alrt",
+        device_class=BinarySensorDeviceClass.SOUND,
+        available_during_charging=True,
     ),
     OwletBinarySensorEntityDescription(
         key="low_battery_alert",
         translation_key="low_batt_alrt",
         device_class=BinarySensorDeviceClass.SOUND,
+        available_during_charging=True,
+    ),
+    OwletBinarySensorEntityDescription(
+        key="critical_battery_alert",
+        translation_key="crit_batt_alrt",
+        device_class=BinarySensorDeviceClass.SOUND,
+        available_during_charging=True,
     ),
     OwletBinarySensorEntityDescription(
         key="lost_power_alert",
         translation_key="lost_pwr_alrt",
         device_class=BinarySensorDeviceClass.SOUND,
+        available_during_charging=True,
     ),
     OwletBinarySensorEntityDescription(
         key="sock_disconnected",
         translation_key="sock_discon_alrt",
         device_class=BinarySensorDeviceClass.SOUND,
+        available_during_charging=True,
     ),
     OwletBinarySensorEntityDescription(
         key="sock_off",
         translation_key="sock_off",
         device_class=BinarySensorDeviceClass.POWER,
+        available_during_charging=True,
     ),
     OwletBinarySensorEntityDescription(
-        key="sleep_state",
-        translation_key="awake",
-        icon="mdi:sleep",
+        key="base_station_on",
+        translation_key="base_on",
+        device_class=BinarySensorDeviceClass.POWER,
+        available_during_charging=True,
     ),
 )
 
@@ -86,11 +110,16 @@ async def async_setup_entry(
 
     coordinators: OwletCoordinator = hass.data[DOMAIN][config_entry.entry_id].values()
 
-    async_add_entities(
-        OwletBinarySensor(coordinator, sensor)
-        for coordinator in coordinators
-        for sensor in SENSORS
-    )
+    sensors = []
+    for coordinator in coordinators:
+        for sensor in SENSORS:
+            if sensor.key in coordinator.sock.properties:
+                sensors.append(OwletBinarySensor(coordinator, sensor))
+
+        if OwletAwakeSensor.entity_description.key in coordinator.sock.properties:
+            sensors.append(OwletAwakeSensor(coordinator))
+
+    async_add_entities(sensors)
 
 
 class OwletBinarySensor(OwletBaseEntity, BinarySensorEntity):
@@ -106,20 +135,46 @@ class OwletBinarySensor(OwletBaseEntity, BinarySensorEntity):
         self.entity_description = description
         self._attr_unique_id = f"{self.sock.serial}-{description.key}"
 
+    @property
+    def available(self) -> bool:
+        """Return if entity is available."""
+        return super().available and (
+            not self.sock.properties["charging"]
+            or self.entity_description.available_during_charging
+        )
+
     @property
     def is_on(self) -> bool:
         """Return true if the binary sensor is on."""
-        state = self.sock.properties[self.entity_description.key]
-
-        entity = self.entity_description.key
-
-        if self.sock.properties["charging"] and entity in ["sleep_state"]:
-            return None
-
-        if entity == "sleep_state":
+        if self.entity_description.key == "sleep_state":
+            if self.sock.properties["charging"]:
+                return None
             if state in [8, 15]:
                 state = False
             else:
                 state = True
 
-        return state
+        return self.sock.properties[self.entity_description.key]
+
+
+class OwletAwakeSensor(OwletBinarySensor):
+    """Representation of an Owlet sleep sensor."""
+
+    entity_description = OwletBinarySensorEntityDescription(
+        key="sleep_state",
+        translation_key="awake",
+        icon="mdi:sleep",
+        available_during_charging=False,
+    )
+
+    def __init__(
+        self,
+        coordinator: OwletCoordinator,
+    ) -> None:
+        """Initialize the sensor."""
+        super().__init__(coordinator, self.entity_description)
+
+    @property
+    def is_on(self) -> bool:
+        """Return true if the binary sensor is on."""
+        return False if self.sock.properties[self.entity_description.key] in [8, 15] else True

custom_components/owlet/config_flow.py

@@ -12,7 +12,6 @@ from pyowletapi.exceptions import (
     OwletEmailError,
     OwletPasswordError,
 )
-from pyowletapi.sock import Sock
 import voluptuous as vol
 
 from homeassistant import config_entries, exceptions
@@ -86,10 +85,8 @@ class OwletConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
                     title=user_input[CONF_USERNAME],
                     data={
                         CONF_REGION: user_input[CONF_REGION],
-                        CONF_USERNAME: user_input[CONF_PASSWORD],
-                        CONF_API_TOKEN: token[CONF_API_TOKEN],
-                        CONF_OWLET_EXPIRY: token[CONF_OWLET_EXPIRY],
-                        CONF_OWLET_REFRESH: token[CONF_OWLET_REFRESH],
+                        CONF_USERNAME: user_input[CONF_USERNAME],
+                        **token,
                     },
                     options={CONF_SCAN_INTERVAL: POLLING_INTERVAL},
                 )
@@ -133,9 +130,9 @@ class OwletConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
                         self.reauth_entry, data={**entry_data, **token}
                     )
 
-                await self.hass.config_entries.async_reload(self.reauth_entry.entry_id)
+                    await self.hass.config_entries.async_reload(self.reauth_entry.entry_id)
 
-                return self.async_abort(reason="reauth_successful")
+                    return self.async_abort(reason="reauth_successful")
 
             except OwletPasswordError:
                 errors[CONF_PASSWORD] = "invalid_password"
@@ -168,7 +165,7 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
                 vol.Required(
                     CONF_SCAN_INTERVAL,
                     default=self.config_entry.options.get(CONF_SCAN_INTERVAL),
-                ): vol.All(vol.Coerce(int), vol.Range(min=10)),
+                ): vol.All(vol.Coerce(int), vol.Range(min=5)),
             }
         )
 

custom_components/owlet/const.py

@@ -5,7 +5,7 @@ DOMAIN = "owlet"
 CONF_OWLET_EXPIRY = "expiry"
 CONF_OWLET_REFRESH = "refresh"
 
-SUPPORTED_VERSIONS = [3]
+SUPPORTED_VERSIONS = [2, 3]
 POLLING_INTERVAL = 5
 MANUFACTURER = "Owlet Baby Care"
 SLEEP_STATES = {0: "unknown", 1: "awake", 8: "light_sleep", 15: "deep_sleep"}

custom_components/owlet/coordinator.py

@@ -36,7 +36,7 @@ class OwletCoordinator(DataUpdateCoordinator):
             update_interval=timedelta(seconds=interval),
         )
         self.sock = sock
-        self.config_entry = entry
+        self.config_entry: ConfigEntry = entry
 
     async def _async_update_data(self) -> None:
         """Fetch the data from the device."""

custom_components/owlet/entity.py

@@ -2,7 +2,7 @@
 
 from homeassistant.helpers.entity import Entity
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
-from homeassistant.helpers.entity import DeviceInfo
+from homeassistant.helpers.device_registry import DeviceInfo
 
 from .coordinator import OwletCoordinator
 from .const import DOMAIN, MANUFACTURER
@@ -23,12 +23,12 @@ class OwletBaseEntity(CoordinatorEntity[OwletCoordinator], Entity):
 
     @property
     def device_info(self) -> DeviceInfo:
-        """Return the device info of the device"""
+        """Return the device info of the device."""
         return DeviceInfo(
             identifiers={(DOMAIN, self.sock.serial)},
             name="Owlet Baby Care Sock",
             manufacturer=MANUFACTURER,
             model=self.sock.model,
             sw_version=self.sock.sw_version,
-            hw_version=self.sock.version,
+            hw_version=f"{self.sock.version}r{self.sock.revision}",
         )

custom_components/owlet/manifest.json

@@ -1,11 +1,15 @@
 {
   "domain": "owlet",
   "name": "Owlet Smart Sock",
-  "codeowners": ["@ryanbdclark"],
+  "codeowners": [
+    "@ryanbdclark"
+  ],
   "config_flow": true,
   "documentation": "https://www.home-assistant.io/integrations/owlet",
   "iot_class": "cloud_polling",
   "issue_tracker": "https://github.com/ryanbdclark/owlet/issues",
-  "requirements": ["pyowletapi==2023.7.2"],
-  "version":"2023.8.1"
+  "requirements": [
+    "pyowletapi==2024.6.1"
+  ],
+  "version": "2024.9.1"
 }

custom_components/owlet/sensor.py

@@ -1,4 +1,5 @@
 """Support for Owlet sensors."""
+
 from __future__ import annotations
 
 from dataclasses import dataclass
@@ -25,10 +26,12 @@ from .coordinator import OwletCoordinator
 from .entity import OwletBaseEntity
 
 
-@dataclass
+@dataclass(kw_only=True)
 class OwletSensorEntityDescription(SensorEntityDescription):
     """Represent the owlet sensor entity description."""
 
+    available_during_charging: bool
+
 
 SENSORS: tuple[OwletSensorEntityDescription, ...] = (
     OwletSensorEntityDescription(
@@ -37,6 +40,7 @@ SENSORS: tuple[OwletSensorEntityDescription, ...] = (
         native_unit_of_measurement=PERCENTAGE,
         device_class=SensorDeviceClass.BATTERY,
         state_class=SensorStateClass.MEASUREMENT,
+        available_during_charging=True,
     ),
     OwletSensorEntityDescription(
         key="oxygen_saturation",
@@ -44,13 +48,7 @@ SENSORS: tuple[OwletSensorEntityDescription, ...] = (
         native_unit_of_measurement=PERCENTAGE,
         state_class=SensorStateClass.MEASUREMENT,
         icon="mdi:leaf",
-    ),
-    OwletSensorEntityDescription(
-        key="oxygen_10_av",
-        translation_key="o2saturation10a",
-        native_unit_of_measurement=PERCENTAGE,
-        state_class=SensorStateClass.MEASUREMENT,
-        icon="mdi:leaf",
+        available_during_charging=False,
     ),
     OwletSensorEntityDescription(
         key="heart_rate",
@@ -58,13 +56,14 @@ SENSORS: tuple[OwletSensorEntityDescription, ...] = (
         native_unit_of_measurement="bpm",
         state_class=SensorStateClass.MEASUREMENT,
         icon="mdi:heart-pulse",
+        available_during_charging=False,
     ),
     OwletSensorEntityDescription(
         key="battery_minutes",
         translation_key="batterymin",
         native_unit_of_measurement=UnitOfTime.MINUTES,
         device_class=SensorDeviceClass.DURATION,
-        state_class=SensorStateClass.MEASUREMENT,
+        available_during_charging=False,
     ),
     OwletSensorEntityDescription(
         key="signal_strength",
@@ -72,6 +71,7 @@ SENSORS: tuple[OwletSensorEntityDescription, ...] = (
         native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
         device_class=SensorDeviceClass.SIGNAL_STRENGTH,
         state_class=SensorStateClass.MEASUREMENT,
+        available_during_charging=True,
     ),
     OwletSensorEntityDescription(
         key="skin_temperature",
@@ -79,11 +79,7 @@ SENSORS: tuple[OwletSensorEntityDescription, ...] = (
         native_unit_of_measurement=UnitOfTemperature.CELSIUS,
         device_class=SensorDeviceClass.TEMPERATURE,
         state_class=SensorStateClass.MEASUREMENT,
-    ),
-    OwletSensorEntityDescription(
-        key="sleep_state",
-        translation_key="sleepstate",
-        device_class=SensorDeviceClass.ENUM,
+        available_during_charging=False,
     ),
     OwletSensorEntityDescription(
         key="movement",
@@ -91,6 +87,7 @@ SENSORS: tuple[OwletSensorEntityDescription, ...] = (
         state_class=SensorStateClass.MEASUREMENT,
         icon="mdi:cursor-move",
         entity_registry_enabled_default=False,
+        available_during_charging=False,
     ),
     OwletSensorEntityDescription(
         key="movement_bucket",
@@ -98,6 +95,7 @@ SENSORS: tuple[OwletSensorEntityDescription, ...] = (
         state_class=SensorStateClass.MEASUREMENT,
         icon="mdi:bucket-outline",
         entity_registry_enabled_default=False,
+        available_during_charging=False,
     ),
 )
 
@@ -113,11 +111,19 @@ async def async_setup_entry(
         hass.data[DOMAIN][config_entry.entry_id].values()
     )
 
-    async_add_entities(
-        OwletSensor(coordinator, sensor)
-        for coordinator in coordinators
-        for sensor in SENSORS
-    )
+    sensors = []
+
+    for coordinator in coordinators:
+        for sensor in SENSORS:
+            if sensor.key in coordinator.sock.properties:
+                sensors.append(OwletSensor(coordinator, sensor))
+
+        if OwletSleepSensor.entity_description.key in coordinator.sock.properties:
+            sensors.append(OwletSleepSensor(coordinator))
+        if OwletOxygenAverageSensor.entity_description.key in coordinator.sock.properties:
+            sensors.append(OwletOxygenAverageSensor(coordinator))
+
+    async_add_entities(sensors)
 
 
 class OwletSensor(OwletBaseEntity, SensorEntity):
@@ -133,32 +139,68 @@ class OwletSensor(OwletBaseEntity, SensorEntity):
         self.entity_description: OwletSensorEntityDescription = description
         self._attr_unique_id = f"{self.sock.serial}-{description.key}"
 
+    @property
+    def available(self) -> bool:
+        """Return if entity is available."""
+        return super().available and (
+            not self.sock.properties["charging"]
+            or self.entity_description.available_during_charging
+        )
+
     @property
     def native_value(self) -> StateType:
         """Return sensor value."""
 
-        if (
-            self.entity_description.key
-            in [
-                "heart_rate",
-                "battery_minutes",
-                "oxygen_saturation",
-                "skin_temperature",
-                "oxygen_10_av",
-                "sleep_state",
-            ]
-            and self.sock.properties["charging"]
-        ):
-            return None
-
-        if self.entity_description.key == "sleep_state":
-            return SLEEP_STATES[self.sock.properties["sleep_state"]]
-
         return self.sock.properties[self.entity_description.key]
 
+
+class OwletSleepSensor(OwletSensor):
+    """Representation of an Owlet sleep sensor."""
+
+    _attr_options = list(SLEEP_STATES.values())
+    entity_description = OwletSensorEntityDescription(
+        key="sleep_state",
+        translation_key="sleepstate",
+        device_class=SensorDeviceClass.ENUM,
+        available_during_charging=False,
+    )
+
+    def __init__(
+        self,
+        coordinator: OwletCoordinator,
+    ) -> None:
+        """Initialize the sensor."""
+        super().__init__(coordinator, self.entity_description)
+
     @property
-    def options(self) -> list[str]:
-        """Set options for sleep state."""
-        if self.entity_description.key != "sleep_state":
-            return None
-        return list(SLEEP_STATES.values())
+    def native_value(self) -> StateType:
+        """Return sensor value."""
+        return SLEEP_STATES[self.sock.properties["sleep_state"]]
+
+
+class OwletOxygenAverageSensor(OwletSensor):
+    """Representation of an Owlet sleep sensor."""
+
+    entity_description = OwletSensorEntityDescription(
+        key="oxygen_10_av",
+        translation_key="o2saturation10a",
+        native_unit_of_measurement=PERCENTAGE,
+        icon="mdi:leaf",
+        available_during_charging=False,
+    )
+
+    def __init__(
+        self,
+        coordinator: OwletCoordinator,
+    ) -> None:
+        """Initialize the sensor."""
+        super().__init__(coordinator, self.entity_description)
+
+    @property
+    def available(self) -> bool:
+        """Return if entity is available."""
+        return super().available and (
+            not self.sock.properties["charging"]
+            or self.entity_description.available_during_charging
+        ) and (self.sock.properties["oxygen_10_av"] >= 0 and self.sock.properties["oxygen_10_av"] <= 100)
+

custom_components/owlet/strings.json

@@ -5,13 +5,13 @@
         "data": {
           "region": "Region",
           "username": "Email",
-          "password": "Password"
+          "password": "[%key:common::config_flow::data::password%]"
         }
       },
       "reauth_confirm": {
         "title": "Reauthentiaction required for Owlet",
         "data": {
-          "password": "Password"
+          "password": "[%key:common::config_flow::data::password%]"
         }
       }
     },
@@ -54,20 +54,29 @@
       "low_ox_alrt": {
         "name": "Low oxygen alert"
       },
+      "crit_ox_alrt": {
+        "name": "Critical oxygen alert"
+      },
       "low_batt_alrt": {
         "name": "Low battery alert"
       },
+      "crit_batt_alrt": {
+        "name": "Critical battery alert"
+      },
       "lost_pwr_alrt": {
         "name": "Lost power alert"
       },
       "sock_discon_alrt": {
-        "name": "Sock diconnected alert"
+        "name": "Sock disconnected alert"
       },
       "sock_off": {
         "name": "Sock off"
       },
       "awake": {
         "name": "Awake"
+      },
+      "base_on": {
+        "name": "Base station on"
       }
     },
     "sensor": {

custom_components/owlet/translations/en.json

@@ -1,112 +1,121 @@
 {
-  "config": {
-    "step": {
-      "user": {
-        "data": {
-          "region": "Region",
-          "username": "Email",
-          "password": "Password"
+    "config": {
+        "step": {
+            "user": {
+                "data": {
+                    "region": "Region",
+                    "username": "Email",
+                    "password": "[%key:common::config_flow::data::password%]"
+                }
+            },
+            "reauth_confirm": {
+                "title": "Reauthentiaction required for Owlet",
+                "data": {
+                    "password": "[%key:common::config_flow::data::password%]"
+                }
+            }
+        },
+        "error": {
+            "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
+            "invalid_email": "Entered email address is incorrect",
+            "invalid_password": "Entered password is incorrect",
+            "invalid_credentials": "Entered credentials are incorrect",
+            "unknown": "Unknown error occured"
+        },
+        "abort": {
+            "already_configured": "Device already configured",
+            "reauth_successful": "Reauthentication successful"
         }
-      },
-      "reauth_confirm": {
-        "title": "Reauthentiaction required for Owlet",
-        "data": {
-          "password": "Password"
-        }
-      }
     },
-    "error": {
-      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
-      "invalid_email": "Entered email address is incorrect",
-      "invalid_password": "Entered password is incorrect",
-      "invalid_credentials": "Entered credentials are incorrect",
-      "unknown": "Unknown error occured"
-    },
-    "abort": {
-      "already_configured": "Device already configured",
-      "reauth_successful": "Reauthentication successful"
-    }
-  },
-  "options": {
-    "step": {
-      "init": {
-        "title": "Configure options for Owlet",
-        "data": {
-          "pollinterval": "Polling interval in seconds, min 10"
+    "options": {
+        "step": {
+            "init": {
+                "title": "Configure options for Owlet",
+                "data": {
+                    "pollinterval": "Polling interval in seconds, min 10"
+                }
+            }
         }
-      }
-    }
-  },
-  "entity": {
-    "binary_sensor": {
-      "charging": {
-        "name": "Charging"
-      },
-      "high_hr_alrt": {
-        "name": "High heart rate alert"
-      },
-      "low_hr_alrt": {
-        "name": "Low heart rate alert"
-      },
-      "high_ox_alrt": {
-        "name": "High oxygen alert"
-      },
-      "low_ox_alrt": {
-        "name": "Low oxygen alert"
-      },
-      "low_batt_alrt": {
-        "name": "Low battery alert"
-      },
-      "lost_pwr_alrt": {
-        "name": "Lost power alert"
-      },
-      "sock_discon_alrt": {
-        "name": "Sock diconnected alert"
-      },
-      "sock_off": {
-        "name": "Sock off"
-      },
-      "awake": {
-        "name": "Awake"
-      }
     },
-    "sensor": {
-      "batterypercent": {
-        "name": "Battery percentage"
-      },
-      "signalstrength": {
-        "name": "Signal strength"
-      },
-      "o2saturation": {
-        "name": "O2 saturation"
-      },
-      "o2saturation10a": {
-        "name": "O2 saturation 10 minute average"
-      },
-      "heartrate": {
-        "name": "Heart rate"
-      },
-      "batterymin": {
-        "name": "Battery remaining"
-      },
-      "skintemp": {
-        "name": "Skin temperature"
-      },
-      "sleepstate": {
-        "name": "Sleep state",
-        "state": {
-          "unknown": "Unknown",
-          "awake": "Awake",
-          "light_sleep": "Light sleep",
-          "deep_sleep": "Deep sleep"
+    "entity": {
+        "binary_sensor": {
+            "charging": {
+                "name": "Charging"
+            },
+            "high_hr_alrt": {
+                "name": "High heart rate alert"
+            },
+            "low_hr_alrt": {
+                "name": "Low heart rate alert"
+            },
+            "high_ox_alrt": {
+                "name": "High oxygen alert"
+            },
+            "low_ox_alrt": {
+                "name": "Low oxygen alert"
+            },
+            "crit_ox_alrt": {
+                "name": "Critical oxygen alert"
+            },
+            "low_batt_alrt": {
+                "name": "Low battery alert"
+            },
+            "crit_batt_alrt": {
+                "name": "Critical battery alert"
+            },
+            "lost_pwr_alrt": {
+                "name": "Lost power alert"
+            },
+            "sock_discon_alrt": {
+                "name": "Sock disconnected alert"
+            },
+            "sock_off": {
+                "name": "Sock off"
+            },
+            "awake": {
+                "name": "Awake"
+            },
+            "base_on": {
+                "name": "Base station on"
+            }
+        },
+        "sensor": {
+            "batterypercent": {
+                "name": "Battery percentage"
+            },
+            "signalstrength": {
+                "name": "Signal strength"
+            },
+            "o2saturation": {
+                "name": "O2 saturation"
+            },
+            "o2saturation10a": {
+                "name": "O2 saturation 10 minute average"
+            },
+            "heartrate": {
+                "name": "Heart rate"
+            },
+            "batterymin": {
+                "name": "Battery remaining"
+            },
+            "skintemp": {
+                "name": "Skin temperature"
+            },
+            "sleepstate": {
+                "name": "Sleep state",
+                "state": {
+                    "unknown": "Unknown",
+                    "awake": "Awake",
+                    "light_sleep": "Light sleep",
+                    "deep_sleep": "Deep sleep"
+                }
+            },
+            "movement": {
+                "name": "Movement"
+            },
+            "movementbucket": {
+                "name": "Movement bucket"
+            }
         }
-      },
-      "movement": {
-        "name": "Movement"
-      },
-      "movementbucket": {
-        "name": "Movement bucket"
-      }
     }
-  }
 }

custom_components/owlet/translations/fr.json

@@ -0,0 +1,121 @@
+{
+    "config": {
+        "step": {
+            "user": {
+                "data": {
+                    "region": "Région",
+                    "username": "Email",
+                    "password": "[%key:common::config_flow::data::password%]"
+                }
+            },
+            "reauth_confirm": {
+                "title": "Réauthentification requise pour Owlet",
+                "data": {
+                    "password": "[%key:common::config_flow::data::password%]"
+                }
+            }
+        },
+        "error": {
+            "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
+            "invalid_email": "L'adresse e-mail saisie est incorrecte",
+            "invalid_password": "Le mot de passe saisi est incorrect",
+            "invalid_credentials": "Les informations d'identification saisies sont incorrectes",
+            "unknown": "Une erreur inconnue est survenue"
+        },
+        "abort": {
+            "already_configured": "Appareil déjà configuré",
+            "reauth_successful": "Réauthentification réussie"
+        }
+    },
+    "options": {
+        "step": {
+            "init": {
+                "title": "Configurer les options pour Owlet",
+                "data": {
+                    "pollinterval": "Intervalle de sondage en secondes, minimum 10"
+                }
+            }
+        }
+    },
+    "entity": {
+        "binary_sensor": {
+            "charging": {
+                "name": "En charge"
+            },
+            "high_hr_alrt": {
+                "name": "Alerte fréquence cardiaque élevée"
+            },
+            "low_hr_alrt": {
+                "name": "Alerte fréquence cardiaque basse"
+            },
+            "high_ox_alrt": {
+                "name": "Alerte oxygène élevé"
+            },
+            "low_ox_alrt": {
+                "name": "Alerte oxygène faible"
+            },
+            "crit_ox_alrt": {
+                "name": "Alerte oxygène critique"
+            },
+            "low_batt_alrt": {
+                "name": "Alerte batterie faible"
+            },
+            "crit_batt_alrt": {
+                "name": "Alerte batterie critique"
+            },
+            "lost_pwr_alrt": {
+                "name": "Alerte perte d'alimentation"
+            },
+            "sock_discon_alrt": {
+                "name": "Alerte chaussette déconnectée"
+            },
+            "sock_off": {
+                "name": "Chaussette retirée"
+            },
+            "awake": {
+                "name": "Réveillé"
+            },
+            "base_on": {
+                "name": "Station de base allumée"
+            }
+        },
+        "sensor": {
+            "batterypercent": {
+                "name": "Pourcentage de batterie"
+            },
+            "signalstrength": {
+                "name": "Force du signal"
+            },
+            "o2saturation": {
+                "name": "Saturation O2"
+            },
+            "o2saturation10a": {
+                "name": "Moyenne de saturation O2 sur 10 minutes"
+            },
+            "heartrate": {
+                "name": "Fréquence cardiaque"
+            },
+            "batterymin": {
+                "name": "Autonomie de la batterie restante"
+            },
+            "skintemp": {
+                "name": "Température de la peau"
+            },
+            "sleepstate": {
+                "name": "État de sommeil",
+                "state": {
+                    "unknown": "Inconnu",
+                    "awake": "Réveillé",
+                    "light_sleep": "Sommeil léger",
+                    "deep_sleep": "Sommeil profond"
+                }
+            },
+            "movement": {
+                "name": "Mouvement"
+            },
+            "movementbucket": {
+                "name": "Seuil de mouvement"
+            }
+        }
+    }
+}

custom_components/owlet/translations/uk.json

@@ -5,13 +5,13 @@
         "data": {
           "region": "Region",
           "username": "Email",
-          "password": "Password"
+          "password": "[%key:common::config_flow::data::password%]"
         }
       },
       "reauth_confirm": {
         "title": "Reauthentiaction required for Owlet",
         "data": {
-          "password": "Password"
+          "password": "[%key:common::config_flow::data::password%]"
         }
       }
     },
@@ -54,20 +54,29 @@
       "low_ox_alrt": {
         "name": "Low oxygen alert"
       },
+      "crit_ox_alrt": {
+        "name": "Critical oxygen alert"
+      },
       "low_batt_alrt": {
         "name": "Low battery alert"
       },
+      "crit_batt_alrt": {
+        "name": "Critical battery alert"
+      },
       "lost_pwr_alrt": {
         "name": "Lost power alert"
       },
       "sock_discon_alrt": {
-        "name": "Sock diconnected alert"
+        "name": "Sock disconnected alert"
       },
       "sock_off": {
         "name": "Sock off"
       },
       "awake": {
         "name": "Awake"
+      },
+      "base_on": {
+        "name": "Base station on"
       }
     },
     "sensor": {

hacs.json

@@ -1,7 +1,7 @@
 {
   "name": "Owlet",
   "hacs": "1.32.1",
-  "homeassistant": "2023.04.1",
+  "homeassistant": "2024.1",
   "zip_release": true,
   "filename": "owlet.zip"
 }

info.md

@@ -8,9 +8,7 @@
 [![hacs][hacsbadge]][hacs]
 [![Project Maintenance][maintenance-shield]][user_profile]
 
-A custom component for the Owlet smart sock, currently this only supports the owlet smart sock 3.
-
-If you have a smart sock 2 and would like to contribute then please do so.
+A custom component for the Owlet smart sock
 
 ## Installation
 

tests/test_binary_sensor.py

@@ -0,0 +1,188 @@
+"""Test Owlet Sensor."""
+from __future__ import annotations
+
+from homeassistant.core import HomeAssistant
+
+from . import async_init_integration
+
+
+async def test_sensors_asleep(hass: HomeAssistant) -> None:
+    """Test sensor values."""
+    await async_init_integration(
+        hass, properties_fixture="update_properties_asleep.json"
+    )
+
+    assert len(hass.states.async_all("binary_sensor")) == 10
+
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_charging").state == "off"
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_high_heart_rate_alert"
+        ).state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_heart_rate_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_high_oxygen_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_oxygen_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_battery_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_lost_power_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_sock_disconnected_alert"
+        ).state
+        == "off"
+    )
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_sock_off").state == "off"
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_awake").state == "off"
+
+
+async def test_sensors_awake(hass: HomeAssistant) -> None:
+    """Test sensor values."""
+    await async_init_integration(
+        hass, properties_fixture="update_properties_awake.json"
+    )
+
+    assert len(hass.states.async_all("binary_sensor")) == 10
+
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_charging").state == "off"
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_high_heart_rate_alert"
+        ).state
+        == "on"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_heart_rate_alert").state
+        == "on"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_high_oxygen_alert").state
+        == "on"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_oxygen_alert").state
+        == "on"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_battery_alert").state
+        == "on"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_lost_power_alert").state
+        == "on"
+    )
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_sock_disconnected_alert"
+        ).state
+        == "off"
+    )
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_sock_off").state == "off"
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_awake").state == "on"
+
+
+async def test_sensors_charging(hass: HomeAssistant) -> None:
+    """Test sensor values."""
+    await async_init_integration(
+        hass, properties_fixture="update_properties_charging.json"
+    )
+
+    assert len(hass.states.async_all("binary_sensor")) == 10
+
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_charging").state == "on"
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_high_heart_rate_alert"
+        ).state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_heart_rate_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_high_oxygen_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_oxygen_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_battery_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_lost_power_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_sock_disconnected_alert"
+        ).state
+        == "off"
+    )
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_sock_off").state == "off"
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_awake").state == "unknown"
+    )
+
+
+async def test_sensors_v2(hass: HomeAssistant) -> None:
+    """Test sensor values."""
+    await async_init_integration(hass, properties_fixture="update_properties_v2.json")
+    assert len(hass.states.async_all("binary_sensor")) == 9
+
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_charging").state == "off"
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_high_heart_rate_alert"
+        ).state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_heart_rate_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_oxygen_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get("binary_sensor.owlet_baby_care_sock_low_battery_alert").state
+        == "off"
+    )
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_critical_battery_alert"
+        ).state
+        == "off"
+    )
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_critical_oxygen_alert"
+        ).state
+        == "off"
+    )
+    assert (
+        hass.states.get(
+            "binary_sensor.owlet_baby_care_sock_sock_disconnected_alert"
+        ).state
+        == "off"
+    )
+    assert hass.states.get("binary_sensor.owlet_baby_care_sock_sock_off").state == "off"

tests/test_config_flow.py

@@ -70,7 +70,7 @@ async def test_flow_wrong_password(hass: HomeAssistant) -> None:
             user_input=CONF_INPUT,
         )
         assert result["type"] == FlowResultType.FORM
-        assert result["errors"] == {"base": "invalid_password"}
+        assert result["errors"] == {"password": "invalid_password"}
 
 
 async def test_flow_wrong_email(hass: HomeAssistant) -> None:
@@ -88,7 +88,7 @@ async def test_flow_wrong_email(hass: HomeAssistant) -> None:
             user_input=CONF_INPUT,
         )
         assert result["type"] == FlowResultType.FORM
-        assert result["errors"] == {"base": "invalid_email"}
+        assert result["errors"] == {"username": "invalid_email"}
 
 
 async def test_flow_credentials_error(hass: HomeAssistant) -> None:
@@ -193,7 +193,7 @@ async def test_reauth_invalid_password(hass: HomeAssistant) -> None:
 
         assert result["type"] == FlowResultType.FORM
         assert result["step_id"] == "reauth_confirm"
-        assert result["errors"] == {"base": "invalid_password"}
+        assert result["errors"] == {"password": "invalid_password"}
 
 
 async def test_reauth_unknown_error(hass: HomeAssistant) -> None:

tests/test_init.py

@@ -43,7 +43,7 @@ async def test_async_setup_entry(hass: HomeAssistant) -> None:
 
     entities = er.async_entries_for_device(entity_registry, device_entry.id)
 
-    assert len(entities) == 8
+    assert len(entities) == 18
 
     await entry.async_unload(hass)
 

tests/test_sensor.py

@@ -107,3 +107,20 @@ async def test_sensors_charging(hass: HomeAssistant) -> None:
         == "unknown"
     )
     assert hass.states.get("sensor.owlet_baby_care_sock_sleep_state").state == "unknown"
+
+
+async def test_sensors_v2(hass: HomeAssistant) -> None:
+    """Test sensor values."""
+    await async_init_integration(hass, properties_fixture="update_properties_v2.json")
+    assert len(hass.states.async_all("sensor")) == 4
+
+    assert (
+        hass.states.get("sensor.owlet_baby_care_sock_battery_percentage").state == "29"
+    )
+    assert hass.states.get("sensor.owlet_baby_care_sock_heart_rate").state == "145"
+    assert hass.states.get("sensor.owlet_baby_care_sock_o2_saturation").state == "99"
+
+    assert (
+        hass.states.get("sensor.owlet_baby_care_sock_signal_strength").state == "98.0"
+    )
+