@zimo-elektronik/zcan 1.0.51 → 1.0.53

package/.prettierrc.json

@@ -4,5 +4,7 @@
   "singleQuote": true,
   "trailingComma": "all",
   "endOfLine": "auto",
-  "tabWidth": 2
+  "tabWidth": 4,
+  "useTabs": true,
+  "printWidth": 120
 }

package/__tests__/accessoriesGroup.test.ts

@@ -1,39 +1,39 @@
 import {createMX10, initConnection} from './util';
 import {afterAll, beforeAll, describe, expect, it} from '@jest/globals';
-import {AccessoryMode, AccessoryPortState} from '../src';
+import {AccessoryMode} from '../src';
 
 describe('Accessories group tests - 0x01', () => {
-  const mx10 = createMX10(true);
-  const nid = 0x300a; // nid:10
+	const mx10 = createMX10(true);
+	const nid = 0x300a; // nid:10
 
-  beforeAll(async () => {
-    await initConnection(mx10);
-  });
+	beforeAll(async () => {
+		await initConnection(mx10);
+	});
 
-  afterAll(() => {
-    mx10.closeSocket();
-  });
+	afterAll(() => {
+		mx10.closeSocket();
+	});
 
-  it('0x01 - Accessory Mode test', () => {
-    mx10.accessoryCommand.accessoryModeByNid(nid);
+	it('0x01 - Accessory Mode test', () => {
+		mx10.accessoryCommand.accessoryModeByNid(nid);
 
-    const test = mx10.accessoryCommand.onAccessoryMode.subscribe((data) => {
-      expect(data.nid).toBe(nid);
-      expect(data.mode).toBeDefined();
-      expect(data.mode).toBe(AccessoryMode.PAIRED);
+		const test = mx10.accessoryCommand.onAccessoryMode.subscribe((data) => {
+			expect(data.nid).toBe(nid);
+			expect(data.mode).toBeDefined();
+			expect(data.mode).toBe(AccessoryMode.PAIRED);
 
-      test.unsubscribe();
-    });
-  });
+			test.unsubscribe();
+		});
+	});
 
-  it('0x02 - Accessory Port test', async () => {
-    mx10.accessoryCommand.accessoryPortByNid(nid);
+	it('0x02 - Accessory Port test', async () => {
+		mx10.accessoryCommand.accessoryPortByNid(nid);
 
-    const test = mx10.accessoryCommand.onAccessoryPort.subscribe((data) => {
-      expect(data.nid).toBe(nid);
-      expect(data.port).toBeDefined();
+		const test = mx10.accessoryCommand.onAccessoryPort.subscribe((data) => {
+			expect(data.nid).toBe(nid);
+			expect(data.port).toBeDefined();
 
-      test.unsubscribe();
-    });
-  });
+			test.unsubscribe();
+		});
+	});
 });

package/__tests__/connection.test.ts

@@ -3,56 +3,56 @@ import {afterAll, beforeAll, it, jest, describe, expect} from "@jest/globals";
 import {createMX10, initConnection} from "./util";
 
 describe('High level tests', () => {
-  const mx10 = createMX10(true);
-  const debug = global.console.debug;
-
-  afterEach(() => {
-    mx10.closeSocket()
-  })
-
-  beforeAll(() => {
-    global.console.debug = jest.fn();
-  })
-
-  afterAll(() => {
-    global.console.debug = debug;
-  })
-
-  it("Correct url test", async () => {
-    expect(mx10.connected).toBe(false);
-
-    return initConnection(mx10).then(() => {
-        expect(mx10.connected).toBe(true);
-
-        mx10.closeSocket();
-        expect(mx10.connected).toBe(false);
-    })
-  });
-
-  it("Incorrect url test", async () => {
-    expect(mx10.connected).toBe(false);
-    const res = mx10.initSocket(createSocket, "192.168.2.145");
-    await expect(res).rejects.toThrow('mx10.connection.timeout')
-
-    expect(mx10.connected).toBe(false);
-  });
-
-  it("Error logger test", (done) => {
-    mx10.logError.subscribe((error: string) => {
-      expect(error).toBe('mx10.connection.not_connected')
-      done();
-    })
-
-    mx10.network.ping();
-  })
-
-  it("Incorrect data format", () => {
-    expect(() => {
-      mx10.sendData(0x00, 0x00, [
-        {length: 1, value: 1,},
-        {length: 4, value: 1234,},
-        {length: 8, value: 0,}
-      ])
-    }).toThrow(/ELEMENT LENGTH NOT DEFINED.*/)
-  })
+	const mx10 = createMX10(true);
+	const debug = global.console.debug;
+
+	afterEach(() => {
+		mx10.closeSocket()
+	})
+
+	beforeAll(() => {
+		global.console.debug = jest.fn();
+	})
+
+	afterAll(() => {
+		global.console.debug = debug;
+	})
+
+	it("Correct url test", async () => {
+		expect(mx10.connected).toBe(false);
+
+		return initConnection(mx10).then(() => {
+				expect(mx10.connected).toBe(true);
+
+				mx10.closeSocket();
+				expect(mx10.connected).toBe(false);
+		})
+	});
+
+	it("Incorrect url test", async () => {
+		expect(mx10.connected).toBe(false);
+		const res = mx10.initSocket(createSocket, "192.168.2.145");
+		await expect(res).rejects.toThrow('mx10.connection.timeout')
+
+		expect(mx10.connected).toBe(false);
+	});
+
+	it("Error logger test", (done) => {
+		mx10.logError.subscribe((error: string) => {
+			expect(error).toBe('mx10.connection.not_connected')
+			done();
+		})
+
+		mx10.network.ping();
+	})
+
+	it("Incorrect data format", () => {
+		expect(() => {
+			mx10.sendData(0x00, 0x00, [
+				{length: 1, value: 1,},
+				{length: 4, value: 1234,},
+				{length: 8, value: 0,}
+			])
+		}).toThrow(/ELEMENT LENGTH NOT DEFINED.*/)
+	})
 });

