aes70 1.6.2 → 2.0.0

package/src/types/OcaLogFilter.d.ts

@@ -0,0 +1,70 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaInterval, OcaInterval } from './OcaInterval';
+import { IOcaTime, OcaTime } from './OcaTime';
+
+export declare interface IOcaLogFilter {
+  /**
+   * Application-specific value used for categorizing log records
+   * @type number
+   */
+  FunctionalCategory: number;
+
+  /**
+   * Range of severity levels to retrieve
+   * @type OcaInterval<number>
+   */
+  SeverityRange: IOcaInterval<number>;
+
+  /**
+   * ONo of object that generated the log record, or zero to accept log entries
+   * from all objects.
+   * @type number
+   */
+  EmitterONo: number;
+
+  /**
+   * Range of timestamps to be accepted.
+   * @type OcaInterval<OcaTime>
+   */
+  TimestampRange: IOcaInterval<IOcaTime>;
+}
+
+export declare class OcaLogFilter implements IOcaLogFilter {
+  /**
+   * Filter for log entry retrieval.
+   * @class OcaLogFilter
+   */
+  constructor(
+    FunctionalCategory: number,
+    SeverityRange: OcaInterval<number>,
+    EmitterONo: number,
+    TimestampRange: OcaInterval<OcaTime>
+  );
+
+  /**
+   * Application-specific value used for categorizing log records
+   * @type number
+   */
+  FunctionalCategory: number;
+
+  /**
+   * Range of severity levels to retrieve
+   * @type OcaInterval<number>
+   */
+  SeverityRange: OcaInterval<number>;
+
+  /**
+   * ONo of object that generated the log record, or zero to accept log entries
+   * from all objects.
+   * @type number
+   */
+  EmitterONo: number;
+
+  /**
+   * Range of timestamps to be accepted.
+   * @type OcaInterval<OcaTime>
+   */
+  TimestampRange: OcaInterval<OcaTime>;
+}

package/src/types/OcaLogFilter.js

@@ -0,0 +1,33 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaLogFilter {
+  /**
+   * Filter for log entry retrieval.
+   * @class OcaLogFilter
+   */
+  constructor(FunctionalCategory, SeverityRange, EmitterONo, TimestampRange) {
+    /**
+     * Application-specific value used for categorizing log records
+     * @type number
+     */
+    this.FunctionalCategory = FunctionalCategory;
+    /**
+     * Range of severity levels to retrieve
+     * @type OcaInterval<number>
+     */
+    this.SeverityRange = SeverityRange;
+    /**
+     * ONo of object that generated the log record, or zero to accept log
+     * entries from all objects.
+     * @type number
+     */
+    this.EmitterONo = EmitterONo;
+    /**
+     * Range of timestamps to be accepted.
+     * @type OcaInterval<OcaTime>
+     */
+    this.TimestampRange = TimestampRange;
+  }
+}

package/src/types/OcaLogRecord.d.ts

@@ -0,0 +1,85 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaTime, OcaTime } from './OcaTime';
+
+export declare interface IOcaLogRecord {
+  /**
+   * Application-specific value used for categorizing log records for selective
+   * retrieval.
+   * @type number
+   */
+  FunctionalCategory: number;
+
+  /**
+   * Severity of log record. Recommended values are the same as those for the
+   * Syslog format as specified by [RFC 5424]; see also {Wiki-004}.
+   * @type number
+   */
+  Severity: number;
+
+  /**
+   * ONo of object that generated the log record.
+   * @type number
+   */
+  EmitterONo: number;
+
+  /**
+   * Date/time the log record was generated.
+   * @type OcaTime
+   */
+  Timestamp: IOcaTime;
+
+  /**
+   * Device- or application- specific content of the log record.
+   * @type Uint8Array
+   */
+  Payload: Uint8Array;
+}
+
+export declare class OcaLogRecord implements IOcaLogRecord {
+  /**
+   * Format of a log record. Payload format is application-specific; header data
+   * is standard.
+   * @class OcaLogRecord
+   */
+  constructor(
+    FunctionalCategory: number,
+    Severity: number,
+    EmitterONo: number,
+    Timestamp: OcaTime,
+    Payload: Uint8Array
+  );
+
+  /**
+   * Application-specific value used for categorizing log records for selective
+   * retrieval.
+   * @type number
+   */
+  FunctionalCategory: number;
+
+  /**
+   * Severity of log record. Recommended values are the same as those for the
+   * Syslog format as specified by [RFC 5424]; see also {Wiki-004}.
+   * @type number
+   */
+  Severity: number;
+
+  /**
+   * ONo of object that generated the log record.
+   * @type number
+   */
+  EmitterONo: number;
+
+  /**
+   * Date/time the log record was generated.
+   * @type OcaTime
+   */
+  Timestamp: OcaTime;
+
+  /**
+   * Device- or application- specific content of the log record.
+   * @type Uint8Array
+   */
+  Payload: Uint8Array;
+}

