motion-master-client 0.0.11 → 0.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.babelrc +3 -0
- package/.eslintrc.json +18 -0
- package/jest.config.ts +15 -0
- package/motion-master.proto +1822 -0
- package/package.json +2 -17
- package/project.json +41 -0
- package/src/lib/cia402.ts +112 -0
- package/src/lib/device-log-line.ts +5 -0
- package/src/lib/device-parameter.spec.ts +85 -0
- package/src/lib/device-parameter.ts +79 -0
- package/src/lib/device.ts +10 -0
- package/src/lib/examples/get-firmware-version-for-all-devices.ts +18 -0
- package/src/lib/hardware-description.spec.ts +253 -0
- package/src/lib/hardware-description.ts +84 -0
- package/src/lib/logger.ts +5 -0
- package/src/lib/monitoring-config.ts +6 -0
- package/src/lib/{monitoring-entry.d.ts → monitoring-entry.ts} +5 -4
- package/src/lib/motion-master-client.ts +126 -0
- package/src/lib/motion-master-pub-sub-client.ts +94 -0
- package/src/lib/motion-master-pub-sub-socket.ts +33 -0
- package/src/lib/motion-master-pub-sub-web-socket.ts +71 -0
- package/src/lib/motion-master-pub-sub-worker-socket.ts +46 -0
- package/src/lib/motion-master-req-res-client.spec.ts +740 -0
- package/src/lib/motion-master-req-res-client.ts +1974 -0
- package/src/lib/motion-master-req-res-socket.ts +55 -0
- package/src/lib/motion-master-req-res-web-socket.ts +131 -0
- package/src/lib/motion-master-req-res-worker-socket.ts +75 -0
- package/src/lib/operators.ts +93 -0
- package/src/lib/options.ts +38 -0
- package/src/lib/parameter.spec.ts +81 -0
- package/src/lib/parameter.ts +123 -0
- package/src/lib/product-id-range.ts +8 -0
- package/src/lib/request-status-resolver.ts +403 -0
- package/src/lib/system-log-line.ts +8 -0
- package/src/lib/types.ts +123 -0
- package/src/lib/urls.ts +6 -0
- package/src/lib/util.ts +267 -0
- package/tsconfig.json +23 -0
- package/tsconfig.lib.json +10 -0
- package/tsconfig.spec.json +20 -0
- package/typedoc.json +10 -0
- package/src/index.js +0 -27
- package/src/index.js.map +0 -1
- package/src/lib/cia402.d.ts +0 -30
- package/src/lib/cia402.js +0 -112
- package/src/lib/cia402.js.map +0 -1
- package/src/lib/device-log-line.d.ts +0 -5
- package/src/lib/device-log-line.js +0 -3
- package/src/lib/device-log-line.js.map +0 -1
- package/src/lib/device-parameter.d.ts +0 -56
- package/src/lib/device-parameter.js +0 -39
- package/src/lib/device-parameter.js.map +0 -1
- package/src/lib/device.d.ts +0 -9
- package/src/lib/device.js +0 -3
- package/src/lib/device.js.map +0 -1
- package/src/lib/examples/get-firmware-version-for-all-devices.d.ts +0 -1
- package/src/lib/examples/get-firmware-version-for-all-devices.js +0 -15
- package/src/lib/examples/get-firmware-version-for-all-devices.js.map +0 -1
- package/src/lib/hardware-description.d.ts +0 -37
- package/src/lib/hardware-description.js +0 -48
- package/src/lib/hardware-description.js.map +0 -1
- package/src/lib/logger.d.ts +0 -1
- package/src/lib/logger.js +0 -8
- package/src/lib/logger.js.map +0 -1
- package/src/lib/monitoring-config.d.ts +0 -6
- package/src/lib/monitoring-config.js +0 -3
- package/src/lib/monitoring-config.js.map +0 -1
- package/src/lib/monitoring-entry.js +0 -3
- package/src/lib/monitoring-entry.js.map +0 -1
- package/src/lib/motion-master-client.d.ts +0 -18
- package/src/lib/motion-master-client.js +0 -73
- package/src/lib/motion-master-client.js.map +0 -1
- package/src/lib/motion-master-pub-sub-client.d.ts +0 -16
- package/src/lib/motion-master-pub-sub-client.js +0 -68
- package/src/lib/motion-master-pub-sub-client.js.map +0 -1
- package/src/lib/motion-master-pub-sub-socket.d.ts +0 -28
- package/src/lib/motion-master-pub-sub-socket.js +0 -3
- package/src/lib/motion-master-pub-sub-socket.js.map +0 -1
- package/src/lib/motion-master-pub-sub-web-socket.d.ts +0 -13
- package/src/lib/motion-master-pub-sub-web-socket.js +0 -61
- package/src/lib/motion-master-pub-sub-web-socket.js.map +0 -1
- package/src/lib/motion-master-pub-sub-worker-socket.d.ts +0 -13
- package/src/lib/motion-master-pub-sub-worker-socket.js +0 -37
- package/src/lib/motion-master-pub-sub-worker-socket.js.map +0 -1
- package/src/lib/motion-master-req-res-client.d.ts +0 -956
- package/src/lib/motion-master-req-res-client.js +0 -1525
- package/src/lib/motion-master-req-res-client.js.map +0 -1
- package/src/lib/motion-master-req-res-socket.d.ts +0 -38
- package/src/lib/motion-master-req-res-socket.js +0 -3
- package/src/lib/motion-master-req-res-socket.js.map +0 -1
- package/src/lib/motion-master-req-res-web-socket.d.ts +0 -20
- package/src/lib/motion-master-req-res-web-socket.js +0 -100
- package/src/lib/motion-master-req-res-web-socket.js.map +0 -1
- package/src/lib/motion-master-req-res-worker-socket.d.ts +0 -15
- package/src/lib/motion-master-req-res-worker-socket.js +0 -53
- package/src/lib/motion-master-req-res-worker-socket.js.map +0 -1
- package/src/lib/operators.d.ts +0 -21
- package/src/lib/operators.js +0 -71
- package/src/lib/operators.js.map +0 -1
- package/src/lib/options.d.ts +0 -34
- package/src/lib/options.js +0 -38
- package/src/lib/options.js.map +0 -1
- package/src/lib/parameter.d.ts +0 -65
- package/src/lib/parameter.js +0 -70
- package/src/lib/parameter.js.map +0 -1
- package/src/lib/request-status-resolver.d.ts +0 -4
- package/src/lib/request-status-resolver.js +0 -345
- package/src/lib/request-status-resolver.js.map +0 -1
- package/src/lib/system-log-line.d.ts +0 -8
- package/src/lib/system-log-line.js +0 -3
- package/src/lib/system-log-line.js.map +0 -1
- package/src/lib/types.d.ts +0 -51
- package/src/lib/types.js +0 -23
- package/src/lib/types.js.map +0 -1
- package/src/lib/urls.d.ts +0 -3
- package/src/lib/urls.js +0 -10
- package/src/lib/urls.js.map +0 -1
- package/src/lib/util.d.ts +0 -30
- package/src/lib/util.js +0 -279
- package/src/lib/util.js.map +0 -1
- /package/src/{index.d.ts → index.ts} +0 -0
package/package.json
CHANGED
|
@@ -1,21 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "motion-master-client",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.13",
|
|
4
4
|
"type": "commonjs",
|
|
5
|
-
"description": "A library and CLI program used for communicating with Motion Master."
|
|
6
|
-
"dependencies": {
|
|
7
|
-
"fast-deep-equal": "^3.1.3",
|
|
8
|
-
"lodash": "^4.17.21",
|
|
9
|
-
"long": "5.2.1",
|
|
10
|
-
"protobufjs": "^7.2.3",
|
|
11
|
-
"roarr": "^7.14.1",
|
|
12
|
-
"rxjs": "~7.5.0",
|
|
13
|
-
"uuid": "^9.0.0",
|
|
14
|
-
"ws": "^8.12.1"
|
|
15
|
-
},
|
|
16
|
-
"peerDependencies": {
|
|
17
|
-
"tslib": "^2.4.0"
|
|
18
|
-
},
|
|
19
|
-
"main": "./src/index.js",
|
|
20
|
-
"types": "./src/index.d.ts"
|
|
5
|
+
"description": "A library and CLI program used for communicating with Motion Master."
|
|
21
6
|
}
|
package/project.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "motion-master-client",
|
|
3
|
+
"$schema": "../../node_modules/nx/schemas/project-schema.json",
|
|
4
|
+
"sourceRoot": "libs/motion-master-client/src",
|
|
5
|
+
"projectType": "library",
|
|
6
|
+
"targets": {
|
|
7
|
+
"build": {
|
|
8
|
+
"executor": "@nrwl/js:tsc",
|
|
9
|
+
"outputs": ["{options.outputPath}"],
|
|
10
|
+
"options": {
|
|
11
|
+
"outputPath": "dist/libs/motion-master-client",
|
|
12
|
+
"main": "libs/motion-master-client/src/index.ts",
|
|
13
|
+
"tsConfig": "libs/motion-master-client/tsconfig.lib.json",
|
|
14
|
+
"assets": ["libs/motion-master-client/*.md", "libs/motion-master-client/src/lib/motion-master.proto.js", "libs/motion-master-client/src/lib/motion-master.proto.d.ts"]
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"publish": {
|
|
18
|
+
"executor": "nx:run-commands",
|
|
19
|
+
"options": {
|
|
20
|
+
"command": "node tools/scripts/publish.mjs motion-master-client {args.ver} {args.tag}"
|
|
21
|
+
},
|
|
22
|
+
"dependsOn": ["build"]
|
|
23
|
+
},
|
|
24
|
+
"lint": {
|
|
25
|
+
"executor": "@nrwl/linter:eslint",
|
|
26
|
+
"outputs": ["{options.outputFile}"],
|
|
27
|
+
"options": {
|
|
28
|
+
"lintFilePatterns": ["libs/motion-master-client/**/*.ts"]
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
"test": {
|
|
32
|
+
"executor": "@nrwl/jest:jest",
|
|
33
|
+
"outputs": ["{workspaceRoot}/coverage/libs/motion-master-client"],
|
|
34
|
+
"options": {
|
|
35
|
+
"jestConfig": "libs/motion-master-client/jest.config.ts",
|
|
36
|
+
"passWithNoTests": true
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"tags": []
|
|
41
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
export enum CiA402State {
|
|
2
|
+
NOT_READY_TO_SWITCH_ON,
|
|
3
|
+
SWITCH_ON_DISABLED,
|
|
4
|
+
READY_TO_SWITCH_ON,
|
|
5
|
+
SWITCHED_ON,
|
|
6
|
+
OPERATION_ENABLED,
|
|
7
|
+
QUICK_STOP_ACTIVE,
|
|
8
|
+
FAULT_REACTION_ACTIVE,
|
|
9
|
+
FAULT,
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export const cia402StateLabels = [
|
|
13
|
+
'NOT READY TO SWITCH ON',
|
|
14
|
+
'SWITCH ON DISABLED',
|
|
15
|
+
'READY TO SWITCH ON',
|
|
16
|
+
'SWITCHED ON',
|
|
17
|
+
'OPERATION ENABLED',
|
|
18
|
+
'QUICK STOP ACTIVE',
|
|
19
|
+
'FAULT REACTION ACTIVE',
|
|
20
|
+
'FAULT',
|
|
21
|
+
];
|
|
22
|
+
|
|
23
|
+
export const statuswordToCia402StateMap = new Map([
|
|
24
|
+
[0b00000000, CiA402State.NOT_READY_TO_SWITCH_ON],
|
|
25
|
+
[0b01000000, CiA402State.SWITCH_ON_DISABLED],
|
|
26
|
+
[0b00100001, CiA402State.READY_TO_SWITCH_ON],
|
|
27
|
+
[0b00100011, CiA402State.SWITCHED_ON],
|
|
28
|
+
[0b00100111, CiA402State.OPERATION_ENABLED],
|
|
29
|
+
[0b00000111, CiA402State.QUICK_STOP_ACTIVE],
|
|
30
|
+
[0b00001111, CiA402State.FAULT_REACTION_ACTIVE],
|
|
31
|
+
[0b00001000, CiA402State.FAULT],
|
|
32
|
+
]);
|
|
33
|
+
|
|
34
|
+
export function getCia402StateFromStatusword(statusword: number) {
|
|
35
|
+
return statuswordToCia402StateMap.get(statusword & 0b01101111)
|
|
36
|
+
|| statuswordToCia402StateMap.get(statusword & 0b01001111);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export function isInternalLimitActive(statusword: number) {
|
|
40
|
+
return (0x800 & statusword) === 0x800;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export enum ModesOfOperation {
|
|
44
|
+
OPEN_LOOP_FIELD_MODE = -3,
|
|
45
|
+
DIAGNOSTICS_MODE = -2,
|
|
46
|
+
COGGING_COMPENSATION_RECORDING_MODE = -1,
|
|
47
|
+
NO_MODE_ASSIGNED = 0,
|
|
48
|
+
PROFILE_POSITION_MODE = 1,
|
|
49
|
+
PROFILE_VELOCITY_MODE = 3,
|
|
50
|
+
TORQUE_PROFILE_MODE = 4,
|
|
51
|
+
HOMING_MODE = 6,
|
|
52
|
+
CYCLIC_SYNC_POSITION_MODE = 8,
|
|
53
|
+
CYCLIC_SYNC_VELOCITY_MODE = 9,
|
|
54
|
+
CYCLIC_SYNC_TORQUE_MODE = 10,
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export const controlwordBits = [
|
|
58
|
+
'so = switch on',
|
|
59
|
+
'ev = enable voltage',
|
|
60
|
+
'qs = quick stop',
|
|
61
|
+
'eo = enable operation',
|
|
62
|
+
'oms = operation mode specific',
|
|
63
|
+
'oms = operation mode specific',
|
|
64
|
+
'oms = operation mode specific',
|
|
65
|
+
'fr = fault reset',
|
|
66
|
+
'h = halt',
|
|
67
|
+
'oms = operation mode specific',
|
|
68
|
+
'r = reserved',
|
|
69
|
+
'ms = manufacturer-specific',
|
|
70
|
+
'ms = manufacturer-specific',
|
|
71
|
+
'ms = manufacturer-specific',
|
|
72
|
+
'ms = manufacturer-specific',
|
|
73
|
+
'ms = manufacturer-specific',
|
|
74
|
+
];
|
|
75
|
+
|
|
76
|
+
export const statuswordBits = [
|
|
77
|
+
'rtso = ready to switch on',
|
|
78
|
+
'so = switched on',
|
|
79
|
+
'oe = operation enabled',
|
|
80
|
+
'f = fault',
|
|
81
|
+
've = voltage enabled',
|
|
82
|
+
'qs = quick stop',
|
|
83
|
+
'sod = switch on disabled',
|
|
84
|
+
'w = warning',
|
|
85
|
+
'ms = manufacturer-specific',
|
|
86
|
+
'rm = remote',
|
|
87
|
+
'tr = target reached',
|
|
88
|
+
'ila = internal limit active',
|
|
89
|
+
'oms = operation-mode-specific',
|
|
90
|
+
'oms = operation-mode-specific',
|
|
91
|
+
'ms = manufacturer-specific',
|
|
92
|
+
'ms = manufacturer-specific',
|
|
93
|
+
];
|
|
94
|
+
|
|
95
|
+
export const supportedDriveModesBits = [
|
|
96
|
+
'pp = profile position mode',
|
|
97
|
+
'vl = velocity mode',
|
|
98
|
+
'pv = profile velocity mode',
|
|
99
|
+
'tq = torque mode',
|
|
100
|
+
'r = reserved',
|
|
101
|
+
'hm = homing mode',
|
|
102
|
+
'ip = interpolated position mode',
|
|
103
|
+
'csp = cyclic synchronous position mode',
|
|
104
|
+
'csv = cyclic synchronous velocity mode',
|
|
105
|
+
'cst = cyclic synchronous torque mode',
|
|
106
|
+
'r = reserved',
|
|
107
|
+
'r = reserved',
|
|
108
|
+
'r = reserved',
|
|
109
|
+
'r = reserved',
|
|
110
|
+
'r = reserved',
|
|
111
|
+
'r = reserved',
|
|
112
|
+
];
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { makeDeviceParameterId, splitDeviceParameterId } from "./device-parameter";
|
|
2
|
+
|
|
3
|
+
describe('deviceParameter', () => {
|
|
4
|
+
|
|
5
|
+
describe('makeDeviceParameterId', () => {
|
|
6
|
+
|
|
7
|
+
const serialNumber = '8502-03-0001353-2115';
|
|
8
|
+
|
|
9
|
+
test.each<[string, [(number | null | undefined), (number | null | undefined)], string]>([
|
|
10
|
+
[serialNumber, [0x1234, 123], '0x1234:7B.8502-03-0001353-2115'],
|
|
11
|
+
[serialNumber, [23, 23], '0x0017:17.8502-03-0001353-2115'],
|
|
12
|
+
[serialNumber, [0, 0], '0x0000:00.8502-03-0001353-2115'],
|
|
13
|
+
[serialNumber, [0x2000, undefined], '0x2000:00.8502-03-0001353-2115'],
|
|
14
|
+
[serialNumber, [0x2003, null], '0x2003:00.8502-03-0001353-2115'],
|
|
15
|
+
[serialNumber, [0x10000, 3], '0x00010000:03.8502-03-0001353-2115'],
|
|
16
|
+
[serialNumber, [0x100F0, undefined], '0x000100F0:00.8502-03-0001353-2115'],
|
|
17
|
+
])('should for device serial number "%s" and tuple %j return "%s"', (serialNumber, tuple, expected) => {
|
|
18
|
+
const result = makeDeviceParameterId(serialNumber, tuple);
|
|
19
|
+
|
|
20
|
+
expect(result).toBe(expected);
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
test.each([
|
|
24
|
+
[serialNumber, {}, '0x0000:00.8502-03-0001353-2115'],
|
|
25
|
+
[serialNumber, { index: 0x2004, subindex: 4 }, '0x2004:04.8502-03-0001353-2115'],
|
|
26
|
+
[serialNumber, { index: 0x1024 }, '0x1024:00.8502-03-0001353-2115'],
|
|
27
|
+
])('should for device serial number "%s" and parameter %j return "%s"', (serialNumber, parameter, expected) => {
|
|
28
|
+
const result = makeDeviceParameterId(serialNumber, parameter);
|
|
29
|
+
|
|
30
|
+
expect(result).toBe(expected);
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
test.each([
|
|
34
|
+
[serialNumber, 0x1234, 123, '0x1234:7B.8502-03-0001353-2115'],
|
|
35
|
+
[serialNumber, 23, 23, '0x0017:17.8502-03-0001353-2115'],
|
|
36
|
+
[serialNumber, 0, 0, '0x0000:00.8502-03-0001353-2115'],
|
|
37
|
+
[serialNumber, 0x2000, undefined, '0x2000:00.8502-03-0001353-2115'],
|
|
38
|
+
[serialNumber, 0x2003, null, '0x2003:00.8502-03-0001353-2115'],
|
|
39
|
+
[serialNumber, 0x10000, 3, '0x00010000:03.8502-03-0001353-2115'],
|
|
40
|
+
[serialNumber, 0x100F0, undefined, '0x000100F0:00.8502-03-0001353-2115'],
|
|
41
|
+
])('should for device serial number "%s" and index %d and subindex %d return "%s"', (serialNumber, index, subindex, expected) => {
|
|
42
|
+
const result = makeDeviceParameterId(serialNumber, index, subindex);
|
|
43
|
+
|
|
44
|
+
expect(result).toBe(expected);
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
it('should throw if index is less than 0', () => {
|
|
48
|
+
expect(() => {
|
|
49
|
+
makeDeviceParameterId(serialNumber, -123, 0);
|
|
50
|
+
}).toThrow();
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it('should throw if subindex is less than 0', () => {
|
|
54
|
+
expect(() => {
|
|
55
|
+
makeDeviceParameterId(serialNumber, 0x1024, -3);
|
|
56
|
+
}).toThrow();
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
describe('splitDeviceParameterId', () => {
|
|
62
|
+
|
|
63
|
+
test.each([
|
|
64
|
+
['0x1234:7B.8502-03-0001353-2115', ['8502-03-0001353-2115', 4660, 123]],
|
|
65
|
+
['0x000100F0:00.8502-03-0001353-2115', ['8502-03-0001353-2115', 65776, 0]],
|
|
66
|
+
])('should for id "%s" return tuple %j', (id, expected) => {
|
|
67
|
+
const result = splitDeviceParameterId(id);
|
|
68
|
+
|
|
69
|
+
expect(result).toEqual(expected);
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
test.each([
|
|
73
|
+
['0x12:7B.8502-03-0001353-2115'],
|
|
74
|
+
['0x1234:F.8502-03-0001353-2115'],
|
|
75
|
+
['0x1234:FG.8502-03-0001353-2115'],
|
|
76
|
+
['0x1234:7B.8502-03-ABC1353-2115'],
|
|
77
|
+
['0x1234:7B.8502_03_0001353_2115'],
|
|
78
|
+
['0x1H34:7B.8502-03-0001353-2115'],
|
|
79
|
+
])('should throw error for id "%s"', (id) => {
|
|
80
|
+
expect(() => splitDeviceParameterId(id)).toThrow();
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
});
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { makeParameterId, Parameter } from "./parameter";
|
|
2
|
+
|
|
3
|
+
export interface DeviceParameter extends Parameter {
|
|
4
|
+
id: string;
|
|
5
|
+
flags?: {
|
|
6
|
+
access?: 'ro' | 'rw' | 'wo'; // readonly (default), readwrite, writeonly
|
|
7
|
+
category?: 'm' | 'o' | 'c'; // mandatory, optional (default), conditional
|
|
8
|
+
pdoMapping?: 't' | 'r' | 'tr'; // Transmit PDO (Inputs), Receive PDO (Outputs), Transmit or Receive PDO
|
|
9
|
+
safetyMapping?: 'si' | 'so' | 'sio' | 'sp'; // Safe Inputs, Safe Outputs, Safe Input or Output, Safety Parameter Set
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Make device parameter id by providing a device serial number and tuple of index and subindex.
|
|
15
|
+
*
|
|
16
|
+
* @param serialNumber - device serial number from the hardware description file
|
|
17
|
+
* @param tuple - an array of index and subindex
|
|
18
|
+
* @throws {Error} if index or subindex are less than 0
|
|
19
|
+
* @returns combined index and subindex in uppercase hexadecimal format, e.g. "0x60FE:02"
|
|
20
|
+
*/
|
|
21
|
+
export function makeDeviceParameterId(serialNumber: string, tuple: [(number | null | undefined), (number | null | undefined)]): string;
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Make device parameter id by providing a device serial number and object which has index and subindex properties.
|
|
25
|
+
*
|
|
26
|
+
* @param serialNumber - device serial number from the hardware description file
|
|
27
|
+
* @param parameter - an object with optional index and subindex properties
|
|
28
|
+
* @throws {Error} if index or subindex are less than 0
|
|
29
|
+
* @returns combined index and subindex in uppercase hexadecimal format, e.g. "0x60FE:02"
|
|
30
|
+
*/
|
|
31
|
+
export function makeDeviceParameterId(serialNumber: string, parameter: { index?: (number | null), subindex?: (number | null) }): string;
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Make parameter id by providing a device serial number and index and subindex.
|
|
35
|
+
*
|
|
36
|
+
* @param serialNumber - device serial number from the hardware description file
|
|
37
|
+
* @param index - from 0x0000 to 0xFFFF for objects defined in ESI and >0xFFFF for custom object
|
|
38
|
+
* @param subindex - defaults to 0 if not provided
|
|
39
|
+
* @throws {Error} if index or subindex are less than 0
|
|
40
|
+
* @returns combined index and subindex in uppercase hexadecimal format, e.g. "0x60FE:02"
|
|
41
|
+
*/
|
|
42
|
+
export function makeDeviceParameterId(serialNumber: string, index?: (number | null), subindex?: (number | null)): string;
|
|
43
|
+
|
|
44
|
+
export function makeDeviceParameterId(serialNumber: string, a?: (number | null) | { index?: (number | null), subindex?: (number | null) } | [(number | null | undefined), (number | null | undefined)], b?: (number | null)): string {
|
|
45
|
+
const parameterId = makeParameterId(a, b);
|
|
46
|
+
return `${parameterId}.${serialNumber}`;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Example of device parameter id is "0x2110:1A.8502-03-0001353-2115" where:
|
|
51
|
+
* - 0x2110 is object index in hexadecimal format
|
|
52
|
+
* - 1A is subindex in hexadecimal format
|
|
53
|
+
* - 8502-03-0001353-2115 is device serial number from hardware description file
|
|
54
|
+
*/
|
|
55
|
+
export const deviceParameterIdRegExp = /^0x([0-9a-fA-F]{4,}):([0-9a-fA-F]{2})\.([\d-]+)$/;
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Split device parameter id into parts.
|
|
59
|
+
*
|
|
60
|
+
* @param id - device parameter id like "0x2110:1A.8502-03-0001353-2115"
|
|
61
|
+
* @returns tuple of device serial number, index, and subindex
|
|
62
|
+
*/
|
|
63
|
+
export function splitDeviceParameterId(id: string): [string, number, number] {
|
|
64
|
+
const match = id.match(deviceParameterIdRegExp);
|
|
65
|
+
|
|
66
|
+
if (!match) {
|
|
67
|
+
throw new Error(`Device parameter id "${id}" doesn't match the regular expression: ${deviceParameterIdRegExp}`);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
return [
|
|
71
|
+
match[3], // device serial number
|
|
72
|
+
parseInt(match[1], 16), // index
|
|
73
|
+
parseInt(match[2], 16), // subindex
|
|
74
|
+
];
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function isDeviceParameterId(id: string): boolean {
|
|
78
|
+
return deviceParameterIdRegExp.test(id);
|
|
79
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
Object.assign(global, { WebSocket: require('ws') });
|
|
2
|
+
|
|
3
|
+
import { forkJoin, mergeMap, lastValueFrom } from "rxjs";
|
|
4
|
+
import { createMotionMasterClient } from "../motion-master-client";
|
|
5
|
+
|
|
6
|
+
const client = createMotionMasterClient('192.168.1.112');
|
|
7
|
+
|
|
8
|
+
(async () => {
|
|
9
|
+
const devices = await lastValueFrom(client.request.getDevices());
|
|
10
|
+
const versions = await Promise.all(devices.map((device) => client.request.upload<string>(device.deviceAddress, 0x100A, 0)));
|
|
11
|
+
console.log(versions);
|
|
12
|
+
})();
|
|
13
|
+
|
|
14
|
+
client.request.getDevices().pipe(
|
|
15
|
+
mergeMap((devices) => forkJoin(devices.map((device) => client.request.getParameterValue<string>(device.deviceAddress, 0x100A, 0)))),
|
|
16
|
+
).subscribe(console.log);
|
|
17
|
+
|
|
18
|
+
setTimeout(() => client.closeSockets(), 5000);
|
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
import {
|
|
2
|
+
getAllComponentsFromHardwareDescription,
|
|
3
|
+
getApiIdentifierFromHardwareDescription,
|
|
4
|
+
getNameFromHardwareDescription,
|
|
5
|
+
getSerialNumberFromHardwareDescription,
|
|
6
|
+
hardwareComponentsMatch,
|
|
7
|
+
HardwareDescription,
|
|
8
|
+
} from './hardware-description';
|
|
9
|
+
|
|
10
|
+
describe('getApiIdentifierFromHardwareDescription', () => {
|
|
11
|
+
it('should return api identifier from assembly', () => {
|
|
12
|
+
const result = getApiIdentifierFromHardwareDescription({
|
|
13
|
+
assembly: { id: 'foo', version: '01', serialNumber: 'foo-sn' }, // prefer assembly over device
|
|
14
|
+
device: { id: 'bar', version: '02', serialNumber: 'bar-sn' },
|
|
15
|
+
fileVersion: '',
|
|
16
|
+
} as HardwareDescription);
|
|
17
|
+
|
|
18
|
+
expect(result).toBe('foo-01');
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
it('should return api identifier from device', () => {
|
|
22
|
+
const result = getApiIdentifierFromHardwareDescription({
|
|
23
|
+
device: { id: 'bar', version: '02', serialNumber: 'bar-sn' },
|
|
24
|
+
fileVersion: '',
|
|
25
|
+
} as HardwareDescription);
|
|
26
|
+
|
|
27
|
+
expect(result).toBe('bar-02');
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
it('should return api identifier from device having keyId', () => {
|
|
31
|
+
const result = getApiIdentifierFromHardwareDescription({
|
|
32
|
+
device: { id: 'bar', version: '02', serialNumber: 'bar-sn', keyId: '1234' },
|
|
33
|
+
fileVersion: '',
|
|
34
|
+
} as HardwareDescription);
|
|
35
|
+
|
|
36
|
+
expect(result).toBe('bar-02-1234');
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it('should return api identifier from device when having both assembly and keyId', () => {
|
|
40
|
+
const result = getApiIdentifierFromHardwareDescription({
|
|
41
|
+
assembly: { id: 'asm', version: '09', serialNumber: 'asm-sn', name: 'Assembly' },
|
|
42
|
+
device: { id: 'bar', version: '02', serialNumber: 'bar-sn', keyId: '3388' },
|
|
43
|
+
fileVersion: '',
|
|
44
|
+
} as HardwareDescription);
|
|
45
|
+
|
|
46
|
+
expect(result).toBe('asm-09-3388');
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
it('should skip keyId in cases when product image needs to be fetched by api identifier without keyId', () => {
|
|
50
|
+
const result = getApiIdentifierFromHardwareDescription({
|
|
51
|
+
device: { id: 'bar', version: '02', serialNumber: 'bar-sn', keyId: '1234' },
|
|
52
|
+
fileVersion: '',
|
|
53
|
+
} as HardwareDescription, true);
|
|
54
|
+
|
|
55
|
+
expect(result).toBe('bar-02');
|
|
56
|
+
});
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
describe('getNameFromHardwareDescription', () => {
|
|
60
|
+
it('should return name from assembly', () => {
|
|
61
|
+
const result = getNameFromHardwareDescription({
|
|
62
|
+
assembly: { id: 'foo', version: '01', serialNumber: 'foo-sn', name: 'Assembly' }, // prefer assembly over device
|
|
63
|
+
device: { id: 'bar', version: '02', serialNumber: 'bar-sn', name: 'Device' },
|
|
64
|
+
fileVersion: '',
|
|
65
|
+
} as HardwareDescription);
|
|
66
|
+
|
|
67
|
+
expect(result).toBe('Assembly');
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
it('should return name from device', () => {
|
|
71
|
+
const result = getNameFromHardwareDescription({
|
|
72
|
+
device: { id: 'bar', version: '02', serialNumber: 'bar-sn', name: 'Device' },
|
|
73
|
+
fileVersion: '',
|
|
74
|
+
} as HardwareDescription);
|
|
75
|
+
|
|
76
|
+
expect(result).toBe('Device');
|
|
77
|
+
});
|
|
78
|
+
});
|
|
79
|
+
|
|
80
|
+
describe('getSerialNumberFromHardwareDescription', () => {
|
|
81
|
+
it('should return serial number from assembly', () => {
|
|
82
|
+
const result = getSerialNumberFromHardwareDescription({
|
|
83
|
+
assembly: { id: 'foo', version: '01', serialNumber: 'foo-sn' }, // prefer assembly over device
|
|
84
|
+
device: { id: 'bar', version: '02', serialNumber: 'bar-sn' },
|
|
85
|
+
fileVersion: '',
|
|
86
|
+
} as HardwareDescription);
|
|
87
|
+
|
|
88
|
+
expect(result).toBe('foo-sn');
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
it('should return serial number from device', () => {
|
|
92
|
+
const result = getSerialNumberFromHardwareDescription({
|
|
93
|
+
device: { id: 'bar', version: '02', serialNumber: 'bar-sn' },
|
|
94
|
+
fileVersion: '',
|
|
95
|
+
} as HardwareDescription);
|
|
96
|
+
|
|
97
|
+
expect(result).toBe('bar-sn');
|
|
98
|
+
});
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
describe('getAllComponentsFromHardwareDescription', () => {
|
|
102
|
+
it('should return components only from device when assembly is undefined', () => {
|
|
103
|
+
const deviceComponents = [
|
|
104
|
+
{
|
|
105
|
+
name: 'Com EtherCAT',
|
|
106
|
+
serialNumber: '3333-33-3333333-3333',
|
|
107
|
+
version: 'B.2',
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
name: 'Core C2X',
|
|
111
|
+
serialNumber: '1111-11-1111111-1111',
|
|
112
|
+
version: 'A.5',
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
name: 'Drive 400',
|
|
116
|
+
serialNumber: '2222-22-2222222-2222',
|
|
117
|
+
version: 'E.1',
|
|
118
|
+
},
|
|
119
|
+
];
|
|
120
|
+
|
|
121
|
+
const hardwareDescription: HardwareDescription = {
|
|
122
|
+
device: {
|
|
123
|
+
components: deviceComponents,
|
|
124
|
+
id: '8503',
|
|
125
|
+
macAddress: '01-23-45-67-89-AB',
|
|
126
|
+
name: 'Circulo 9 1800 Encoder Pos 1 & 2',
|
|
127
|
+
serialNumber: '8506-01-040595-4023',
|
|
128
|
+
version: '02',
|
|
129
|
+
keyId: '1234',
|
|
130
|
+
},
|
|
131
|
+
fileVersion: '1.0.0',
|
|
132
|
+
};
|
|
133
|
+
|
|
134
|
+
const result = getAllComponentsFromHardwareDescription(hardwareDescription);
|
|
135
|
+
|
|
136
|
+
expect(result).toEqual(deviceComponents);
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
it('should return combined components from assembly and device', () => {
|
|
140
|
+
const assemblyComponents = [
|
|
141
|
+
{
|
|
142
|
+
name: 'Heidrive HMP04',
|
|
143
|
+
serialNumber: '79137447',
|
|
144
|
+
version: 'REV-2',
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
name: 'KEB gearbox',
|
|
148
|
+
serialNumber: '12344234',
|
|
149
|
+
version: 'REV-3',
|
|
150
|
+
},
|
|
151
|
+
];
|
|
152
|
+
|
|
153
|
+
const deviceComponents = [
|
|
154
|
+
{
|
|
155
|
+
name: 'Com EtherCAT',
|
|
156
|
+
serialNumber: '3333-33-3333333-3333',
|
|
157
|
+
version: 'B.2',
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
name: 'Core C2X',
|
|
161
|
+
serialNumber: '1111-11-1111111-1111',
|
|
162
|
+
version: 'A.5',
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
name: 'Drive 400',
|
|
166
|
+
serialNumber: '2222-22-2222222-2222',
|
|
167
|
+
version: 'E.1',
|
|
168
|
+
},
|
|
169
|
+
];
|
|
170
|
+
|
|
171
|
+
const hardwareDescription: HardwareDescription = {
|
|
172
|
+
assembly: {
|
|
173
|
+
components: assemblyComponents,
|
|
174
|
+
id: 'ASM',
|
|
175
|
+
name: 'Assembly',
|
|
176
|
+
serialNumber: '12345',
|
|
177
|
+
version: '01',
|
|
178
|
+
},
|
|
179
|
+
device: {
|
|
180
|
+
components: deviceComponents,
|
|
181
|
+
id: '8503',
|
|
182
|
+
macAddress: '01-23-45-67-89-AB',
|
|
183
|
+
name: 'Circulo 9 1800 Encoder Pos 1 & 2',
|
|
184
|
+
serialNumber: '8506-01-040595-4023',
|
|
185
|
+
version: '02',
|
|
186
|
+
keyId: '1234',
|
|
187
|
+
},
|
|
188
|
+
fileVersion: '1.0.0',
|
|
189
|
+
};
|
|
190
|
+
|
|
191
|
+
const result = getAllComponentsFromHardwareDescription(hardwareDescription);
|
|
192
|
+
|
|
193
|
+
expect(result).toEqual([...assemblyComponents, ...deviceComponents]);
|
|
194
|
+
});
|
|
195
|
+
});
|
|
196
|
+
|
|
197
|
+
describe('hardwareComponentsMatch', () => {
|
|
198
|
+
it('should return false when both arrays are empty', () => {
|
|
199
|
+
expect(hardwareComponentsMatch([], [])).toBe(false);
|
|
200
|
+
});
|
|
201
|
+
|
|
202
|
+
it('should return false when components don\'t match', () => {
|
|
203
|
+
const components1 = [
|
|
204
|
+
{ name: 'Com EtherCAT', serialNumber: '3333-33-3333333-3333', version: 'B.2' },
|
|
205
|
+
{ name: 'Core C2X', serialNumber: '1111-11-1111111-1111', version: 'A.5' },
|
|
206
|
+
];
|
|
207
|
+
const components2 = [
|
|
208
|
+
{ name: 'Com EtherCAT', serialNumber: '3333-33-3333333-3333', version: 'A.2' },
|
|
209
|
+
{ name: 'Core C22', serialNumber: '1111-11-1111111-1111', version: 'A.1' },
|
|
210
|
+
];
|
|
211
|
+
|
|
212
|
+
expect(hardwareComponentsMatch(components1, components2)).toBe(false);
|
|
213
|
+
});
|
|
214
|
+
|
|
215
|
+
it('should return true when components match', () => {
|
|
216
|
+
const components1 = [
|
|
217
|
+
{ name: 'Com EtherCAT', serialNumber: '3333-33-3333333-3333', version: 'B.2' },
|
|
218
|
+
{ name: 'Core C2X', serialNumber: '1111-11-1111111-1111', version: 'A.5' },
|
|
219
|
+
];
|
|
220
|
+
const components2 = [
|
|
221
|
+
{ name: 'Com EtherCAT', serialNumber: '3333-33-3333333-3333', version: 'B.2' },
|
|
222
|
+
{ name: 'Core C2X', serialNumber: '1111-11-1111111-1111', version: 'A.5' },
|
|
223
|
+
];
|
|
224
|
+
|
|
225
|
+
expect(hardwareComponentsMatch(components1, components2)).toBe(true);
|
|
226
|
+
});
|
|
227
|
+
|
|
228
|
+
it('should return true when components match but are not ordered the same', () => {
|
|
229
|
+
const components1 = [
|
|
230
|
+
{ name: 'Core C2X', serialNumber: '1111-11-1111111-1111', version: 'A.5' },
|
|
231
|
+
{ name: 'Com EtherCAT', serialNumber: '3333-33-3333333-3333', version: 'B.2' },
|
|
232
|
+
];
|
|
233
|
+
const components2 = [
|
|
234
|
+
{ name: 'Com EtherCAT', serialNumber: '3333-33-3333333-3333', version: 'B.2' },
|
|
235
|
+
{ name: 'Core C2X', serialNumber: '1111-11-1111111-1111', version: 'A.5' },
|
|
236
|
+
];
|
|
237
|
+
|
|
238
|
+
expect(hardwareComponentsMatch(components1, components2)).toBe(true);
|
|
239
|
+
});
|
|
240
|
+
|
|
241
|
+
it('should return true when revision numbers don\'t match', () => {
|
|
242
|
+
const components1 = [
|
|
243
|
+
{ name: 'Com EtherCAT', serialNumber: '3333-33-3333333-3333', version: 'B.2' },
|
|
244
|
+
{ name: 'Core C2X', serialNumber: '1111-11-1111111-1111', version: 'A.5' },
|
|
245
|
+
];
|
|
246
|
+
const components2 = [
|
|
247
|
+
{ name: 'Com EtherCAT', serialNumber: '3333-33-3333333-3333', version: 'B.7' },
|
|
248
|
+
{ name: 'Core C2X', serialNumber: '1111-11-1111111-1111', version: 'A.2' },
|
|
249
|
+
];
|
|
250
|
+
|
|
251
|
+
expect(hardwareComponentsMatch(components1, components2)).toBe(true);
|
|
252
|
+
});
|
|
253
|
+
});
|