package/__tests__/dataGroup.test.ts

@@ -1,98 +1,88 @@
 import {createMX10, initConnection} from './util';
 import {afterAll, beforeAll, describe, expect, it} from '@jest/globals';
 import {firstValueFrom} from 'rxjs';
-import {FxInfoType, ImageType, NameType} from '../src';
+import {FxConfigType, ImageType, NameType} from '../src';
 
 describe('Data group tests - 0x07', () => {
-  const mx10 = createMX10(true);
-
-  beforeAll(async () => {
-    await initConnection(mx10);
-  });
-
-  afterAll(() => {
-    mx10.closeSocket();
-  });
-
-  it('0x00 - Group count test', (done) => {
-    mx10.data.groupCount();
-
-    const sub = mx10.data.onGroupCount.subscribe((data) => {
-      if (data.objectType === 0x0000) {
-        expect(data.objectType).toBe(0x000);
-        expect(data.number).toBeDefined();
-
-        done();
-        sub.unsubscribe();
-      }
-    });
-  });
-
-  it('0x01 - List item by index test', async () => {
-    mx10.data.listItemsByIndex(0x0000, 3);
-
-    const data = await firstValueFrom(mx10.data.onListItemsByIndex);
-
-    expect(data.index).toBe(3);
-    expect(data.nid).toBe(4);
-  });
-
-  it('0x02 - List item by nid test', async () => {
-    mx10.data.listItemsByNID(3);
-
-    const data = await firstValueFrom(mx10.data.onListItemsByNID);
-    expect(data.nid).toBe(65535);
-    expect(data.index).toBe(65535);
-  });
-
-  it('0x1f - Remove locomotive with nid', async () => {
-    mx10.data.removeLocomotive(3);
-
-    const data = await firstValueFrom(mx10.data.onRemoveLocomotive);
-    expect(data.nid).toBe(3);
-    expect(data.state).toBeDefined();
-  });
-
-  it('0x12 - Image config test', async () => {
-    const promise = firstValueFrom(mx10.data.onItemImageConfig).then((data) => {
-      expect(data.nid).toBe(3);
-      expect(data.type).toBe(ImageType.VEHICLE);
-      expect(data.imageId).toBe(6055);
-    });
-
-    mx10.data.itemImageConfig(3, ImageType.VEHICLE, 6055);
-
-    return promise;
-  });
-
-  test.each<{icon: number; fx: number}>([
-    {icon: 755, fx: 1},
-    {icon: 756, fx: 1},
-    {icon: 700, fx: 1},
-  ])('0x15 - Function image change test', async ({icon, fx}) => {
-    const promise = firstValueFrom(mx10.data.onItemFxInfo).then((data) => {
-      expect(data.nid).toBe(3);
-      expect(data.function).toBe(fx);
-      expect(data.type).toBe(FxInfoType.ICON);
-      expect(data.data).toBe(icon);
-    });
-
-    mx10.data.itemFxInfo(3, fx, FxInfoType.ICON, icon);
-
-    return promise;
-  });
-
-  test.each<{name: string}>([
-    {name: '---'},
-    {name: 'teßt Öf a näme'},
-    {name: 'dodo1'},
-  ])('0x21 - Data name extended test', async ({name}) => {
-    mx10.data.dataNameExtended(3, 0, name);
-
-    const data = await firstValueFrom(mx10.data.onDataNameExtended);
-    expect(data.nid).toBe(3);
-    expect(data.type).toBe(NameType.VEHICLE);
-    expect(data.value1).toBe(undefined);
-    expect(data.name).toBe(name);
-  });
+	const mx10 = createMX10(true);
+
+	beforeAll(async () => {
+		await initConnection(mx10);
+	});
+
+	afterAll(() => {
+		mx10.closeSocket();
+	});
+
+	it('0x00 - Group count test',  async () => {
+		const msg = await mx10.data.groupCount();
+		expect(msg).toBeDefined();
+		expect(msg?.group()).toBe(0x0000);
+		expect(msg?.count()).toBeDefined();
+	});
+
+	it('0x01 - List item by index test', async () => {
+		const msg = await mx10.data.listItemsByIndex(0x0000, 3);
+
+		expect(msg).toBeDefined();
+		expect(msg?.index()).toBe(3);
+		expect(msg?.itemNid()).toBe(4);
+	});
+
+	it('0x02 - List item by nid test', async () => {
+		mx10.data.listItemsByNID(3);
+
+		const data = await firstValueFrom(mx10.data.onListItemsByNID);
+		expect(data.nid).toBe(65535);
+		expect(data.index).toBe(65535);
+	});
+
+	it('0x1f - Remove locomotive with nid', async () => {
+		mx10.data.removeLocomotive(3);
+
+		const data = await firstValueFrom(mx10.data.onRemoveLocomotive);
+		expect(data.nid).toBe(3);
+		expect(data.state).toBeDefined();
+	});
+
+	it('0x12 - Image config test', async () => {
+		const promise = firstValueFrom(mx10.data.onItemImageConfig).then((data) => {
+			expect(data.itemNid()).toBe(3);
+			expect(data.imageType()).toBe(ImageType.VEHICLE);
+			expect(data.imageId()).toBe(6055);
+		});
+
+		mx10.data.itemImageConfig(3, ImageType.VEHICLE, 6055);
+
+		return promise;
+	});
+
+	test.each<{icon: number; fx: number}>([
+		{icon: 755, fx: 1},
+		{icon: 756, fx: 1},
+		{icon: 700, fx: 1},
+	])('0x15 - Function image change test', async ({icon, fx}) => {
+		const promise = firstValueFrom(mx10.data.onItemFxConfig).then((data) => {
+			expect(data.nid).toBe(3);
+			expect(data.function).toBe(fx);
+			expect(data.item).toBe(FxConfigType.ICON);
+			expect(data.data).toBe(icon);
+		});
+
+		mx10.data.itemFxConfig(3, fx, FxConfigType.ICON, icon);
+
+		return promise;
+	});
+
+	test.each<{name: string}>([
+		{name: '---'},
+		{name: 'teßt Öf a näme'},
+		{name: 'dodo1'},
+	])('0x21 - Data name extended test', async ({name}) => {
+		const msg = await mx10.data.setName(3, 0, name);
+		expect(msg).toBeDefined();
+		expect(msg?.itemNid()).toBe(3);
+		expect(msg?.type()).toBe(NameType.VEHICLE);
+		expect(msg?.name()).toBe(name);
+	});
 });