package/src/types/OcaLogRecord.js

@@ -0,0 +1,40 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaLogRecord {
+  /**
+   * Format of a log record. Payload format is application-specific; header data
+   * is standard.
+   * @class OcaLogRecord
+   */
+  constructor(FunctionalCategory, Severity, EmitterONo, Timestamp, Payload) {
+    /**
+     * Application-specific value used for categorizing log records for
+     * selective retrieval.
+     * @type number
+     */
+    this.FunctionalCategory = FunctionalCategory;
+    /**
+     * Severity of log record. Recommended values are the same as those for the
+     * Syslog format as specified by [RFC 5424]; see also {Wiki-004}.
+     * @type number
+     */
+    this.Severity = Severity;
+    /**
+     * ONo of object that generated the log record.
+     * @type number
+     */
+    this.EmitterONo = EmitterONo;
+    /**
+     * Date/time the log record was generated.
+     * @type OcaTime
+     */
+    this.Timestamp = Timestamp;
+    /**
+     * Device- or application- specific content of the log record.
+     * @type Uint8Array
+     */
+    this.Payload = Payload;
+  }
+}

package/src/types/OcaManagerDefaultObjectNumbers.d.ts

@@ -97,4 +97,11 @@ export declare const OcaManagerDefaultObjectNumbers: {
    * @static
    */
   DiagnosticManager: number;
+  /**
+   * Object number of the :class:`OcaLockManager`.
+   * @type {number}
+   * @member LockManager
+   * @static
+   */
+  LockManager: number;
 };

package/src/types/OcaManagerDefaultObjectNumbers.js

@@ -97,4 +97,11 @@ export const OcaManagerDefaultObjectNumbers = {
    * @static
    */
   DiagnosticManager: 13,
+  /**
+   * Object number of the :class:`OcaLockManager`.
+   * @type {number}
+   * @member LockManager
+   * @static
+   */
+  LockManager: 14,
 };

package/src/types/OcaManagerDescriptor.d.ts

