abb-rws-client 0.1.0

package/dist/index.js

@@ -0,0 +1,9 @@
+/**
+ * abb-rws-client — public API
+ *
+ * Typed HTTP/WebSocket client for ABB IRC5 robot controllers (RWS 1.0, RobotWare 6.x only).
+ * Not compatible with RWS 2.0 / RobotWare 7.x / OmniCore.
+ */
+export { RwsClient } from './RwsClient.js';
+export { RwsError } from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,90 @@
+export type ControllerState = 'init' | 'motoroff' | 'motoron' | 'guardstop' | 'emergencystop' | 'emergencystopreset' | 'sysfail';
+export type OperationMode = 'AUTO' | 'MANR' | 'MANF';
+export type ExecutionState = 'running' | 'stopped';
+export interface JointTarget {
+    rax_1: number;
+    rax_2: number;
+    rax_3: number;
+    rax_4: number;
+    rax_5: number;
+    rax_6: number;
+}
+export interface RobTarget {
+    x: number;
+    y: number;
+    z: number;
+    q1: number;
+    q2: number;
+    q3: number;
+    q4: number;
+}
+export interface Signal {
+    name: string;
+    value: string;
+    type: 'DI' | 'DO' | 'AI' | 'AO' | 'GI' | 'GO';
+    lvalue: string;
+}
+export interface RapidTask {
+    name: string;
+    type: string;
+    taskstate: string;
+    excstate: ExecutionState;
+    active: boolean;
+    motiontask: boolean;
+}
+export interface RwsClientOptions {
+    /** IP address or hostname, e.g. '192.168.125.1' or '127.0.0.1' for RobotStudio */
+    host: string;
+    /** HTTP port; default 80 */
+    port?: number;
+    /** Default 'Default User' */
+    username?: string;
+    /** Default 'robotics' */
+    password?: string;
+    /** Minimum ms between requests; default 55ms (enforces <20 req/sec RWS rate limit) */
+    requestIntervalMs?: number;
+    /** Request timeout in ms; default 5000 */
+    timeout?: number;
+}
+export type SubscriptionResource = 'execution' | 'controllerstate' | 'operationmode' | {
+    type: 'signal';
+    name: string;
+} | {
+    type: 'persvar';
+    name: string;
+};
+export interface SubscriptionEvent {
+    resource: string;
+    value: string;
+    timestamp: Date;
+}
+export type RwsErrorCode = 'SESSION_EXPIRED' | 'AUTH_FAILED' | 'MOTORS_OFF' | 'MODULE_NOT_FOUND' | 'RATE_LIMITED' | 'CONTROLLER_BUSY' | 'NETWORK_ERROR' | 'PARSE_ERROR' | 'UNKNOWN';
+/**
+ * Typed error thrown by all abb-rws-client public methods.
+ * Always check `code` for programmatic error handling.
+ */
+export declare class RwsError extends Error {
+    readonly code: RwsErrorCode;
+    readonly httpStatus?: number;
+    readonly rwsDetail?: string;
+    constructor(message: string, code: RwsErrorCode, httpStatus?: number, rwsDetail?: string);
+}
+/** @internal Parsed fields from a WWW-Authenticate: Digest ... header (RFC 2617) */
+export interface DigestChallenge {
+    realm: string;
+    nonce: string;
+    opaque?: string;
+    /** 'auth' | 'auth-int' — if absent, use RFC 2069 compat mode */
+    qop?: string;
+    /** Hash algorithm — typically 'MD5' (default) */
+    algorithm?: string;
+    stale?: boolean;
+    domain?: string;
+}
+/** @internal Return type for all HttpSession HTTP methods */
+export interface HttpResponse {
+    status: number;
+    body: string;
+    headers: Headers;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,UAAU,GACV,SAAS,GACT,WAAW,GACX,eAAe,GACf,oBAAoB,GACpB,SAAS,CAAC;AAEd,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AACrD,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,CAAC;AAEnD,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,SAAS;IACxB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAC9C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,cAAc,CAAC;IACzB,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sFAAsF;IACtF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,oBAAoB,GAC5B,WAAW,GACX,iBAAiB,GACjB,eAAe,GACf;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,MAAM,YAAY,GACpB,iBAAiB,GACjB,aAAa,GACb,YAAY,GACZ,kBAAkB,GAClB,cAAc,GACd,iBAAiB,GACjB,eAAe,GACf,aAAa,GACb,SAAS,CAAC;AAEd;;;GAGG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEhB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;CASzF;AAID,oFAAoF;AACpF,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,6DAA6D;AAC7D,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/dist/types.js

@@ -0,0 +1,21 @@
+// abb-rws-client — type definitions
+// Targets RWS 1.0 (RobotWare 6.x) only. Not compatible with RWS 2.0 / RobotWare 7.x / OmniCore.
+/**
+ * Typed error thrown by all abb-rws-client public methods.
+ * Always check `code` for programmatic error handling.
+ */
+export class RwsError extends Error {
+    code;
+    httpStatus;
+    rwsDetail;
+    constructor(message, code, httpStatus, rwsDetail) {
+        super(message);
+        this.name = 'RwsError';
+        this.code = code;
+        this.httpStatus = httpStatus;
+        this.rwsDetail = rwsDetail;
+        // Restore prototype chain so instanceof checks work correctly when targeting ES2022
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,gGAAgG;AAwFhG;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,KAAK;IACxB,IAAI,CAAe;IACnB,UAAU,CAAU;IACpB,SAAS,CAAU;IAE5B,YAAY,OAAe,EAAE,IAAkB,EAAE,UAAmB,EAAE,SAAkB;QACtF,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,oFAAoF;QACpF,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "abb-rws-client",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "eslint": "^9.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.6.0"
+  },
+  "dependencies": {
+    "ws": "^8.20.0"
+  }
+}