aes70/src/controller/ControlClasses/OcaBooleanSensor.d.ts

A controller library for the AES70 protocol.

import { PropertyEvent } from '../property_event';
import { RemoteDevice } from '../remote_device';
import { OcaBasicSensor } from './OcaBasicSensor';

/**
 * Basic boolean sensor.
 * @extends OcaBasicSensor
 * @class OcaBooleanSensor
 */
export declare class OcaBooleanSensor extends OcaBasicSensor {
  /**
   * This event is emitted whenever Reading changes.
   */
  OnReadingChanged: PropertyEvent<boolean>;

  constructor(objectNumber: number, device: RemoteDevice);

  /**
   * Gets the **Reading** property. The return value indicates whether the data
   * was successfully retrieved.
   *
   * @method OcaBooleanSensor#GetReading
   * @returns {Promise<boolean>}
   *   A promise which resolves to a single value of type ``boolean``.
   */
  GetReading(): Promise<boolean>;
}