package/__tests__/infoGroup.test.ts

@@ -2,29 +2,29 @@ import {createMX10, initConnection} from "./util";
 import {afterAll, beforeAll, expect, it} from "@jest/globals";
 
 describe('Info group tests - 0x08', () => {
-  const mx10 = createMX10();
+	const mx10 = createMX10();
 
-  beforeAll(async () => {
-    await initConnection(mx10)
-  })
+	beforeAll(async () => {
+		await initConnection(mx10)
+	})
 
-  afterAll(() => {
-    mx10.closeSocket();
-  })
+	afterAll(() => {
+		mx10.closeSocket();
+	})
 
-  it("0x05 - Bidi info - train speed", (done) => {
+	it("0x05 - Bidi info - train speed", (done) => {
 
-    const sub = mx10.info.onBidiInfoChange.subscribe((data) => {
-      if (data.type === 0x0100) {
+		const sub = mx10.info.onBidiInfoChange.subscribe((msg) => {
+			if (msg.type() === 0x0100) {
 
-        expect(data.nid).toBe(3);
-        expect(data.data).toBeDefined();
-        expect(data.data).toBeGreaterThanOrEqual(0);
+				expect(msg.nid()).toBe(3);
+				expect(msg.info()).toBeDefined();
+				expect(msg.info()).toBeGreaterThanOrEqual(0);
 
-        done();
-        sub.unsubscribe();
-      }
-    });
-  });
+				done();
+				sub.unsubscribe();
+			}
+		});
+	});
 
 });

