ads-client 2.0.0-beta.2 → 2.0.0-beta.4

package/dist/types/ads-protocol-types.d.ts

@@ -4,6 +4,8 @@ import { PlcPrimitiveType } from "./ads-client-types";
  * AMS address
  *
  * Combination of AmsNetId and ADS port
+ *
+ * @category Types
  */
 export interface AmsAddress {
     /** AmsNetId, such as `192.168.1.2.1.1`*/
@@ -13,6 +15,8 @@ export interface AmsAddress {
 }
 /**
  * AMS packet for communication
+ *
+ * @category Types
  */
 export interface AmsTcpPacket<T = AdsData> {
     /** AMS TCP header */
@@ -24,6 +28,8 @@ export interface AmsTcpPacket<T = AdsData> {
 }
 /**
  * AMS TCP header
+ *
+ * @category Types
  */
 export interface AmsTcpHeader {
     /** AMS command as number */
@@ -37,6 +43,8 @@ export interface AmsTcpHeader {
 }
 /**
  * AMS header
+ *
+ * @category Types
  */
 export interface AmsHeader {
     /** Target AmsNetId and port (receiver) */
@@ -64,10 +72,14 @@ export interface AmsHeader {
 }
 /**
  * ADS data
+ *
+ * @category Types
  */
 export type AdsData = AdsResponse | AdsRequest;
 /**
  * AmsTcpHeader data that is received when AMS router state changes
+ *
+ * @category Types
  */
 export interface AmsRouterStateData {
     /** New router state as number */
@@ -75,10 +87,14 @@ export interface AmsRouterStateData {
 }
 /**
  * AmsTcpHeader data that is received when AMS port is registered from the router
+ *
+ * @category Types
  */
 export type AmsPortRegisteredData = AmsAddress;
 /**
  * AMS router state
+ *
+ * @category Types
  */
 export interface AmsRouterState {
     /** Router state */
@@ -88,10 +104,14 @@ export interface AmsRouterState {
 }
 /**
  * ADS response
+ *
+ * @category Types
  */
 export type AdsResponse = EmptyAdsResponse | UnknownAdsResponse | AdsReadResponse | AdsReadWriteResponse | AdsWriteResponse | AdsReadDeviceInfoResponse | AdsNotificationResponse | AdsAddNotificationResponse | AdsDeleteNotificationResponse | AdsWriteControlResponse;
 /**
  * ADS request
+ *
+ * @category Types
  */
 export interface AdsRequest {
     /** Payload of the ADS request (if any) */
@@ -99,6 +119,8 @@ export interface AdsRequest {
 }
 /**
  * ADS error
+ *
+ * @category Types
  */
 export interface AdsError {
     /** ADS error code (0 = no error, -1 = other than ADS error) */
@@ -108,6 +130,8 @@ export interface AdsError {
 }
 /**
  * Base ADS reponse (that is received in all responses)
+ *
+ * @category Types
  */
 export interface BaseAdsResponse {
     /** True if response has error (ADS or our own customer error) */
@@ -119,12 +143,16 @@ export interface BaseAdsResponse {
 }
 /**
  * Empty ADS response (no payload)
+ *
+ * @category Types
  */
 export type EmptyAdsResponse = {
     [K in any]: never;
 };
 /**
  * ADS response for `Read` command
+ *
+ * @category Types
  */
 export interface AdsReadResponse extends BaseAdsResponse {
     /** Data length */
@@ -134,6 +162,8 @@ export interface AdsReadResponse extends BaseAdsResponse {
 }
 /**
  * ADS response for `ReadWrite` command
+ *
+ * @category Types
  */
 export interface AdsReadWriteResponse extends BaseAdsResponse {
     /** Data length */
@@ -143,11 +173,15 @@ export interface AdsReadWriteResponse extends BaseAdsResponse {
 }
 /**
  * ADS response for `Write` command
+ *
+ * @category Types
  */
 export interface AdsWriteResponse extends BaseAdsResponse {
 }
 /**
  * ADS response for `ReadDeviceInfo` command
+ *
+ * @category Types
  */
 export interface AdsReadDeviceInfoResponse extends BaseAdsResponse {
     /** Device info */
@@ -155,6 +189,8 @@ export interface AdsReadDeviceInfoResponse extends BaseAdsResponse {
 }
 /**
  * ADS response for `ReadState` command
+ *
+ * @category Types
  */
 export interface AdsReadStateResponse extends BaseAdsResponse {
     /** ADS state */
@@ -162,6 +198,8 @@ export interface AdsReadStateResponse extends BaseAdsResponse {
 }
 /**
  * ADS response for `AddNotification` command
+ *
+ * @category Types
  */
 export interface AdsAddNotificationResponse extends BaseAdsResponse {
     /** Device notification handle */
@@ -169,16 +207,22 @@ export interface AdsAddNotificationResponse extends BaseAdsResponse {
 }
 /**
  * ADS response for `DeleteNotification` command
+ *
+ * @category Types
  */
 export interface AdsDeleteNotificationResponse extends BaseAdsResponse {
 }
 /**
  * ADS response for `WriteControl` command
+ *
+ * @category Types
  */
 export interface AdsWriteControlResponse extends BaseAdsResponse {
 }
 /**
  * ADS response for `Notification` command
+ *
+ * @category Types
  */
 export interface AdsNotificationResponse extends BaseAdsResponse {
     /** Notification data */
@@ -186,11 +230,15 @@ export interface AdsNotificationResponse extends BaseAdsResponse {
 }
 /**
  * ADS response for unknown command
+ *
+ * @category Types
  */
 export interface UnknownAdsResponse extends BaseAdsResponse {
 }
 /**
  * ADS device info
+ *
+ * @category Types
  */
 export interface AdsDeviceInfo {
     /** Major version number */
@@ -204,6 +252,8 @@ export interface AdsDeviceInfo {
 }
 /**
  * ADS state
+ *
+ * @category Types
  */
 export interface AdsState {
     /** ADS state */
@@ -214,7 +264,9 @@ export interface AdsState {
     deviceState: number;
 }
 /**
- * ADS `AddNotification` reponse payload
+ * ADS `AddNotification` response payload
+ *
+ * @category Types
  */
 export interface AdsAddNotificationResponseData {
     /** Notification handle */
@@ -222,6 +274,8 @@ export interface AdsAddNotificationResponseData {
 }
 /**
  * ADS notification with number of stamps
+ *
+ * @category Types
  */
 export interface AdsNotification {
     /** Total data length (bytes) */
@@ -233,6 +287,8 @@ export interface AdsNotification {
 }
 /**
  * Single ADS notification stamp with multiple samples
+ *
+ * @category Types
  */
 export interface AdsNotificationStamp {
     /** Timestamp of the included data*/
@@ -244,6 +300,8 @@ export interface AdsNotificationStamp {
 }
 /**
  * Single ADS notification sample
+ *
+ * @category Types
  */
 export interface AdsNotificationSample {
     /** Notification handle this data belongs to */
@@ -255,6 +313,8 @@ export interface AdsNotificationSample {
 }
 /**
  * ADS raw address
+ *
+ * @category Types
  */
 export interface AdsRawAddress {
     /** Address indexGroup */
@@ -266,6 +326,8 @@ export interface AdsRawAddress {
 }
 /**
  * ADS symbol object
+ *
+ * @category Types
  */
 export interface AdsSymbol {
     /** Symbol address indexGroup */
@@ -302,6 +364,8 @@ export interface AdsSymbol {
 }
 /**
  * Array information entry for symbol or data type
+ *
+ * @category Types
  */
 export interface AdsArrayInfoEntry {
     /** Array start/first index */
@@ -311,6 +375,8 @@ export interface AdsArrayInfoEntry {
 }
 /**
  * Attribute entry for symbol, data type, RPC method etc.
+ *
+ * @category Types
  */
 export interface AdsAttributeEntry {
     /** Attribute name */
@@ -320,6 +386,8 @@ export interface AdsAttributeEntry {
 }
 /**
  * ADS data type object
+ *
+ * @category Types
  */
 export interface AdsDataType {
     /** Structure version */
@@ -383,6 +451,8 @@ export interface AdsDataType {
 }
 /**
  * RPC method entry for a data type
+ *
+ * @category Types
  */
 export interface AdsRpcMethodEntry {
     /** Structure version */
@@ -418,6 +488,8 @@ export interface AdsRpcMethodEntry {
 }
 /**
  * RPC method parameter entry for a RPC method
+ *
+ * @category Types
  */
 export interface AdsRpcMethodParameterEntry {
     /** Size (bytes) */
@@ -451,6 +523,8 @@ export interface AdsRpcMethodParameterEntry {
 }
 /**
  * ADS enumeration entry
+ *
+ * @category Types
  */
 export interface AdsEnumInfoEntry {
     /** Enumeration name*/

package/dist/types/ads-protocol-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ads-protocol-types.js","sourceRoot":"","sources":["../../src/types/ads-protocol-types.ts"],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;;;;;;;;EAoBE,CAAA,CAAC;AAuHF,CAAC;AAwCD,CAAC;AAUD,CAAC;AAMD,CAAC;AAQD,CAAC;AAQD,CAAC;AAQD,CAAC;AAKwE,CAAC;AAKP,CAAC;AAQpE,CAAC;AAK6D,CAAC"}
+{"version":3,"file":"ads-protocol-types.js","sourceRoot":"","sources":["../../src/types/ads-protocol-types.ts"],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;;;;;;;;EAoBE,CAAA,CAAC;AA2IF,CAAC;AAgDD,CAAC;AAYD,CAAC;AAQD,CAAC;AAUD,CAAC;AAUD,CAAC;AAUD,CAAC;AAOwE,CAAC;AAOP,CAAC;AAUpE,CAAC;AAO6D,CAAC"}

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "ads-client",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.4",
   "description": "Beckhoff TwinCAT ADS client library for Node.js (unofficial). Connect to a Beckhoff TwinCAT automation system using the ADS protocol from a Node.js app.",
   "main": "./dist/ads-client.js",
   "scripts": {
-    "test": "jest --runInBand",
-    "test-dev": "jest --runInBand --bail=true --verbose=false --summaryThreshold=1",
-    "test-watch": "npm run test -- --watch --config test/jest.config.js",
+    "test-tc3": "jest --runInBand TC3/ads-client.test.js",
+    "test-tc2": "jest --runInBand TC2/ads-client.test.js",
     "build": "tsc",
     "watch": "tsc -w",
     "create-docs": "npx typedoc"