motion-master-client 0.0.21 → 0.0.22

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.
Files changed (126) hide show
  1. package/.babelrc +3 -0
  2. package/.eslintrc.json +18 -0
  3. package/jest.config.ts +16 -0
  4. package/motion-master.proto +1822 -0
  5. package/package.json +2 -17
  6. package/project.json +45 -0
  7. package/src/lib/cia402.spec.ts +77 -0
  8. package/src/lib/cia402.ts +414 -0
  9. package/src/lib/config-file.spec.ts +114 -0
  10. package/src/lib/config-file.ts +63 -0
  11. package/src/lib/device-log-line.ts +5 -0
  12. package/src/lib/device-parameter.spec.ts +85 -0
  13. package/src/lib/device-parameter.ts +79 -0
  14. package/src/lib/device.ts +10 -0
  15. package/src/lib/hardware-description.spec.ts +253 -0
  16. package/src/lib/hardware-description.ts +129 -0
  17. package/src/lib/logger.ts +5 -0
  18. package/src/lib/monitoring-config.ts +6 -0
  19. package/src/lib/{monitoring-entry.d.ts → monitoring-entry.ts} +5 -4
  20. package/src/lib/motion-master-client.ts +221 -0
  21. package/src/lib/motion-master-pub-sub-client.ts +95 -0
  22. package/src/lib/motion-master-pub-sub-socket.ts +40 -0
  23. package/src/lib/motion-master-pub-sub-web-socket.ts +78 -0
  24. package/src/lib/motion-master-pub-sub-worker-socket.ts +51 -0
  25. package/src/lib/motion-master-req-res-client.spec.ts +740 -0
  26. package/src/lib/motion-master-req-res-client.ts +2120 -0
  27. package/src/lib/motion-master-req-res-socket.ts +62 -0
  28. package/src/lib/motion-master-req-res-web-socket.ts +124 -0
  29. package/src/lib/motion-master-req-res-worker-socket.ts +87 -0
  30. package/src/lib/motion-master.proto.js +2 -2
  31. package/src/lib/operators.ts +90 -0
  32. package/src/lib/options.ts +12 -0
  33. package/src/lib/parameter.spec.ts +160 -0
  34. package/src/lib/parameter.ts +170 -0
  35. package/src/lib/product-id-range.ts +8 -0
  36. package/src/lib/request-status-resolver.ts +403 -0
  37. package/src/lib/system-log-line.ts +9 -0
  38. package/src/lib/{types.d.ts → types.ts} +74 -143
  39. package/src/lib/urls.ts +6 -0
  40. package/src/lib/util.ts +305 -0
  41. package/tsconfig.json +23 -0
  42. package/tsconfig.lib.json +10 -0
  43. package/tsconfig.spec.json +20 -0
  44. package/typedoc.json +10 -0
  45. package/src/index.js +0 -29
  46. package/src/index.js.map +0 -1
  47. package/src/lib/cia402.d.ts +0 -182
  48. package/src/lib/cia402.js +0 -392
  49. package/src/lib/cia402.js.map +0 -1
  50. package/src/lib/config-file.d.ts +0 -13
  51. package/src/lib/config-file.js +0 -50
  52. package/src/lib/config-file.js.map +0 -1
  53. package/src/lib/device-log-line.d.ts +0 -5
  54. package/src/lib/device-log-line.js +0 -3
  55. package/src/lib/device-log-line.js.map +0 -1
  56. package/src/lib/device-parameter.d.ts +0 -56
  57. package/src/lib/device-parameter.js +0 -39
  58. package/src/lib/device-parameter.js.map +0 -1
  59. package/src/lib/device.d.ts +0 -9
  60. package/src/lib/device.js +0 -3
  61. package/src/lib/device.js.map +0 -1
  62. package/src/lib/hardware-description.d.ts +0 -41
  63. package/src/lib/hardware-description.js +0 -94
  64. package/src/lib/hardware-description.js.map +0 -1
  65. package/src/lib/logger.d.ts +0 -1
  66. package/src/lib/logger.js +0 -8
  67. package/src/lib/logger.js.map +0 -1
  68. package/src/lib/monitoring-config.d.ts +0 -6
  69. package/src/lib/monitoring-config.js +0 -3
  70. package/src/lib/monitoring-config.js.map +0 -1
  71. package/src/lib/monitoring-entry.js +0 -3
  72. package/src/lib/monitoring-entry.js.map +0 -1
  73. package/src/lib/motion-master-client.d.ts +0 -52
  74. package/src/lib/motion-master-client.js +0 -151
  75. package/src/lib/motion-master-client.js.map +0 -1
  76. package/src/lib/motion-master-pub-sub-client.d.ts +0 -16
  77. package/src/lib/motion-master-pub-sub-client.js +0 -68
  78. package/src/lib/motion-master-pub-sub-client.js.map +0 -1
  79. package/src/lib/motion-master-pub-sub-socket.d.ts +0 -34
  80. package/src/lib/motion-master-pub-sub-socket.js +0 -3
  81. package/src/lib/motion-master-pub-sub-socket.js.map +0 -1
  82. package/src/lib/motion-master-pub-sub-web-socket.d.ts +0 -14
  83. package/src/lib/motion-master-pub-sub-web-socket.js +0 -67
  84. package/src/lib/motion-master-pub-sub-web-socket.js.map +0 -1
  85. package/src/lib/motion-master-pub-sub-worker-socket.d.ts +0 -14
  86. package/src/lib/motion-master-pub-sub-worker-socket.js +0 -42
  87. package/src/lib/motion-master-pub-sub-worker-socket.js.map +0 -1
  88. package/src/lib/motion-master-req-res-client.d.ts +0 -920
  89. package/src/lib/motion-master-req-res-client.js +0 -1680
  90. package/src/lib/motion-master-req-res-client.js.map +0 -1
  91. package/src/lib/motion-master-req-res-socket.d.ts +0 -52
  92. package/src/lib/motion-master-req-res-socket.js +0 -3
  93. package/src/lib/motion-master-req-res-socket.js.map +0 -1
  94. package/src/lib/motion-master-req-res-web-socket.d.ts +0 -24
  95. package/src/lib/motion-master-req-res-web-socket.js +0 -99
  96. package/src/lib/motion-master-req-res-web-socket.js.map +0 -1
  97. package/src/lib/motion-master-req-res-worker-socket.d.ts +0 -20
  98. package/src/lib/motion-master-req-res-worker-socket.js +0 -69
  99. package/src/lib/motion-master-req-res-worker-socket.js.map +0 -1
  100. package/src/lib/operators.d.ts +0 -18
  101. package/src/lib/operators.js +0 -76
  102. package/src/lib/operators.js.map +0 -1
  103. package/src/lib/options.d.ts +0 -10
  104. package/src/lib/options.js +0 -14
  105. package/src/lib/options.js.map +0 -1
  106. package/src/lib/parameter.d.ts +0 -72
  107. package/src/lib/parameter.js +0 -119
  108. package/src/lib/parameter.js.map +0 -1
  109. package/src/lib/product-id-range.d.ts +0 -7
  110. package/src/lib/product-id-range.js +0 -12
  111. package/src/lib/product-id-range.js.map +0 -1
  112. package/src/lib/request-status-resolver.d.ts +0 -4
  113. package/src/lib/request-status-resolver.js +0 -345
  114. package/src/lib/request-status-resolver.js.map +0 -1
  115. package/src/lib/system-log-line.d.ts +0 -9
  116. package/src/lib/system-log-line.js +0 -3
  117. package/src/lib/system-log-line.js.map +0 -1
  118. package/src/lib/types.js +0 -28
  119. package/src/lib/types.js.map +0 -1
  120. package/src/lib/urls.d.ts +0 -3
  121. package/src/lib/urls.js +0 -10
  122. package/src/lib/urls.js.map +0 -1
  123. package/src/lib/util.d.ts +0 -40
  124. package/src/lib/util.js +0 -316
  125. package/src/lib/util.js.map +0 -1
  126. /package/src/{index.d.ts → index.ts} +0 -0