@@ -4,25 +4,26 @@
 
 export declare interface IOcaManagerDescriptor {
   /**
-   * Object number of this manager instance.
+   * Object number of this Manager instance.
    * @type number
    */
   ObjectNumber: number;
 
   /**
-   * Name of the manager instance.
+   * Name of this Manager instance.
    * @type string
    */
   Name: string;
 
   /**
-   * ClassID of the class from which the manager instance was created.
+   * ClassID of the class from which the Manager instance was constructed.
    * @type string
    */
   ClassID: string;
 
   /**
-   * Version number of the class from which this instance was created.
+   * Version number of the class from which this Manager instance was
+   * constructed.
    * @type number
    */
   ClassVersion: number;
@@ -30,7 +31,7 @@ export declare interface IOcaManagerDescriptor {
 
 export declare class OcaManagerDescriptor implements IOcaManagerDescriptor {
   /**
-   * Structure that describes a manager instance.
+   * Structure that describes a Manager instance.
    * @class OcaManagerDescriptor
    */
   constructor(
@@ -41,25 +42,26 @@ export declare class OcaManagerDescriptor implements IOcaManagerDescriptor {
   );
 
   /**
-   * Object number of this manager instance.
+   * Object number of this Manager instance.
    * @type number
    */
   ObjectNumber: number;
 
   /**
-   * Name of the manager instance.
+   * Name of this Manager instance.
    * @type string
    */
   Name: string;
 
   /**
-   * ClassID of the class from which the manager instance was created.
+   * ClassID of the class from which the Manager instance was constructed.
    * @type string
    */
   ClassID: string;
 
   /**
-   * Version number of the class from which this instance was created.
+   * Version number of the class from which this Manager instance was
+   * constructed.
    * @type number
    */
   ClassVersion: number;

package/src/types/OcaManagerDescriptor.js

@@ -4,27 +4,28 @@
 
 export class OcaManagerDescriptor {
   /**
-   * Structure that describes a manager instance.
+   * Structure that describes a Manager instance.
    * @class OcaManagerDescriptor
    */
   constructor(ObjectNumber, Name, ClassID, ClassVersion) {
     /**
-     * Object number of this manager instance.
+     * Object number of this Manager instance.
      * @type number
      */
     this.ObjectNumber = ObjectNumber;
     /**
-     * Name of the manager instance.
+     * Name of this Manager instance.
      * @type string
      */
     this.Name = Name;
     /**
-     * ClassID of the class from which the manager instance was created.
+     * ClassID of the class from which the Manager instance was constructed.
      * @type string
      */
     this.ClassID = ClassID;
     /**
-     * Version number of the class from which this instance was created.
+     * Version number of the class from which this Manager instance was
+     * constructed.
      * @type number
      */
     this.ClassVersion = ClassVersion;

package/src/types/OcaManufacturer.d.ts

@@ -0,0 +1,87 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaManufacturer {
+  /**
+   * Manufacturer's name
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Manufacturer's IEEE OUI or CID, if any. Zero value means OUI or CID is not
+   * specified.
+   * @type Uint8Array
+   */
+  OrganizationID: Uint8Array;
+
+  /**
+   * URL of the manufacturer's website. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  Website: string;
+
+  /**
+   * Contact information for business issues. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  BusinessContact: string;
+
+  /**
+   * Contact information for technical issues. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  TechnicalContact: string;
+}
+
+export declare class OcaManufacturer implements IOcaManufacturer {
+  /**
+   * Structure that describes a manufacturer.
+   * @class OcaManufacturer
+   */
+  constructor(
+    Name: string,
+    OrganizationID: Uint8Array,
+    Website: string,
+    BusinessContact: string,
+    TechnicalContact: string
+  );
+
+  /**
+   * Manufacturer's name
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Manufacturer's IEEE OUI or CID, if any. Zero value means OUI or CID is not
+   * specified.
+   * @type Uint8Array
+   */
+  OrganizationID: Uint8Array;
+
+  /**
+   * URL of the manufacturer's website. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  Website: string;
+
+  /**
+   * Contact information for business issues. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  BusinessContact: string;
+
+  /**
+   * Contact information for technical issues. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  TechnicalContact: string;
+}

package/src/types/OcaManufacturer.js

@@ -0,0 +1,47 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaManufacturer {
+  /**
+   * Structure that describes a manufacturer.
+   * @class OcaManufacturer
+   */
+  constructor(
+    Name,
+    OrganizationID,
+    Website,
+    BusinessContact,
+    TechnicalContact
+  ) {
+    /**
+     * Manufacturer's name
+     * @type string
+     */
+    this.Name = Name;
+    /**
+     * Manufacturer's IEEE OUI or CID, if any. Zero value means OUI or CID is
+     * not specified.
+     * @type Uint8Array
+     */
+    this.OrganizationID = OrganizationID;
+    /**
+     * URL of the manufacturer's website. If none, an empty string shall be
+     * provided.
+     * @type string
+     */
+    this.Website = Website;
+    /**
+     * Contact information for business issues. If none, an empty string shall
+     * be provided.
+     * @type string
+     */
+    this.BusinessContact = BusinessContact;
+    /**
+     * Contact information for technical issues. If none, an empty string shall
+     * be provided.
+     * @type string
+     */
+    this.TechnicalContact = TechnicalContact;
+  }
+}

package/src/types/OcaMatrixCommand.d.ts

@@ -0,0 +1,61 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaMatrixCoordinates,
+  OcaMatrixCoordinates,
+} from './OcaMatrixCoordinates';
+import { IOcaMethodID, OcaMethodID } from './OcaMethodID';
+
+export declare interface IOcaMatrixCommand {
+  /**
+   * Coordinates of method owner's Matrix Member. First column and first row are
+   * numbered zero.
+   * @type OcaMatrixCoordinates
+   */
+  Coordinates: IOcaMatrixCoordinates;
+
+  /**
+   * ID of the method
+   * @type OcaMethodID
+   */
+  ID: IOcaMethodID;
+
+  /**
+   * Command parameters, if any. Format is method-specific.
+   * @type Uint8Array[]
+   */
+  Parameters: Uint8Array[];
+}
+
+export declare class OcaMatrixCommand implements IOcaMatrixCommand {
+  /**
+   * (X,Y) of a Matrix Member. X=column, Y=row. Zero-relative: X=0 is first
+   * column, Y=0 is first row.
+   * @class OcaMatrixCommand
+   */
+  constructor(
+    Coordinates: OcaMatrixCoordinates,
+    ID: OcaMethodID,
+    Parameters: Uint8Array[]
+  );
+
+  /**
+   * Coordinates of method owner's Matrix Member. First column and first row are
+   * numbered zero.
+   * @type OcaMatrixCoordinates
+   */
+  Coordinates: OcaMatrixCoordinates;
+
+  /**
+   * ID of the method
+   * @type OcaMethodID
+   */
+  ID: OcaMethodID;
+
+  /**
+   * Command parameters, if any. Format is method-specific.
+   * @type Uint8Array[]
+   */
+  Parameters: Uint8Array[];
+}

package/src/types/OcaMatrixCommand.js

@@ -0,0 +1,29 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMatrixCommand {
+  /**
+   * (X,Y) of a Matrix Member. X=column, Y=row. Zero-relative: X=0 is first
+   * column, Y=0 is first row.
+   * @class OcaMatrixCommand
+   */
+  constructor(Coordinates, ID, Parameters) {
+    /**
+     * Coordinates of method owner's Matrix Member. First column and first row
+     * are numbered zero.
+     * @type OcaMatrixCoordinates
+     */
+    this.Coordinates = Coordinates;
+    /**
+     * ID of the method
+     * @type OcaMethodID
+     */
+    this.ID = ID;
+    /**
+     * Command parameters, if any. Format is method-specific.
+     * @type Uint8Array[]
+     */
+    this.Parameters = Parameters;
+  }
+}

package/src/types/OcaMatrixCoordinates.d.ts

@@ -0,0 +1,38 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaMatrixCoordinates {
+  /**
+   * Column index of Matrix Member. First column is numbered zero.
+   * @type number
+   */
+  X: number;
+
+  /**
+   * Row index of Matrix Member. First row is numbered zero.
+   * @type number
+   */
+  Y: number;
+}
+
+export declare class OcaMatrixCoordinates implements IOcaMatrixCoordinates {
+  /**
+   * (X,Y) of a Matrix Member. X=column, Y=row. Zero-relative: X=0 is first
+   * column, Y=0 is first row.
+   * @class OcaMatrixCoordinates
+   */
+  constructor(X: number, Y: number);
+
+  /**
+   * Column index of Matrix Member. First column is numbered zero.
+   * @type number
+   */
+  X: number;
+
+  /**
+   * Row index of Matrix Member. First row is numbered zero.
+   * @type number
+   */
+  Y: number;
+}

package/src/types/OcaMatrixCoordinates.js

@@ -0,0 +1,23 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMatrixCoordinates {
+  /**
+   * (X,Y) of a Matrix Member. X=column, Y=row. Zero-relative: X=0 is first
+   * column, Y=0 is first row.
+   * @class OcaMatrixCoordinates
+   */
+  constructor(X, Y) {
+    /**
+     * Column index of Matrix Member. First column is numbered zero.
+     * @type number
+     */
+    this.X = X;
+    /**
+     * Row index of Matrix Member. First row is numbered zero.
+     * @type number
+     */
+    this.Y = Y;
+  }
+}

package/src/types/OcaMediaAccessMode.d.ts

@@ -0,0 +1,50 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Media volume access mode: record or play.
+ * @class OcaMediaAccessMode
+ */
+export class OcaMediaAccessMode {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static None: OcaMediaAccessMode;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Play: OcaMediaAccessMode;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Record: OcaMediaAccessMode;
+
+  /**
+   * Returns the numeric value of this enum entry.
+   */
+  valueOf(): number;
+
+  /**
+   * Returns the string representation of this enum entry.
+   */
+  toString(): string;
+
+  /**
+   * Returns the name of an enum entry.
+   */
+  static getName(value: number): string;
+
+  /**
+   * Returns the value of an enum entry name.
+   */
+  static getValue(name: string): number;
+}
+
+export type IOcaMediaAccessMode =
+  | OcaMediaAccessMode
+  | 'None'
+  | 'Play'
+  | 'Record'
+  | 0
+  | 1
+  | 2;