node-hue-api/src/api/Sensors.ts

Philips Hue API Library for Node.js

import { ApiDefinition } from './http/ApiDefinition';
import { model } from '@peter-murray/hue-bridge-model';
import { KeyValueType } from '../commonTypes';

import { SensorIdResult, sensorsApi } from './http/endpoints/sensors';
import { Api } from './Api';

type Sensor = model.Sensor
type SensorId = string | Sensor

type CLIPSensor =
  model.CLIPGenericFlag
  | model.CLIPGenericStatus
  | model.CLIPHumidity
  | model.CLIPLightlevel
  | model.CLIPOpenClose
  | model.CLIPPresence
  | model.CLIPTemperature
  | model.CLIPSwitch

export class Sensors extends ApiDefinition {

  constructor(hueApi: Api) {
    super(hueApi);
  }

  getAll(): Promise<Sensor[]> {
    return this.execute(sensorsApi.getAllSensors);
  }

  getSensor(id: SensorId): Promise<Sensor> {
    return this.execute(sensorsApi.getSensor, {id: id});
  }

  searchForNew(): Promise<boolean> {
    return this.execute(sensorsApi.findNewSensors);
  }

  getNew(): Promise<Sensor[]> {
    return this.execute(sensorsApi.getNewSensors);
  }

  renameSensor(sensor: Sensor): Promise<boolean> {
    return this.execute(sensorsApi.updateSensor, {id: sensor, name: sensor.name});
  }

  /** Creates a new Sensor (CLIP based) */
  createSensor(sensor: CLIPSensor): Promise<CLIPSensor> {
    const self = this;

    return self.execute(sensorsApi.createSensor, {sensor: sensor})
      .then((data: SensorIdResult) => {
        // @ts-ignore
        return self.getSensor(data.id) as CLIPSensor;
      });
  }

  deleteSensor(id: SensorId): Promise<boolean> {
    return this.execute(sensorsApi.deleteSensor, {id: id});
  }

  /** Will update the configuration attributes of the Sensor in the bridge. */
  updateSensorConfig(sensor: Sensor): Promise<KeyValueType> {
    return this.execute(sensorsApi.changeSensorConfig, {id: sensor.id, sensor: sensor});
  }

  /**
   * Will update the state attributes of the Sensor in the bridge.
   * @param limitToStateNames list of state attributes to limit the update to (should not be needed in practice, was added to get around a bug).
   */
  updateSensorState(sensor: Sensor, limitToStateNames?: string[]): Promise<KeyValueType> {
    return this.execute(sensorsApi.changeSensorState, {
      id: sensor.id,
      sensor: sensor,
      filterStateNames: limitToStateNames
    });
  }
}