@@ -0,0 +1,63 @@
1
+ import * as Papa from 'papaparse';
2
+ import { Parameter, parametersCompareFn } from './parameter';
3
+ import { Optional } from './types';
4
+
5
+ export type ConfigParameter = Optional<Parameter, 'name' | 'typeValue'>;
6
+
7
+ export class ConfigFile {
8
+
9
+ readonly apiId?: string;
10
+ readonly firmwareVersion?: string;
11
+ readonly header?: string;
12
+
13
+ parameters: ConfigParameter[];
14
+
15
+ constructor(
16
+ public readonly content: string,
17
+ public readonly file?: Pick<File, 'name' | 'type' | 'size' | 'lastModified'>,
18
+ ) {
19
+ const parseResult = Papa.parse<string[]>(content, {
20
+ skipEmptyLines: true,
21
+ transform: (value: string) => value.trim(),
22
+ });
23
+
24
+ if (parseResult?.errors?.length > 0) {
25
+ throw new Error('Failed to parse the config csv file');
26
+ }
27
+
28
+ const matchApiId = content.match(/^#\s+(\d{4}-\d{2})$/m);
29
+ if (matchApiId) {
30
+ this.apiId = matchApiId[1];
31
+ }
32
+
33
+ const matchFirmwareVersion = content.match(/^#\s+(v\d.*)$/m);
34
+ if (matchFirmwareVersion) {
35
+ this.firmwareVersion = matchFirmwareVersion[1];
36
+ }
37
+
38
+ const matchFirstParameterRow = content.match(/^0x\d{4}/m);
39
+ if (matchFirstParameterRow?.index) {
40
+ this.header = content.slice(0, matchFirstParameterRow.index - 1);
41
+ }
42
+
43
+ this.parameters = parseResult.data
44
+ .filter(([c0]) => c0.startsWith('0x'))
45
+ .map(([c0, c1, c2]) => {
46
+ const index = parseInt(c0, 16);
47
+ const subindex = parseInt(c1, 10);
48
+ const numValue = Number(c2);
49
+ const value = isNaN(numValue) ? c2 : numValue;
50
+ return { index, subindex, value };
51
+ })
52
+ .sort(parametersCompareFn);
53
+ }
54
+
55
+ toString(): string {
56
+ let out = this.parameters.map((p) => `0x${p.index?.toString(16)}, ${p.subindex?.toString(10)}, ${p.value}`).join('\n');
57
+ if (this.header) {
58
+ out = this.header + '\n' + out;
59
+ }
60
+ return out + '\n';
61
+ }
62
+
63
+ }
@@ -0,0 +1,5 @@
1
+ export interface DeviceLogLine {
2
+ time: string;
3
+ level: string;
4
+ message: string;
5
+ }
@@ -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,10 @@
1
+ import { HardwareDescription } from "./hardware-description";
2
+
3
+ export interface Device {
4
+ id: string;
5
+ deviceAddress: number;
6
+ type?: number,
7
+ position?: number;
8
+ alias?: number;
9
+ hardwareDescription?: HardwareDescription;
10
+ }
@@ -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
+ });
@@ -0,0 +1,129 @@
1
+ import { isEqual } from 'lodash';
2
+ import semver from 'semver';
3
+
4
+ export interface HardwareComponent {
5
+ name: string;
6
+ version: string;
7
+ serialNumber: string;
8
+ }
9
+
10
+ export type AssemblyComponent = HardwareComponent;
11
+ export type DeviceComponent = HardwareComponent;
12
+
13
+ export interface Assembly {
14
+ name: string;
15
+ id: string;
16
+ version: string;
17
+ serialNumber: string;
18
+ components: AssemblyComponent[];
19
+ }
20
+
21
+ export interface HardwareDevice {
22
+ name: string;
23
+ id: string;
24
+ version: string;
25
+ keyId: string;
26
+ serialNumber: string;
27
+ macAddress: string;
28
+ components: DeviceComponent[];
29
+ }
30
+
31
+ /**
32
+ * @link https://docs.google.com/document/d/1N00-ZjxHkjoWNIsnoTtza9CUHrxm8-e54298DXLuD94
33
+ */
34
+ export interface HardwareDescription {
35
+ fileVersion: string;
36
+ assembly?: Assembly;
37
+ device: HardwareDevice;
38
+ }
39
+
40
+ export function getIdFromHardwareDescription(hd: HardwareDescription): string {
41
+ return hd.assembly
42
+ ? hd.assembly.id
43
+ : hd.device.id;
44
+ }
45
+
46
+ export function getApiIdentifierFromHardwareDescription(hd: HardwareDescription, skipKeyId = false): string {
47
+ let apiId = hd.assembly
48
+ ? `${hd.assembly.id}-${hd.assembly.version}`
49
+ : `${hd.device.id}-${hd.device.version}`;
50
+
51
+ if (!skipKeyId && hd.device.keyId) {
52
+ apiId += `-${hd.device.keyId}`;
53
+ }
54
+
55
+ return apiId;
56
+ }
57
+
58
+ export function getNameFromHardwareDescription(hd: HardwareDescription): string {
59
+ return hd.assembly
60
+ ? hd.assembly.name
61
+ : hd.device.name;
62
+ }
63
+
64
+ export function getSerialNumberFromHardwareDescription(hd: HardwareDescription): string {
65
+ return hd.assembly
66
+ ? hd.assembly.serialNumber
67
+ : hd.device.serialNumber;
68
+ }
69
+
70
+ export function getAllComponentsFromHardwareDescription(hd: HardwareDescription): HardwareComponent[] {
71
+ return hd.assembly
72
+ ? [...hd.assembly.components, ...hd.device.components]
73
+ : hd.device.components;
74
+ }
75
+
76
+ export function hardwareComponentsMatch(a: HardwareComponent[], b: HardwareComponent[]): boolean {
77
+ if (a.length === 0 && b.length === 0) {
78
+ return false; // edge case: when both components are empty they don't match since there are no components to compare
79
+ }
80
+
81
+ const ac = a.map((c) => `${c.name}-${c.version[0]}`.replace(/\s/g, '').toLocaleLowerCase()).sort();
82
+ const bc = b.map((c) => `${c.name}-${c.version[0]}`.replace(/\s/g, '').toLocaleLowerCase()).sort();
83
+
84
+ return isEqual(ac, bc);
85
+ }
86
+
87
+ export function isHardwareDescriptionCompatibleWithPackageFilename(hardwareDescription: HardwareDescription, packageFilename: string): boolean {
88
+ const hdApiId = getApiIdentifierFromHardwareDescription(hardwareDescription);
89
+ const pfApiId = getApiIdentifierFromPackageFilename(packageFilename);
90
+
91
+ if (hdApiId && pfApiId) {
92
+ return hdApiId === pfApiId;
93
+ } else {
94
+ const pfComponents = getHardwareComponentsFromPackageFilename(packageFilename);
95
+ const hdComponents = getAllComponentsFromHardwareDescription(hardwareDescription);
96
+ return hardwareComponentsMatch(pfComponents, hdComponents);
97
+ }
98
+ }
99
+
100
+ export function getHardwareComponentsFromPackageFilename(packageFilename: string): HardwareComponent[] {
101
+ if (packageFilename.match(/_Com[^_]+_Core[^_]+_Drive/g)) {
102
+ return packageFilename.split('_').slice(1, 4).map((b) => { // ['ComEtherCAT-b', 'CoreC2X-a', 'Drive400-d']
103
+ const p = b.split('-'); // ['ComEtherCAT', 'b']
104
+ return {
105
+ name: p[0],
106
+ serialNumber: '',
107
+ version: p[1],
108
+ } as HardwareComponent;
109
+ });
110
+ } else {
111
+ // not all package filenames have components,
112
+ // e.g. 'package_SOMANET-Servo-Node-Circulo-1800_circulo1800_motion-drive_v4.2.0-beta.5.zip'
113
+ return [];
114
+ }
115
+ }
116
+
117
+ export function getVersionFromPackageFilename(packageFilename: string) {
118
+ const parts = packageFilename.split('_');
119
+ const version = parts[parts.length - 1].replace(/\.zip$/, '').split(/\s+/)[0];
120
+ return semver.valid(version) ? version : undefined;
121
+ }
122
+
123
+ export function getApiIdentifierFromPackageFilename(packageFilename: string) {
124
+ if (packageFilename.match(/_Com[^_]+_Core[^_]+_Drive/g)) {
125
+ return undefined;
126
+ }
127
+ const [, , apiIdentifier] = packageFilename.split('_');
128
+ return apiIdentifier;
129
+ }
@@ -0,0 +1,5 @@
1
+ import { Roarr } from 'roarr';
2
+
3
+ export const logger = Roarr.child({
4
+ package: '@synapticon/motion-master-client'
5
+ });
@@ -0,0 +1,6 @@
1
+ export interface MonitoringConfig {
2
+ readonly bufferSize?: number;
3
+ readonly distinct?: boolean;
4
+ readonly messageId: string;
5
+ readonly topic: string;
6
+ }
@@ -1,9 +1,10 @@
1
1
  import { Observable } from "rxjs";
2
2
  import { MonitoringConfig } from "./monitoring-config";
3
3
  import { MotionMasterMessage, ParameterValueType } from "./types";
4
+
4
5
  export interface MonitoringEntry {
5
- config: MonitoringConfig;
6
- interval: number;
7
- values$: Observable<ParameterValueType[]>;
8
- parameters: MotionMasterMessage.Request.GetDeviceParameterValues.IParameter[];
6
+ config: MonitoringConfig;
7
+ interval: number;
8
+ values$: Observable<ParameterValueType[]>;
9
+ parameters: MotionMasterMessage.Request.GetDeviceParameterValues.IParameter[];
9
10
  }