package/__tests__/lanDataGroup.test.ts

@@ -1,82 +1,70 @@
 import {createMX10, initConnection} from './util';
 import {afterAll, beforeAll, describe, it, expect} from '@jest/globals';
 import {firstValueFrom} from 'rxjs';
-import {
-  DataValueExtendedData,
-  LocoGuiMXExtended,
-  LocoSpeedTabExtended,
-  OperatingMode,
-  Train,
-} from '../src';
+import {DataValueExtendedData, LocoSpeedTabExtended, OperatingMode} from '../src';
 
 describe('LAN Data group tests - 0x17', () => {
-  const mx10 = createMX10();
+	const mx10 = createMX10();
 
-  beforeAll(async () => {
-    await initConnection(mx10);
-  });
+	beforeAll(async () => {
+		await initConnection(mx10);
+	});
 
-  afterAll(() => {
-    mx10.closeSocket();
-  });
+	afterAll(() => {
+		mx10.closeSocket();
+	});
 
-  it('0x27 - Loco GUI eXtended', async () => {
-    mx10.lanData.locoGuiExtended(211);
+	// it('0x27 - Loco GUI eXtended', async () => {
+	// 	const msg = await mx10.lanData.getLocoGuiExtended(211);
+	// 	expect(msg).toBeDefined();
+	// 	expect(msg?.locoNid()).toBe(211);
+	// 	// expect(msg.name()).toMatch('import loco');
+	// 	expect(msg?.era()).toBeDefined();
+	// 	expect(msg?.functions()).toBeDefined();
+	// });
 
-    const train: Train = await firstValueFrom(mx10.lanData.onLocoGuiExtended);
-    expect(train).toBeDefined();
-    expect(train.nid).toBe(211);
-    // expect(train.name).toMatch('import loco');
-    expect(train.era).toBeDefined();
-    expect(train.functions).toBeDefined();
-  });
+	it('0x28 - Loco GUI eXtended', async () => {
+		const msg = await mx10.lanData.getLocoGuiExtended(211);
+		expect(msg).toBeDefined();
+		expect(msg?.locoNid()).toBe(211);
+		expect(msg?.functions()).toBeDefined();
+	});
 
-  it('0x28 - Loco GUI MX eXtended', async () => {
-    mx10.lanData.locoGuiMXExtended(211);
+	it('0x19 - Loco Speed Tab eXtended', async () => {
+		mx10.lanData.locoSpeedTapExtended(42);
 
-    const train: LocoGuiMXExtended = await firstValueFrom(
-      mx10.lanData.onLocoGuiMXExtended,
-    );
-    expect(train).toBeDefined();
-    expect(train.nid).toBe(211);
-    expect(train.functions).toBeDefined();
-  });
+		const locoSpeedTab: LocoSpeedTabExtended = await firstValueFrom(
+			mx10.lanData.onLocoSpeedTabExtended,
+		);
+		expect(locoSpeedTab).toBeDefined();
+		expect(locoSpeedTab.nid).toBe(42);
+		expect(locoSpeedTab.dbat6).toBe(1);
+		if (locoSpeedTab.dbat6 === 5) {
+			expect(locoSpeedTab.speedTab).toBeDefined();
+			expect(locoSpeedTab.speedTab).toHaveLength(4);
+		}
 
-  it('0x19 - Loco Speed Tab eXtended', async () => {
-    mx10.lanData.locoSpeedTapExtended(42);
+		// mx10.sendData(0x02, 0x01, [{value: 56, length: 2}]);
+		// expect(train.era).toBeDefined();
+		// expect(train.functions).toBeDefined();
+	});
 
-    const locoSpeedTab: LocoSpeedTabExtended = await firstValueFrom(
-      mx10.lanData.onLocoSpeedTabExtended,
-    );
-    expect(locoSpeedTab).toBeDefined();
-    expect(locoSpeedTab.nid).toBe(42);
-    expect(locoSpeedTab.dbat6).toBe(1);
-    if (locoSpeedTab.dbat6 === 5) {
-      expect(locoSpeedTab.speedTab).toBeDefined();
-      expect(locoSpeedTab.speedTab).toHaveLength(4);
-    }
+	it('0x8 - Data Value eXtended', async () => {
+		mx10.lanData.dataValueExtended(211);
 
-    // mx10.sendData(0x02, 0x01, [{value: 56, length: 2}]);
-    // expect(train.era).toBeDefined();
-    // expect(train.functions).toBeDefined();
-  });
+		const data: DataValueExtendedData = await firstValueFrom(
+			mx10.lanData.onDataValueExtended,
+		);
 
-  it('0x8 - Data Value eXtended', async () => {
-    mx10.lanData.dataValueExtended(211);
-
-    const data: DataValueExtendedData = await firstValueFrom(
-      mx10.lanData.onDataValueExtended,
-    );
-
-    expect(data).toBeDefined();
-    expect(data.nid).toBe(211);
-    expect(data.functionCount).toBeDefined();
-    expect(data.operatingMode).toBeDefined();
-    expect(data.operatingMode).toBe(OperatingMode.DCC);
-    expect(data.speedStep).toBeDefined();
-    expect(data.forward).toBeDefined();
-    expect(data.emergencyStop).toBeDefined();
-    expect(data.functionsStates).toBeDefined();
-    expect(data.flags.deleted).toBe(false);
-  });
+		expect(data).toBeDefined();
+		expect(data.nid).toBe(211);
+		expect(data.functionCount).toBeDefined();
+		expect(data.operatingMode).toBeDefined();
+		expect(data.operatingMode).toBe(OperatingMode.DCC);
+		expect(data.speedStep).toBeDefined();
+		expect(data.forward).toBeDefined();
+		expect(data.emergencyStop).toBeDefined();
+		expect(data.functionsStates).toBeDefined();
+		expect(data.flags.deleted).toBe(false);
+	});
 });

