drivers: Standardize status and data ready method naming.

Author: nedseb

README.md

@@ -475,6 +475,7 @@ lib/<component>/
 - **Device identification**: `device_id()` — returns the device/WHO_AM_I register value. All I2C drivers with an ID register must implement this method.
 - **Reset methods**: `reset()` for hardware reset (pin toggle), `soft_reset()` for software reset (register write), `reboot()` for memory reboot (reload trimming).
 - **Power methods**: `power_on()` / `power_off()`. All drivers must implement both.
+- **Status methods**: `status()` returns the raw status register as an int, `data_ready()` returns True when all channels have new data, `<measurement>_ready()` for per-channel readiness (e.g. `temperature_ready()`, `pressure_ready()`).
 
 ### Linting
 

lib/apds9960/apds9960/device.py

@@ -82,6 +82,12 @@ def __init__(self, i2c, address=APDS9960_I2C_ADDR, valid_id=APDS9960_DEV_ID):
     def device_id(self):
         return self.dev_id
 
+    def status(self):
+        return self._read_reg(APDS9960_REG_STATUS)
+
+    def data_ready(self):
+        return self.light_ready() and self.proximity_ready()
+
     def get_mode(self):
         return self._read_reg(APDS9960_REG_ENABLE)
 
@@ -225,15 +231,15 @@ def power_off(self):
     # *******************************************************************************
 
     # check if there is new light data available
-    def is_light_available(self):
+    def light_ready(self):
         val = self._read_reg(APDS9960_REG_STATUS)
 
-        # shift and mask out AVALID bit
+        # mask out AVALID bit
         val &= APDS9960_BIT_AVALID
 
         return val == APDS9960_BIT_AVALID
 
-    def is_proximity_available(self):
+    def proximity_ready(self):
         val = self._read_reg(APDS9960_REG_STATUS)
         return (val & APDS9960_BIT_PVALID) == APDS9960_BIT_PVALID
 
@@ -242,7 +248,7 @@ def _ensure_light_enabled(self):
         if not (enable & (1 << APDS9960_MODE_AMBIENT_LIGHT)) or not (enable & APDS9960_BIT_PON):
             self.enable_light_sensor(interrupts=False)
             for _ in range(50):
-                if self.is_light_available():
+                if self.light_ready():
                     return
                 sleep_ms(10)
             raise OSError("APDS9960 light data ready timeout")
@@ -252,7 +258,7 @@ def _ensure_proximity_enabled(self):
         if not (enable & (1 << APDS9960_MODE_PROXIMITY)) or not (enable & APDS9960_BIT_PON):
             self.enable_proximity_sensor(interrupts=False)
             for _ in range(50):
-                if self.is_proximity_available():
+                if self.proximity_ready():
                     return
                 sleep_ms(10)
             raise OSError("APDS9960 proximity data ready timeout")

lib/hts221/hts221/device.py

@@ -64,6 +64,16 @@ def device_id(self):
     def status(self):
         return self._read_reg(HTS221_STATUS_REG)
 
+    def data_ready(self):
+        s = self.status()
+        return bool((s & HTS221_STATUS_T_DA) and (s & HTS221_STATUS_H_DA))
+
+    def temperature_ready(self):
+        return bool(self.status() & HTS221_STATUS_T_DA)
+
+    def humidity_ready(self):
+        return bool(self.status() & HTS221_STATUS_H_DA)
+
     # power control
     def power_off(self):
         t = self._read_reg(HTS221_CTRL_REG1) & 0x7F

lib/ism330dl/ism330dl/device.py

@@ -252,12 +252,20 @@ def motion(self):
     # --------------------------------------------------
 
     def status(self):
+        return self._read_u8(REG_STATUS_REG)
+
+    def accel_ready(self):
+        return bool(self.status() & STATUS_XLDA)
+
+    def gyro_ready(self):
+        return bool(self.status() & STATUS_GDA)
+
+    def temperature_ready(self):
+        return bool(self.status() & STATUS_TDA)
+
+    def data_ready(self):
         s = self._read_u8(REG_STATUS_REG)
-        return {
-            "temp_ready": bool(s & STATUS_TDA),
-            "gyro_ready": bool(s & STATUS_GDA),
-            "accel_ready": bool(s & STATUS_XLDA),
-        }
+        return bool((s & STATUS_XLDA) and (s & STATUS_GDA) and (s & STATUS_TDA))
 
     # --------------------------------------------------
     # Power

lib/lis2mdl/examples/magnet_test.py

@@ -239,7 +239,7 @@ def test_reads(dev):
     ok &= who == 0x40
 
     # STATUS & DATA READY
