aes70 1.6.1 → 2.0.0

package/src/types/OcaPortID.js

@@ -4,17 +4,18 @@
 
 export class OcaPortID {
   /**
-   * Unique identifier of input or output port within a given worker or block
+   * Unique identifier of input or output Port within a given Worker or Block
    * class. Port numbers are ordinals starting at 1, and there are separate
-   * numbering spaces for input and output ports.
+   * numbering spaces for input and output Ports.
    * @class OcaPortID
    */
-  constructor(Mode, Index) {
+  constructor(Direction, Index) {
     /**
-     * Enum that indicates whether the port is for input or output.
-     * @type OcaPortMode
+     * Indicates whether the port is for input or output. Before OCA 1.5, was
+     * named **Mode**, with (now-renamed) datatype **OcaPortMode.**
+     * @type OcaIODirection
      */
-    this.Mode = Mode;
+    this.Direction = Direction;
     /**
      * Index of port within given input or output set of specified object.
      * @type number

package/src/types/OcaPortIdentification.d.ts

@@ -0,0 +1,39 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaPortID, OcaPortID } from './OcaPortID';
+
+export declare interface IOcaPortIdentification {
+  /**
+   * ONo of object that owns the port.
+   * @type number
+   */
+  Owner: number;
+
+  /**
+   * ID of the port. ID={mode,index}; mode is input or output.
+   * @type OcaPortID
+   */
+  ID: IOcaPortID;
+}
+
+export declare class OcaPortIdentification implements IOcaPortIdentification {
+  /**
+   * Representation of an OCA (input or output) port that is used in the signal
+   * path representation of an OCA device.
+   * @class OcaPortIdentification
+   */
+  constructor(Owner: number, ID: OcaPortID);
+
+  /**
+   * ONo of object that owns the port.
+   * @type number
+   */
+  Owner: number;
+
+  /**
+   * ID of the port. ID={mode,index}; mode is input or output.
+   * @type OcaPortID
+   */
+  ID: OcaPortID;
+}

package/src/types/OcaPortIdentification.js

@@ -0,0 +1,23 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaPortIdentification {
+  /**
+   * Representation of an OCA (input or output) port that is used in the signal
+   * path representation of an OCA device.
+   * @class OcaPortIdentification
+   */
+  constructor(Owner, ID) {
+    /**
+     * ONo of object that owns the port.
+     * @type number
+     */
+    this.Owner = Owner;
+    /**
+     * ID of the port. ID={mode,index}; mode is input or output.
+     * @type OcaPortID
+     */
+    this.ID = ID;
+  }
+}

package/src/types/OcaPortMode.d.ts

@@ -1,39 +1,7 @@
 /*
  * This file has been generated.
  */
-/**
- * Enum that describes whether a port is for input or output.
- * @class OcaPortMode
- */
-export class OcaPortMode {
-  /**
-   * Singleton object corresponding to the entry with value ``1``.
-   */
-  static Input: OcaPortMode;
-  /**
-   * Singleton object corresponding to the entry with value ``2``.
-   */
-  static Output: OcaPortMode;
-
-  /**
-   * 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 IOcaPortMode = OcaPortMode | 'Input' | 'Output' | 1 | 2;
+import { IOcaIODirection } from './OcaIODirection';
+import { OcaIODirection } from './OcaIODirection';
+export type IOcaPortMode = IOcaIODirection;
+export { OcaIODirection as OcaPortMode };

package/src/types/OcaPortMode.js

@@ -1,28 +1,5 @@
 /*
  * This file has been generated.
  */
-import { Enum } from './Enum.js';
-
-/**
- * Enum that describes whether a port is for input or output.
- * @class OcaPortMode
- */
-export class OcaPortMode extends Enum({
-  Input: 1,
-  Output: 2,
-}) {}
-
-/**
- * Singleton object corresponding to the entry with value ``1``.
- * @type {OcaPortMode}
- * @member Input
- * @memberof OcaPortMode
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``2``.
- * @type {OcaPortMode}
- * @member Output
- * @memberof OcaPortMode
- * @static
- */
+import { OcaIODirection } from './OcaIODirection.js';
+export { OcaIODirection as OcaPortMode };

package/src/types/OcaPositionDescriptor.d.ts

@@ -22,14 +22,14 @@ export declare interface IOcaPositionDescriptor {
 
   /**
    * The coordinates
-   * @type number[]
+   * @type 6[]
    */
-  Values: number[];
+  Values: 6[];
 }
 
 export declare class OcaPositionDescriptor implements IOcaPositionDescriptor {
   /**
-   * A six-axis c1,c2,c3,c4,c5,c6) coordinate. For mechanical systems, these
+   * A six-axis (c1,c2,c3,c4,c5,c6) coordinate. For mechanical systems, these
    * axes shall be interpreted as follows:
    *
    *  - c1 = X; axial (fore-and-aft) position
@@ -69,7 +69,7 @@ export declare class OcaPositionDescriptor implements IOcaPositionDescriptor {
   constructor(
     CoordinateSystem: OcaPositionCoordinateSystem,
     FieldFlags: IOcaPositionDescriptorFieldFlags,
-    Values: number[]
+    Values: 6[]
   );
 
   /**
@@ -86,7 +86,7 @@ export declare class OcaPositionDescriptor implements IOcaPositionDescriptor {
 
   /**
    * The coordinates
-   * @type number[]
+   * @type 6[]
    */
-  Values: number[];
+  Values: 6[];
 }

package/src/types/OcaPositionDescriptor.js

@@ -4,7 +4,7 @@
 
 export class OcaPositionDescriptor {
   /**
-   * A six-axis c1,c2,c3,c4,c5,c6) coordinate. For mechanical systems, these
+   * A six-axis (c1,c2,c3,c4,c5,c6) coordinate. For mechanical systems, these
    * axes shall be interpreted as follows:
    *
    *  - c1 = X; axial (fore-and-aft) position
@@ -54,7 +54,7 @@ export class OcaPositionDescriptor {
     this.FieldFlags = FieldFlags;
     /**
      * The coordinates
-     * @type number[]
+     * @type 6[]
      */
     this.Values = Values;
   }

package/src/types/OcaPositionDescriptorFieldFlags.d.ts

@@ -3,11 +3,41 @@
  */
 /**
  * BItset that specifies which fields in **OcaPositionAndOrientation** are used.
- * A "1" value signifies that the corresponding **OcaPositionAndOrientation**
- * field is used.
+ * A "1" value shall signify that the corresponding
+ * **OcaPositionAndOrientation** field is used.
  * @enum {number}
  * @readonly
  */
-export declare const OcaPositionDescriptorFieldFlags: Record<string, never>;
+export declare const OcaPositionDescriptorFieldFlags: {
+  /**
+   * Entry with value ``1``.
+   */
+  Field1: number;
+
+  /**
+   * Entry with value ``2``.
+   */
+  Field2: number;
+
+  /**
+   * Entry with value ``4``.
+   */
+  Field3: number;
+
+  /**
+   * Entry with value ``8``.
+   */
+  Field4: number;
+
+  /**
+   * Entry with value ``16``.
+   */
+  Field5: number;
+
+  /**
+   * Entry with value ``32``.
+   */
+  Field6: number;
+};
 
 export declare type IOcaPositionDescriptorFieldFlags = number;

package/src/types/OcaPositionDescriptorFieldFlags.js

@@ -3,9 +3,59 @@
  */
 /**
  * BItset that specifies which fields in **OcaPositionAndOrientation** are used.
- * A "1" value signifies that the corresponding **OcaPositionAndOrientation**
- * field is used.
+ * A "1" value shall signify that the corresponding
+ * **OcaPositionAndOrientation** field is used.
  * @enum {number}
  * @readonly
  */
-export const OcaPositionDescriptorFieldFlags = {};
+export const OcaPositionDescriptorFieldFlags = {
+  Field1: 1,
+  Field2: 2,
+  Field3: 4,
+  Field4: 8,
+  Field5: 16,
+  Field6: 32,
+};
+
+/**
+ * Entry with value ``1``.
+ * @type {number}
+ * @member Field1
+ * @memberof OcaPositionDescriptorFieldFlags
+ * @static
+ */
+/**
+ * Entry with value ``2``.
+ * @type {number}
+ * @member Field2
+ * @memberof OcaPositionDescriptorFieldFlags
+ * @static
+ */
+/**
+ * Entry with value ``4``.
+ * @type {number}
+ * @member Field3
+ * @memberof OcaPositionDescriptorFieldFlags
+ * @static
+ */
+/**
+ * Entry with value ``8``.
+ * @type {number}
+ * @member Field4
+ * @memberof OcaPositionDescriptorFieldFlags
+ * @static
+ */
+/**
+ * Entry with value ``16``.
+ * @type {number}
+ * @member Field5
+ * @memberof OcaPositionDescriptorFieldFlags
+ * @static
+ */
+/**
+ * Entry with value ``32``.
+ * @type {number}
+ * @member Field6
+ * @memberof OcaPositionDescriptorFieldFlags
+ * @static
+ */

package/src/types/OcaPowerSupplyState.d.ts

@@ -2,7 +2,7 @@
  * This file has been generated.
  */
 /**
- * Status of a device power supply.
+ * State of a power supply.
  * @class OcaPowerSupplyState
  */
 export class OcaPowerSupplyState {

package/src/types/OcaPowerSupplyState.js

@@ -4,7 +4,7 @@
 import { Enum } from './Enum.js';
 
 /**
- * Status of a device power supply.
+ * State of a power supply.
  * @class OcaPowerSupplyState
  */
 export class OcaPowerSupplyState extends Enum({

package/src/types/OcaProduct.d.ts

@@ -0,0 +1,92 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaProduct {
+  /**
+   * Product name
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Manufacturer's unique model identifier.
+   * @type string
+   */
+  ModelID: string;
+
+  /**
+   * Manufacturer's product revision level code
+   * @type string
+   */
+  RevisionLevel: string;
+
+  /**
+   * Brand name under which product is sold
+   * @type string
+   */
+  BrandName: string;
+
+  /**
+   * Unique UUID of product. Not manufacturer-specific.
+   * @type string
+   */
+  UUID: string;
+
+  /**
+   * Text description of product
+   * @type string
+   */
+  Description: string;
+}
+
+export declare class OcaProduct implements IOcaProduct {
+  /**
+   * Structure that describes a Product.
+   * @class OcaProduct
+   */
+  constructor(
+    Name: string,
+    ModelID: string,
+    RevisionLevel: string,
+    BrandName: string,
+    UUID: string,
+    Description: string
+  );
+
+  /**
+   * Product name
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Manufacturer's unique model identifier.
+   * @type string
+   */
+  ModelID: string;
+
+  /**
+   * Manufacturer's product revision level code
+   * @type string
+   */
+  RevisionLevel: string;
+
+  /**
+   * Brand name under which product is sold
+   * @type string
+   */
+  BrandName: string;
+
+  /**
+   * Unique UUID of product. Not manufacturer-specific.
+   * @type string
+   */
+  UUID: string;
+
+  /**
+   * Text description of product
+   * @type string
+   */
+  Description: string;
+}

package/src/types/OcaProduct.js

@@ -0,0 +1,42 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaProduct {
+  /**
+   * Structure that describes a Product.
+   * @class OcaProduct
+   */
+  constructor(Name, ModelID, RevisionLevel, BrandName, UUID, Description) {
+    /**
+     * Product name
+     * @type string
+     */
+    this.Name = Name;
+    /**
+     * Manufacturer's unique model identifier.
+     * @type string
+     */
+    this.ModelID = ModelID;
+    /**
+     * Manufacturer's product revision level code
+     * @type string
+     */
+    this.RevisionLevel = RevisionLevel;
+    /**
+     * Brand name under which product is sold
+     * @type string
+     */
+    this.BrandName = BrandName;
+    /**
+     * Unique UUID of product. Not manufacturer-specific.
+     * @type string
+     */
+    this.UUID = UUID;
+    /**
+     * Text description of product
+     * @type string
+     */
+    this.Description = Description;
+  }
+}

package/src/types/OcaProgramResult.d.ts

@@ -0,0 +1,39 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaGenericEndState, OcaGenericEndState } from './OcaGenericEndState';
+import { IOcaTypedBlob, OcaTypedBlob } from './OcaTypedBlob';
+
+export declare interface IOcaProgramResult {
+  /**
+   * Completed normally, completed abnormally, aborted, or failed
+   * @type OcaGenericEndState
+   */
+  EndState: IOcaGenericEndState;
+
+  /**
+   * Program-specific return info - may be null.
+   * @type OcaTypedBlob[]
+   */
+  Data: IOcaTypedBlob[];
+}
+
+export declare class OcaProgramResult implements IOcaProgramResult {
+  /**
+   * Execution result of a Program.
+   * @class OcaProgramResult
+   */
+  constructor(EndState: OcaGenericEndState, Data: OcaTypedBlob[]);
+
+  /**
+   * Completed normally, completed abnormally, aborted, or failed
+   * @type OcaGenericEndState
+   */
+  EndState: OcaGenericEndState;
+
+  /**
+   * Program-specific return info - may be null.
+   * @type OcaTypedBlob[]
+   */
+  Data: OcaTypedBlob[];
+}

package/src/types/OcaProgramResult.js

@@ -0,0 +1,22 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaProgramResult {
+  /**
+   * Execution result of a Program.
+   * @class OcaProgramResult
+   */
+  constructor(EndState, Data) {
+    /**
+     * Completed normally, completed abnormally, aborted, or failed
+     * @type OcaGenericEndState
+     */
+    this.EndState = EndState;
+    /**
+     * Program-specific return info - may be null.
+     * @type OcaTypedBlob[]
+     */
+    this.Data = Data;
+  }
+}

package/src/types/OcaProgramRunMode.d.ts

@@ -0,0 +1,24 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Two-bit bitset that specifies run mode: Bit 1: ExecutionOrder 0 = sequential,
+ * 1 = arbitrary // execution order of steps Bit 2: RollBackOnError 0 = no
+ * rollback, 1 = rollback Thus, the RunMode value for simple sequential
+ * execution with no rollback mechanism shall be 0b00.
+ * @enum {number}
+ * @readonly
+ */
+export declare const OcaProgramRunMode: {
+  /**
+   * Entry with value ``1``.
+   */
+  ExecutionOrder: number;
+
+  /**
+   * Entry with value ``2``.
+   */
+  RollbackOnError: number;
+};
+
+export declare type IOcaProgramRunMode = number;

package/src/types/OcaProgramRunMode.js

@@ -0,0 +1,30 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Two-bit bitset that specifies run mode: Bit 1: ExecutionOrder 0 = sequential,
+ * 1 = arbitrary // execution order of steps Bit 2: RollBackOnError 0 = no
+ * rollback, 1 = rollback Thus, the RunMode value for simple sequential
+ * execution with no rollback mechanism shall be 0b00.
+ * @enum {number}
+ * @readonly
+ */
+export const OcaProgramRunMode = {
+  ExecutionOrder: 1,
+  RollbackOnError: 2,
+};
+
+/**
+ * Entry with value ``1``.
+ * @type {number}
+ * @member ExecutionOrder
+ * @memberof OcaProgramRunMode
+ * @static
+ */
+/**
+ * Entry with value ``2``.
+ * @type {number}
+ * @member RollbackOnError
+ * @memberof OcaProgramRunMode
+ * @static
+ */

package/src/types/OcaProperty.d.ts

@@ -22,8 +22,8 @@ export declare interface IOcaProperty {
 
 export declare class OcaProperty implements IOcaProperty {
   /**
-   * Template for complete identification of an OCA property instance, including
-   * object number, property ID, Get and Set method IDs, and datatype.
+   * Identification of an OCA property instance, including object number,
+   * property ID, Get and Set method IDs, and datatype.
    * @class OcaProperty
    */
   constructor(ONo: number, Descriptor: OcaPropertyDescriptor);

package/src/types/OcaProperty.js

@@ -4,8 +4,8 @@
 
 export class OcaProperty {
   /**
-   * Template for complete identification of an OCA property instance, including
-   * object number, property ID, Get and Set method IDs, and datatype.
+   * Identification of an OCA property instance, including object number,
+   * property ID, Get and Set method IDs, and datatype.
    * @class OcaProperty
    */
   constructor(ONo, Descriptor) {

package/src/types/OcaProtoObjectIdentification.d.ts

@@ -24,7 +24,7 @@ export declare class OcaProtoObjectIdentification
   implements IOcaProtoObjectIdentification {
   /**
    * Prototype object identification. Composite of prototype object number and
-   * prototype object's class identification. Used in **OcaBlockFactory**.
+   * prototype object's class identification.
    * @class OcaProtoObjectIdentification
    */
   constructor(POno: number, ClassIdentification: OcaClassIdentification);

package/src/types/OcaProtoObjectIdentification.js

@@ -5,7 +5,7 @@
 export class OcaProtoObjectIdentification {
   /**
    * Prototype object identification. Composite of prototype object number and
-   * prototype object's class identification. Used in **OcaBlockFactory**.
+   * prototype object's class identification.
    * @class OcaProtoObjectIdentification
    */
   constructor(POno, ClassIdentification) {