drivers: Standardize read and measurement method naming.

Author: nedseb

README.md

@@ -250,7 +250,7 @@ i2c = machine.I2C(1)
 apds = APDS9960(i2c)
 
 apds.enable_light_sensor()
-light = apds.read_ambient_light()
+light = apds.ambient_light()
 
 ```
 
@@ -476,6 +476,7 @@ lib/<component>/
 - **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 (private), `data_ready()` returns True when all channels have new data, `<measurement>_ready()` for per-channel readiness (e.g. `temperature_ready()`, `pressure_ready()`).
+- **Measurement methods**: bare noun for the main unit (`temperature()`, `humidity()`, `pressure()`), `read()` for combined reading returning a tuple, `<measurement>_raw()` for raw register values. No `read_` prefix on individual measurements.
 
 ### Linting
 

lib/apds9960/apds9960/device.py

@@ -169,7 +169,7 @@ def is_gesture_available(self):
         return val == APDS9960_BIT_GVALID
 
     # processes a gesture event and returns best guessed gesture
-    def read_gesture(self):
+    def gesture(self):
         fifo_level = 0
         fifo_data = []
 
@@ -258,7 +258,7 @@ def _ensure_proximity_enabled(self):
             raise OSError("APDS9960 proximity data ready timeout")
 
     # reads the ambient (clear) light level as a 16-bit value
-    def read_ambient_light(self):
+    def ambient_light(self):
         self._ensure_light_enabled()
         # read value from clear channel, low byte register
         low = self._read_reg(APDS9960_REG_CDATAL)
@@ -269,7 +269,7 @@ def read_ambient_light(self):
         return low + (high << 8)
 
     # reads the red light level as a 16-bit value
-    def read_red_light(self):
+    def red_light(self):
         self._ensure_light_enabled()
         # read value from red channel, low byte register
         low = self._read_reg(APDS9960_REG_RDATAL)
@@ -280,7 +280,7 @@ def read_red_light(self):
         return low + (high << 8)
 
     # reads the green light level as a 16-bit value
-    def read_green_light(self):
+    def green_light(self):
         self._ensure_light_enabled()
         # read value from green channel, low byte register
         low = self._read_reg(APDS9960_REG_GDATAL)
@@ -291,7 +291,7 @@ def read_green_light(self):
         return low + (high << 8)
 
     # reads the blue light level as a 16-bit value
-    def read_blue_light(self):
+    def blue_light(self):
         self._ensure_light_enabled()
         # read value from blue channel, low byte register
         low = self._read_reg(APDS9960_REG_BDATAL)
@@ -306,7 +306,7 @@ def read_blue_light(self):
     # *******************************************************************************
 
     # reads the proximity level as an 8-bit value
-    def read_proximity(self):
+    def proximity(self):
         self._ensure_proximity_enabled()
         return self._read_reg(APDS9960_REG_PDATA)
 

lib/apds9960/examples/ambient_light.py

@@ -15,7 +15,7 @@
 oval = -1
 while True:
     sleep(0.25)
-    val = apds.read_ambient_light()
+    val = apds.ambient_light()
     if val != oval:
         print("AmbientLight={}".format(val))
         oval = val

lib/apds9960/examples/gesture.py

@@ -36,5 +36,5 @@
 while True:
     sleep(0.5)
     if apds.is_gesture_available():
-        motion = apds.read_gesture()
+        motion = apds.gesture()
         print("Gesture={}".format(dirs.get(motion, "unknown")))

lib/apds9960/examples/proximity.py

@@ -17,7 +17,7 @@
 oval = -1
 while True:
     sleep(0.25)
-    val = apds.read_proximity()
+    val = apds.proximity()
     if val != oval:
         print("proximity={}".format(val))
         oval = val

lib/hts221/hts221/device.py

@@ -193,7 +193,3 @@ def calibrate_temperature(self, ref_low, measured_low, ref_high, measured_high):
             raise ValueError("measured_low and measured_high must differ")
         self._temp_gain = float(ref_high - ref_low) / delta
         self._temp_offset = float(ref_low) - self._temp_gain * float(measured_low)
-
-    def get(self):
-        h, t = self.read()
-        return [h, t]

lib/lis2mdl/README.md

@@ -181,7 +181,7 @@ Expected value: `0x40`
 ### Read temperature (approximate)
 
 ```python