-    st1 = dev.read_status()
+    st1 = dev.status()
     print(f"Initial STATUS=0x{st1:02X}")
     # wait a few ms to let a new frame arrive
     sleep_ms(50)

lib/lis2mdl/lis2mdl/device.py

@@ -182,13 +182,13 @@ def read_magnet_raw(self):
         """Reads the raw magnetic field (LSB). Same as read_magnet(), but more explicit."""
         return self.read_magnet()  # (x,y,z) int16 LSB
 
-    def read_status(self) -> int:
+    def status(self) -> int:
         """Reads STATUS_REG (0x67)."""
         return self._read_reg(LIS2MDL_STATUS_REG)
 
     def data_ready(self) -> bool:
         """True if a new XYZ triplet is ready (Zyxda bit)."""
-        return bool(self.read_status() & (1 << 3))
+        return bool(self.status() & (1 << 3))
 
     def read_int_source(self) -> int:
         """Reads INT_SOURCE_REG (0x64): source of the interrupt."""
@@ -331,7 +331,7 @@ def read_all(self) -> dict:
         mag_ut = self.read_magnet_uT()
         cal = self.read_magnet_calibrated_norm()
         temp = self.read_temperature_c()
-        st = self.read_status()
+        st = self.status()
         return {"raw": raw, "uT": mag_ut, "cal_norm": cal, "tempC": temp, "status": st}
 
     ##

lib/vl53l1x/vl53l1x/device.py

@@ -147,7 +147,7 @@ def start_ranging(self):
     def stop_ranging(self):
         self._write_reg(0x0087, 0x00)
 
-    def _is_data_ready(self):
+    def data_ready(self):
         polarity = self._read_reg(0x0030) & 0x10
         ready_val = 1 if polarity == 0 else 0
         return (self._read_reg(0x0031) & 0x01) == ready_val
@@ -156,10 +156,10 @@ def _clear_interrupt(self):
         self._write_reg(0x0086, 0x01)
 
     def _ensure_data(self):
-        if not self._is_data_ready():
+        if not self.data_ready():
             self.start_ranging()
             for _ in range(100):
-                if self._is_data_ready():
+                if self.data_ready():
                     return
                 machine.lightsleep(10)
             raise OSError("VL53L1X data ready timeout")

lib/wsen-pads/examples/test.py

@@ -230,14 +230,14 @@ def test_status_flags(sensor):
         sleep(1.5)
 
         status = sensor.status()
-        p_avail = sensor.pressure_available()
-        t_avail = sensor.temperature_available()
-        ready = sensor.is_ready()
+        p_avail = sensor.pressure_ready()
+        t_avail = sensor.temperature_ready()
+        ready = sensor.data_ready()
 
         print("STATUS                = 0x{:02X}".format(status))
-        print("pressure_available()  =", p_avail)
-        print("temperature_available() =", t_avail)
-        print("is_ready()            =", ready)
+        print("pressure_ready()      =", p_avail)
+        print("temperature_ready()   =", t_avail)
+        print("data_ready()          =", ready)
 
         sensor.power_off()
 

lib/wsen-pads/wsen_pads/device.py

@@ -159,15 +159,15 @@ def status(self):
         """Return the raw STATUS register value."""
         return self._read_reg(REG_STATUS)
 
-    def pressure_available(self):
+    def pressure_ready(self):
         """Return True when new pressure data is available."""
         return bool(self.status() & STATUS_P_DA)
 
-    def temperature_available(self):
+    def temperature_ready(self):
         """Return True when new temperature data is available."""
         return bool(self.status() & STATUS_T_DA)
 
-    def is_ready(self):
+    def data_ready(self):
         """
         Return True when both pressure and temperature data are available.
 

tests/scenarios/hts221.yaml

@@ -79,11 +79,26 @@ tests:
     expect_range: [10.0, 90.0]
     mode: [hardware]
 
-  - name: "Status register has data ready"
-    action: call
-    method: status
-    expect_not_none: true
-    mode: [mock, hardware]
+  - name: "Status register returns int"
+    action: script
+    script: |
+      result = isinstance(dev.status(), int)
+    expect_true: true
+    mode: [mock]
+
+  - name: "Data ready when both channels ready"
+    action: script
+    script: |
+      result = dev.data_ready()
+    expect_true: true
+    mode: [mock]
+
+  - name: "Per-channel ready methods work"
+    action: script
+    script: |
+      result = dev.temperature_ready() and dev.humidity_ready()
+    expect_true: true
+    mode: [mock]
 
   - name: "Auto-trigger temperature after power_off"
     action: call