aes70/src/controller/ControlClasses/OcaDiagnosticManager.js

A controller library for the AES70 protocol.

import { OcaString } from '../../OCP1/OcaString.js';
import { OcaUint32 } from '../../OCP1/OcaUint32.js';
import { make_control_class } from '../make_control_class.js';
import { OcaManager } from './OcaManager.js';

/**
 * Optional manager that provides application diagnostic aids. Unlike other
 * manager classes, OcaDiagnosticManager may be subclassed to provide
 * proprietary application diagnostic enhancements.
 *
 *  - May be instantiated once in any device.
 *
 *  - If instantiated, object number must be 13.
 *
 *
 * @extends OcaManager
 * @class OcaDiagnosticManager
 */
export const OcaDiagnosticManager = make_control_class(
  'OcaDiagnosticManager',
  3,
  '\u0001\u0003\r',
  1,
  OcaManager,
  [['GetLockStatus', 3, 1, [OcaUint32], [OcaString]]],
  [],
  []
);

/**
 * Retrieves a text description of the given object's lock status. Return value
 * indicates success of the retrieval.
 *
 * @method OcaDiagnosticManager#GetLockStatus
 * @param {number} ONo
 *
 * @returns {Promise<string>}
 *   A promise which resolves to a single value of type ``string``.
 */