-print("Temperature (°C):", mag.read_temperature_c())
+print("Temperature (°C):", mag.temperature())
 ```
 
 ### Check data readiness
@@ -209,7 +209,7 @@ print("Register dump:", regs)
 | `read_magnet_calibrated_norm()`    | Calibrated and normalized data |
 | `heading_flat_only()`              | Flat compass heading           |
 | `heading_with_tilt_compensation()` | Tilt-corrected heading         |
-| `read_temperature_c()`             | Read relative temperature      |
+| `temperature()`             | Read relative temperature      |
 | `power_on()` / `power_off()`      | Power management               |
 | `soft_reset()` / `reboot()`        | Sensor reset functions         |
 

lib/lis2mdl/examples/magnet_test.py

@@ -281,9 +281,9 @@ def test_reads(dev):
     ok &= ok_cal_rng
 
     # TEMP
-    t1 = dev.read_temperature_c()
+    t1 = dev.temperature()
     sleep_ms(50)
-    t2 = dev.read_temperature_c()
+    t2 = dev.temperature()
     print(f"TempC: t1={t1:.2f}°C, t2={t2:.2f}°C (8 LSB/°C, absolute offset unknown)")
     # test: type & broad plausible range
     ok_temp = (

lib/lis2mdl/lis2mdl/device.py

@@ -249,7 +249,7 @@ def read_temperature_raw(self) -> int:
         v = (hi << 8) | lo
         return v - 0x10000 if (v & 0x8000) else v
 
-    def read_temperature_c(self) -> float:
+    def temperature(self) -> float:
         """Temperature in °C (8 LSB/°C + empirical offset).
 
         The LIS2MDL temperature sensor has no guaranteed absolute zero
@@ -330,7 +330,7 @@ def read_all(self) -> dict:
         raw = self.read_magnet_raw()
         mag_ut = self.read_magnet_uT()
         cal = self.read_magnet_calibrated_norm()
-        temp = self.read_temperature_c()
+        temp = self.temperature()
         st = self._status()
         return {"raw": raw, "uT": mag_ut, "cal_norm": cal, "tempC": temp, "status": st}
 

tests/scenarios/apds9960.yaml

@@ -69,19 +69,19 @@ tests:
 
   - name: "Read ambient light returns expected value"
     action: call
-    method: read_ambient_light
+    method: ambient_light
     expect: 256
     mode: [mock]
 
   - name: "Read proximity returns expected value"
     action: call
-    method: read_proximity
+    method: proximity
     expect: 80
     mode: [mock]
 
   - name: "Read red light returns expected value"
     action: call
-    method: read_red_light
+    method: red_light
     expect: 128
     mode: [mock]
 
@@ -92,7 +92,7 @@ tests:
     script: |
       dev.disable_light_sensor()
       i2c.clear_write_log()
-      dev.read_ambient_light()
+      dev.ambient_light()
       log = i2c.get_write_log()
       wrote_enable = any(reg == 0x80 for reg, data in log)
       enable_val = dev.get_mode()
@@ -107,7 +107,7 @@ tests:
     script: |
       dev.disable_proximity_sensor()
       i2c.clear_write_log()
-      dev.read_proximity()
+      dev.proximity()
       log = i2c.get_write_log()
       wrote_enable = any(reg == 0x80 for reg, data in log)
       enable_val = dev.get_mode()
@@ -122,7 +122,7 @@ tests:
     script: |
       dev.power_off()
       i2c.clear_write_log()
-      dev.read_red_light()
+      dev.red_light()
       log = i2c.get_write_log()
       wrote_enable = any(reg == 0x80 for reg, data in log)
       enable_val = dev.get_mode()
@@ -137,7 +137,7 @@ tests:
     script: |
       dev.enable_light_sensor(False)
       i2c.clear_write_log()
-      dev.read_ambient_light()
+      dev.ambient_light()
       log = i2c.get_write_log()
       result = len(log) == 0
     expect_true: true
@@ -147,23 +147,23 @@ tests:
 
   - name: "Ambient light in plausible range"
     action: call
-    method: read_ambient_light
+    method: ambient_light
     expect_range: [1, 65535]
     mode: [hardware]
 
   - name: "Proximity in plausible range"
     action: call
-    method: read_proximity
+    method: proximity
     expect_range: [0, 255]
     mode: [hardware]
 
   - name: "Light and proximity values feel correct"
     action: manual
     display:
-      - method: read_ambient_light
+      - method: ambient_light
         label: "Ambient light"
         unit: ""
-      - method: read_proximity
+      - method: proximity
         label: "Proximity"
         unit: ""
     prompt: "Les valeurs de lumière ambiante et de proximité sont-elles cohérentes ?"