package/__tests__/lanInfoGroup.test.ts

@@ -3,39 +3,39 @@ import {afterAll, beforeAll, it, describe, expect} from "@jest/globals";
 import {TrackMode} from "../src";
 
 describe('LAN Info group tests - 0x18', () => {
-  const mx10 = createMX10();
-
-  beforeAll(async () => {
-    await initConnection(mx10)
-  })
-
-  afterAll(() => {
-    mx10.closeSocket();
-  })
-
-  it("0x00 - module power info", (done) => {
-    const sub = mx10.lanInfo.onModulePowerInfo.subscribe((data) => {
-      if (data.deviceNID === mx10.mx10NID) {
-
-        expect(data.port1Status).toBeDefined();
-        expect(data.port1Status).toBe(TrackMode.NORMAL);
-        expect(data.port1Voltage).toBeDefined();
-        expect(data.port1Amperage).toBeDefined();
-
-        expect(data.port2Status).toBeDefined();
-        expect(data.port2Status).toBe(TrackMode.NORMAL);
-        expect(data.port2Voltage).toBeDefined();
-        expect(data.port2Amperage).toBeDefined();
-
-        expect(data.amperage32V).toBeDefined();
-        expect(data.amperage12V).toBeDefined();
-        expect(data.voltageTotal).toBeDefined();
-        expect(data.temperature).toBeDefined();
-
-        sub.unsubscribe();
-        done();
-      }
-    })
-  })
+	const mx10 = createMX10();
+
+	beforeAll(async () => {
+		await initConnection(mx10)
+	})
+
+	afterAll(() => {
+		mx10.closeSocket();
+	})
+
+	it("0x00 - module power info", (done) => {
+		const sub = mx10.lanInfo.onModulePowerInfo.subscribe((data) => {
+			if (data.deviceNID === mx10.mx10NID) {
+
+				expect(data.port1Status).toBeDefined();
+				expect(data.port1Status).toBe(TrackMode.NORMAL);
+				expect(data.port1Voltage).toBeDefined();
+				expect(data.port1Amperage).toBeDefined();
+
+				expect(data.port2Status).toBeDefined();
+				expect(data.port2Status).toBe(TrackMode.NORMAL);
+				expect(data.port2Voltage).toBeDefined();
+				expect(data.port2Amperage).toBeDefined();
+
+				expect(data.amperage32V).toBeDefined();
+				expect(data.amperage12V).toBeDefined();
+				expect(data.voltageTotal).toBeDefined();
+				expect(data.temperature).toBeDefined();
+
+				sub.unsubscribe();
+				done();
+			}
+		})
+	})
 
 });