add lightSensor typing and endpoints

Author: lpgera

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ## [Unreleased](https://github.com/lpgera/dirigera/compare/v1.1.0...HEAD)
 
--
+- Add support for VALLHORN's light sensor functionality by introducing the `client.lightSensors` API and the
+  `LightSensor` type, including the `illuminance` attribute.
 
 ## [1.1.0](https://github.com/lpgera/dirigera/compare/v1.0.0...v1.1.0) - 2024-10-02
 

README.md

@@ -20,6 +20,7 @@ contributions are welcome!
     - [Controllers](#controllers)
     - [Environment sensors](#environment-sensors)
     - [Lights](#lights)
+    - [Light sensors](#light-sensors)
     - [Motion sensors](#motion-sensors)
     - [Outlets](#outlets)
     - [Open/close sensors](#openclose-sensors)
@@ -283,9 +284,21 @@ await client.lights.setStartupOnOff({
 })
 ```
 
-#### [Motion sensors](./src/api/motionSensors.ts)
+#### [Light sensors](./src/api/lightSensors.ts)
 
-Not tested, feedback required.
+The VALLHORN motion sensor has a light sensor built-in.
+
+```typescript
+const lightSensors = await client.lightSensors.list()
+
+const lightSensor = await client.lightSensors.get({
+  id: 'YOUR_DEVICE_ID',
+})
+
+const { illuminance } = lightSensor.attributes
+```
+
+#### [Motion sensors](./src/api/motionSensors.ts)
 
 ```typescript
 const motionSensors = await client.motionSensors.list()

src/api/lightSensors.ts

@@ -0,0 +1,22 @@
+import type { Got } from 'got' with { 'resolution-mode': 'require' }
+import type { Device } from '../types/device/Device'
+import type { LightSensor } from '../types/device/LightSensor'
+
+export default (got: Got) => {
+  return {
+    async list() {
+      const devices = await got.get(`devices`).json<Device[]>()
+      return devices.filter(
+        (d): d is LightSensor => d.deviceType === 'lightSensor'
+      )
+    },
+
+    async get({ id }: { id: string }) {
+      const device = await got.get(`devices/${id}`).json<Device>()
+      if (device.deviceType !== 'lightSensor') {
+        throw new Error('The requested device is not a lightSensor')
+      }
+      return device as LightSensor
+    },
+  }
+}

src/index.ts

@@ -18,6 +18,7 @@ import blinds from './api/blinds'
 import airPurifiers from './api/airPurifiers'
 import repeaters from './api/repeaters'
 import motionSensors from './api/motionSensors'
+import lightSensors from './api/lightSensors'
 import environmentSensors from './api/environmentSensors'
 import openCloseSensors from './api/openCloseSensors'
 import deviceSets from './api/deviceSets'
@@ -37,6 +38,7 @@ export type { EnvironmentSensor } from './types/device/EnvironmentSensor'
 export type { Home } from './types/Home'
 export type { Hub } from './types/device/Hub'
 export type { Light } from './types/device/Light'
+export type { LightSensor } from './types/device/LightSensor'
 export type { MotionSensor } from './types/device/MotionSensor'
 export type { Music } from './types/Music'
 export type { OpenCloseSensor } from './types/device/OpenCloseSensor'
@@ -182,6 +184,7 @@ export async function createDirigeraClient({
     airPurifiers: airPurifiers(gotInstance),
     repeaters: repeaters(gotInstance),
     motionSensors: motionSensors(gotInstance),
+    lightSensors: lightSensors(gotInstance),
     environmentSensors: environmentSensors(gotInstance),
     openCloseSensors: openCloseSensors(gotInstance),
     deviceSets: deviceSets(gotInstance),

src/types/device/Device.ts

@@ -7,6 +7,7 @@ import type { Controller } from './Controller'
 import type { EnvironmentSensorAttributes } from './EnvironmentSensor'
 import type { HubAttributes } from './Hub'
 import type { LightAttributes } from './Light'
+import type { LightSensorAttributes } from './LightSensor'
 import type { MotionSensorAttributes } from './MotionSensor'
 import type { OpenCloseSensorAttributes } from './OpenCloseSensor'
 import type { OutletAttributes } from './Outlet'
@@ -61,10 +62,11 @@ export interface Device {
     | 'controller'
     | 'gateway'
     | 'light'
-    | 'sensor'
     | 'outlet'
     | 'repeater'
+    | 'sensor'
     | 'speaker'
+    | 'unknown'
   deviceType:
     | 'airPurifier'
     | 'blinds'
@@ -75,6 +77,7 @@ export interface Device {
     | 'blindsController'
     | 'gateway'
     | 'light'
+    | 'lightSensor'
     | 'motionSensor'
     | 'openCloseSensor'
     | 'outlet'
@@ -93,6 +96,7 @@ export interface Device {
     Partial<EnvironmentSensorAttributes> &
     Partial<HubAttributes> &
     Partial<LightAttributes> &
+    Partial<LightSensorAttributes> &
     Partial<MotionSensorAttributes> &
     Partial<OpenCloseSensorAttributes> &
     Partial<OutletAttributes> &

src/types/device/LightSensor.ts

@@ -0,0 +1,20 @@
+import type {
+  CommonDeviceAttributes,
+  Device,
+  IdentifiableDeviceAttributes,
+  JoinableDeviceAttributes,
+} from './Device'
+
+export interface LightSensorAttributes
+  extends CommonDeviceAttributes,
+    JoinableDeviceAttributes,
+    Partial<IdentifiableDeviceAttributes> {
+  illuminance: number
+}
+
+export interface LightSensor extends Device {
+  type: 'unknown'
+  deviceType: 'lightSensor'
+  attributes: LightSensorAttributes
+  isHidden: boolean
+}

test/responses/home.ts

@@ -9,6 +9,7 @@ import {
 } from './controller'
 import { environmentSensor } from './environmentSensor'
 import { colorTemperatureLight, dimmableLight, rgbLight } from './light'
+import { lightSensor } from './lightSensor'
 import { motionSensor1, motionSensor2 } from './motionSensor'
 import { outlet1, outlet2 } from './outlet'
 import { repeater } from './repeater'
@@ -31,6 +32,7 @@ const home: Home = {
     rgbLight,
     colorTemperatureLight,
     dimmableLight,
+    lightSensor,
     motionSensor1,
     motionSensor2,
     outlet1,

test/responses/lightSensor.ts

@@ -0,0 +1,31 @@
+import { LightSensor } from '../../src/types/device/LightSensor'
+
+export const lightSensor: LightSensor = {
+  id: '00000000-0000-0000-0000-000000000000',
+  relationId: '00000000-0000-0000-0000-000000000000',
+  type: 'unknown',
+  deviceType: 'lightSensor',
+  createdAt: '2000-01-01T00:00:00.000Z',
+  isReachable: true,
+  lastSeen: '2000-01-01T00:00:00.000Z',
+  attributes: {
+    customName: '',
+    firmwareVersion: '1.0.64',
+    hardwareVersion: '1',
+    manufacturer: 'IKEA of Sweden',
+    model: 'VALLHORN Wireless Motion Sensor',
+    productCode: 'E2134',
+    serialNumber: '00000000-0000-0000-0000-000000000000',
+    illuminance: 1,
+    identifyPeriod: 0,
+    identifyStarted: '2000-01-01T00:00:00.000Z',
+    permittingJoin: false,
+  },
+  capabilities: {
+    canSend: [],
+    canReceive: ['customName'],
+  },
+  deviceSet: [],
+  remoteLinks: [],
+  isHidden: false,
+}