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

A controller library for the AES70 protocol.

import { OcaSensorReadingState } from '../../types/OcaSensorReadingState.js';
import { PropertyEvent } from '../property_event.js';
import { RemoteDevice } from '../remote_device.js';
import { OcaWorker } from './OcaWorker.js';

/**
 * Abstract base class for all sensor classes.
 * @extends OcaWorker
 * @class OcaSensor
 */
export declare class OcaSensor extends OcaWorker {
  /**
   * This event is emitted whenever ReadingState changes.
   */
  OnReadingStateChanged: PropertyEvent<OcaSensorReadingState>;

  constructor(objectNumber: number, device: RemoteDevice);

  /**
   * Gets the current reading state of the sensor.
   *
   * @method OcaSensor#GetReadingState
   * @returns {Promise<OcaSensorReadingState>}
   *   A promise which resolves to a single value of type :class:`OcaSensorReadingState`.
   */
  GetReadingState(): Promise<OcaSensorReadingState>;
}