@zimo-elektronik/zcan 1.0.51 → 1.0.53

package/src/data/lanDataGroup.ts

@@ -1,8 +1,8 @@
 // 0x17
 import MX10 from '../MX10';
-import {FunctionMode, FxConfigType, getOperatingMode, MsgMode, OperatingMode} from '../common/enums';
-import {DataNameExtendedData, DataValueExtendedData, LocoGuiMXExtended, LocoSpeedTabExtended, SpeedTabData,
-	Train, TrainFlags, TrainFunction} from '../common/models';
+import {FxConfigType, getOperatingMode, MsgMode} from '../common/enums';
+import {DataNameExtendedData, DataValueExtendedData, LocoSpeedTabExtended, SpeedTabData,
+	Train, TrainFlags} from '../common/models';
 import {Subject} from 'rxjs';
 import {parseSpeed} from '../common/speedUtils';
 import ExtendedASCII from '../common/extendedAscii';
@@ -17,13 +17,11 @@ import { MsgLocoGuiReq, MsgLocoGuiRsp } from './lanDataMsg';
 export default class LanDataGroup
 {
 	public readonly onLocoGuiExtended = new Subject<MsgLocoGuiRsp>();
-	// public readonly onOldLocoGuiExtended = new Subject<MsgOldLocoGuiRsp>();
 	public readonly onDataValueExtended = new Subject<DataValueExtendedData>();
 	public readonly onDataNameExtended = new Subject<DataNameExtendedData>();
 	public readonly onLocoSpeedTabExtended = new Subject<LocoSpeedTabExtended>();
 
 	private locoGuiQ: Query<MsgLocoGuiRsp> | undefined = undefined;
-	// private oldLocoGuiQ: Query<MsgOldLocoGuiRsp> | undefined = undefined;
 
 	private mx10: MX10;
 
@@ -140,50 +138,6 @@ export default class LanDataGroup
 		return rv;
 	}
 
-	// async oldLocoGuiExtended(nid: number): Promise<MsgOldLocoGuiRsp | undefined>
-	// {
-	// 	if(this.oldLocoGuiQ !== undefined && !await this.oldLocoGuiQ.lock()) {
-	// 		this.mx10.logInfo.next("mx10.locoGuiExtended: failed to acquire lock");
-	// 		return undefined;
-	// 	}
-	// 	this.oldLocoGuiQ = new Query(MsgOldLocoGuiReq.header(MsgMode.REQ, this.mx10.mx10NID), this.onOldLocoGuiExtended);
-	// 	this.oldLocoGuiQ.log = ((msg) => {
-	// 		this.mx10.logInfo.next(msg);
-	// 	});
-	// 	this.oldLocoGuiQ.tx = ((header) => {
-	// 		const msg = new MsgOldLocoGuiReq(header, nid, 0);
-	// 		this.mx10.logInfo.next('locoGuiExtended query tx: ' + JSON.stringify(msg));
-	// 		this.mx10.sendMsg(msg);
-	// 	});
-	// 	this.oldLocoGuiQ.match = ((msg) => {
-	// 		this.mx10.logInfo.next('locoGuiExtended query rx: ' + JSON.stringify(msg));
-	// 		return (msg.locoNid() === nid);
-	// 	})
-	// 	const rv = await this.oldLocoGuiQ.run();
-	// 	this.mx10.logInfo.next("mx10.locoGuiExtended.rv: " + JSON.stringify(rv));
-	// 	this.oldLocoGuiQ.unlock();
-	// 	this.oldLocoGuiQ = undefined;
-	// 	return rv;
-	// }
-
-	// locoGuiExtended(NID: number)
-	// {
-	// 	this.mx10.sendData(0x17, 0x27, [
-	// 		{value: this.mx10.mx10NID, length: 2},
-	// 		{value: NID, length: 2},
-	// 		{value: 0, length: 2},
-	// 	], 0b00);
-	// }
-
-	// locoGuiMXExtended(NID: number)
-	// {
-	// 	this.mx10.sendData(0x17,0x28, [
-	// 		{value: this.mx10.mx10NID, length: 2},
-	// 		{value: NID, length: 2},
-	// 		{value: 0, length: 2},
-	// 	], 0b00);
-	// }
-
 	locoSpeedTapExtended(NID: number)
 	{
 		this.mx10.sendData(0x17, 0x19, [
@@ -194,11 +148,6 @@ export default class LanDataGroup
 		], 0b00);
 	}
 
-	// mxUpdateFnIcons(destructuredBuffer: ZcanDataArray)
-	// {
-	// 	this.mx10.sendData(0x17, 0x28, destructuredBuffer, 0b01);
-	// }
-
 	parse(size: number, command: number, mode: number, nid: number, buffer: Buffer)
 	{
 		switch (command)
@@ -209,9 +158,6 @@ export default class LanDataGroup
 			case 0x10:
 				this.parseDataNameExtended(size, mode, nid, buffer);
 				break;
-			// case 0x27:
-			// 	this.parseOldLocoGuiExtended(size, mode, nid, buffer);
-			// 	break;
 			case 0x28:
 				this.parseLocoGuiExtended(size, mode, nid, buffer);
 				break;
@@ -360,29 +306,6 @@ export default class LanDataGroup
 		this.onLocoSpeedTabExtended.next({srcid: SrcID, nid: NID, dbat6: DBat6, speedTab: locoSpeedTab});
 	}
 
-	private parseEra(eraString: number)
-	{
-		switch (eraString & 0xf0)
-		{
-			case 0x10:
-				return 'I';
-			case 0x20:
-				return 'II';
-			case 0x30:
-				return 'III';
-			case 0x40:
-				return 'IV';
-			case 0x50:
-				return 'V';
-			case 0x60:
-				return 'VI';
-			case 0x70:
-				return 'VII';
-			default:
-				return '';
-		}
-	}
-
 	private parseFlags(flagsNumber: number): TrainFlags
 	{
 		return {deleted: flagsNumber >> 31 === 1};
@@ -392,16 +315,4 @@ export default class LanDataGroup
 	{
 		return parseDeletedFlag === 1;
 	}
-
-	private destructureBuffer(buffer: Buffer): ZcanDataArray
-	{
-		const values = [];
-		for (let i = 0; i < buffer.length; i += 2) {
-			values.push({
-				value: buffer.readUInt16LE(i),
-				length: 2,
-			});
-		}
-		return values;
-	}
 }

package/src/data/lanDataMsg.ts

@@ -3,73 +3,6 @@ import { Header, Message } from "../common/communication";
 import { TrainFunction } from "../docs_entrypoint";
 
 
-// export class MsgOldLocoGuiReq extends Message
-// {
-// 	public static header(mode: MsgMode, nid: number): Header
-// 	{return {group: 0x17, cmd: 0x27, mode: mode, nid: nid}}
-
-// 	constructor(header: Header, locoNid: number, subNid: number)
-// 	{
-// 		super(header);
-// 		super.push({value: locoNid, length: 2});
-// 		super.push({value: subNid, length: 2});
-// 	}
-// 	locoNid(): number {return (this.data[0].value as number)}
-// 	subNid(): number {return (this.data[1].value as number)}
-// }
-
-// export class MsgOldLocoGuiRsp extends Message
-// {
-// 	public static header(mode: MsgMode, nid: number): Header
-// 	{return {group: 0x17, cmd: 0x27, mode: mode, nid: nid}}
-
-// 	constructor(header: Header, locoNid: number, subNid: number, group: number, name: string, imageId: number,
-// 		tacho: number, speedFwd: number, speedRev: number, speedRange: number, driveType: number, era: number,
-// 		country: number, functions: number[])
-// 	{
-// 		super(header);
-// 		super.push({value: locoNid, length: 2});
-// 		super.push({value: subNid, length: 2});
-// 		super.push({value: group, length: 2});
-// 		super.push({value: name, length: 32});
-// 		super.push({value: imageId, length: 2});
-// 		super.push({value: tacho, length: 2});
-// 		super.push({value: speedFwd, length: 2});
-// 		super.push({value: speedRev, length: 2});
-// 		super.push({value: speedRange, length: 2});
-// 		super.push({value: driveType, length: 2});
-// 		super.push({value: era, length: 2});
-// 		super.push({value: country, length: 2});
-// 		functions.forEach(funk => {
-// 			super.push({value: funk, length: 2});
-// 		});
-// 	}
-// 	locoNid(): number {return (this.data[0].value as number)}
-// 	subNid(): number {return (this.data[1].value as number)}
-// 	group(): number {return (this.data[2].value as number)}
-// 	name(): string {return (this.data[3].value as string)}
-// 	imageId(): number {return (this.data[4].value as number)}
-// 	tacho(): number {return (this.data[5].value as number)}
-// 	speedFwd(): number {return (this.data[6].value as number)}
-// 	speedRev(): number {return (this.data[7].value as number)}
-// 	speedRange(): number {return (this.data[8].value as number)}
-// 	driveType(): number {return (this.data[9].value as number)}
-// 	era(): number {return (this.data[10].value as number)}
-// 	country(): number {return (this.data[11].value as number)}
-// 	functions(): Array<TrainFunction>
-// 	{
-// 		const rv = Array<TrainFunction>();
-// 		for (let i = 12; i < this.data.length; i++) {
-// 			const icon = (this.data[i].value as number);
-// 			const iconString = icon === 0 ? String(i).padStart(2, '0') : String(icon);
-// 			rv.push({mode: FunctionMode.switch, active: false,
-// 				icon: iconString.padStart(4, icon === 0 ? '07' : '0'),
-// 			});
-// 		}
-// 		return rv;
-// 	}
-// }
-
 export class MsgLocoGuiReq extends Message
 {
 	public static header(mode: MsgMode, nid: number): Header
@@ -146,16 +79,27 @@ export class MsgLocoGuiRsp extends Message
 		}
 		return rv;
 	}
-	// funModes(): Array<TrainFunction>
-	// {
-	// 	const rv = Array<TrainFunction>();
-	// 	for (let i = 12; i < this.data.length; i++) {
-	// 		const icon = (this.data[i].value as number);
-	// 		const iconString = icon === 0 ? String(i).padStart(2, '0') : String(icon);
-	// 		rv.push({mode: FunctionMode.switch, active: false,
-	// 			icon: iconString.padStart(4, icon === 0 ? '07' : '0'),
-	// 		});
-	// 	}
-	// 	return rv;
-	// }
+
+	public static parseEra(era: number)
+	{
+		switch (era & 0xf0)
+		{
+			case 0x10:
+				return 'I';
+			case 0x20:
+				return 'II';
+			case 0x30:
+				return 'III';
+			case 0x40:
+				return 'IV';
+			case 0x50:
+				return 'V';
+			case 0x60:
+				return 'VI';
+			case 0x70:
+				return 'VII';
+			default:
+				return '';
+		}
+	}
 }

package/src/info/infoGroup.ts

@@ -2,8 +2,7 @@ import {Buffer} from 'buffer';
 import MX10 from '../MX10';
 import {Subject} from 'rxjs';
 import {Query} from '../common/communication';
-import {BidiInfoData, BidiDirectionData} from '../common/models';
-import {BidiType, Direction, ForwardOrReverse, ModInfoType, MsgMode} from '../common/enums';
+import {ModInfoType, MsgMode} from '../common/enums';
 import {MsgBidiInfo, MsgModInfo} from './infoMsg';
 
 /**
@@ -111,41 +110,30 @@ export default class InfoGroup
 		const type = buffer.readUInt16LE(2);
 		const info = buffer.readUInt32LE(4);
 
-		let data: BidiDirectionData | number = {};
-		switch (type) {
-			case BidiType.DIRECTION:
-				data.direction = this.parseEastWest(info);
-				data.directionChange = this.parseDirChange(info);
-				data.directionConfirm = this.parseDirectionConfirm(info);
-				data.forwardOrReverse = this.parseFwdRev(info);
-				break;
-			default:
-				data = info;
-		}
 		const msg = new MsgBidiInfo(MsgBidiInfo.header(mode, NID), type, undefined, info);
 		this.onBidiInfoChange.next(msg);
 	}
 
-	private parseEastWest(data: number)
-	{
-		if ((data & 0x02) == 0x02)
-			return Direction.EAST;
-		return Direction.WEST;
-	}
+	// private parseEastWest(data: number)
+	// {
+	// 	if ((data & 0x02) == 0x02)
+	// 		return Direction.EAST;
+	// 	return Direction.WEST;
+	// }
 
-	private parseDirChange(data: number)
-	{
-		return (data & 0x04) == 0x04;
-	}
+	// private parseDirChange(data: number)
+	// {
+	// 	return (data & 0x04) == 0x04;
+	// }
 
-	private parseFwdRev(data: number)
-	{
-		if ((data & 0x01) == 0)
-			return ForwardOrReverse.REVERSE;
-		return ForwardOrReverse.FORWARD;
-	}
-	private parseDirectionConfirm(data: number)
-	{
-		return (data & 0x08) == 0x08;
-	}
+	// private parseFwdRev(data: number)
+	// {
+	// 	if ((data & 0x01) == 0)
+	// 		return ForwardOrReverse.REVERSE;
+	// 	return ForwardOrReverse.FORWARD;
+	// }
+	// private parseDirectionConfirm(data: number)
+	// {
+	// 	return (data & 0x08) == 0x08;
+	// }
 }

package/src/info/infoMsg.ts

@@ -40,4 +40,24 @@ export class MsgBidiInfo extends Message
 	nid(): number {return this.header.mode === MsgMode.REQ ? this.data[0].value as number : this.header.nid || 0}
 	type(): number {return this.data[this.header.mode === MsgMode.REQ ? 1 : 0].value as number}
 	info(): number | undefined {return this.data.length > 1 ? this.data[1].value as number : undefined}
+
+	public static dirEast(info: number)
+	{
+		return ((info & 0x02) == 0x02)
+	}
+
+	public static dirChanging(info: number)
+	{
+		return ((info & 0x04) == 0x04)
+	}
+
+	public static dirForward(info: number)
+	{
+		return ((info & 0x01) == 0x01)
+	}
+
+	public static dirConfirm(info: number)
+	{
+		return ((info & 0x08) == 0x08)
+	}
 }

package/src/loco/vehicleGroup.ts

@@ -1,12 +1,11 @@
 /* eslint-disable  @typescript-eslint/no-unused-vars */
 import MX10 from '../MX10';
 import {Subject} from 'rxjs';
-import {CallFunctionData, CallSpecialFunctionData, VehicleStateData} from '../common/models';
-import {Direction, Manual, MaxSpeedSteps, MsgMode, OperatingMode, ShuntingFunction, SpecialFunctionMode,
-} from '../common/enums';
+import {CallFunctionData} from '../common/models';
+import {Direction, Manual, MaxSpeedSteps, MsgMode, OperatingMode, SpecialFxNr} from '../common/enums';
 import {combineSpeedAndDirection} from '../common/speedUtils';
 import { Query } from '../common/communication';
-import { MsgVehicleLastCtl, MsgVehicleMode, MsgVehicleSpeed, MsgVehicleState } from './vehicleMsg';
+import { MsgSpecialFx, MsgVehicleLastCtl, MsgVehicleMode, MsgVehicleSpeed, MsgVehicleState } from './vehicleMsg';
 
 /**
  *
@@ -17,14 +16,15 @@ export default class VehicleGroup
 	public readonly onVehicleState = new Subject<MsgVehicleState>();
 	public readonly onVehicleLastCtl = new Subject<MsgVehicleLastCtl>();
 	public readonly onVehicleMode = new Subject<MsgVehicleMode>();
-	public readonly onVehicleSpeed = new Subject<MsgVehicleSpeed>();	// VehicleSpeedData
+	public readonly onVehicleSpeed = new Subject<MsgVehicleSpeed>();
 	public readonly onCallFunction = new Subject<CallFunctionData>();
-	public readonly onCallSpecialFunction = new Subject<CallSpecialFunctionData>();
+	public readonly onCallSpecialFunction = new Subject<MsgSpecialFx>();
 
 	private stateQ: Query<MsgVehicleState> | undefined = undefined;
 	private lastCtlQ: Query<MsgVehicleLastCtl> | undefined = undefined;
 	private modeQ: Query<MsgVehicleMode> | undefined = undefined;
 	private speedQ: Query<MsgVehicleSpeed> | undefined = undefined;
+	private sfxQ: Query<MsgSpecialFx> | undefined = undefined;
 
 	private mx10: MX10;
 
@@ -199,15 +199,61 @@ export default class VehicleGroup
 		]);
 	}
 
-	changeSpecialFunction(vehicleAddress: number, specialFunctionMode: SpecialFunctionMode,
-		specialFunctionStatus: Manual | ShuntingFunction | Direction) {
-		this.mx10.sendData(0x02, 0x05, [
-			{value: vehicleAddress, length: 2},
-			{value: specialFunctionMode, length: 2},
-			{value: specialFunctionStatus, length: 2},
-		]);
+	async getSpecialFx(nid: number, sfxNr: SpecialFxNr)
+	{
+		if(this.sfxQ !== undefined && !await this.sfxQ.lock()) {
+			this.mx10.logInfo.next("mx10.getSpecialFx: failed to acquire lock");
+			return undefined;
+		}
+		this.sfxQ = new Query(MsgSpecialFx.header(MsgMode.REQ, nid), this.onCallSpecialFunction);
+		this.sfxQ.tx = ((header) => {
+			const msg = new MsgSpecialFx(header, sfxNr);
+			// this.mx10.logInfo.next('sfx query tx: ' + JSON.stringify(msg));
+			this.mx10.sendMsg(msg);
+		});
+		this.sfxQ.match = ((msg) => {
+			// this.mx10.logInfo.next('sfx query rx: ' + JSON.stringify(msg));
+			return (msg.nid() === nid);
+		})
+		const rv = await this.sfxQ.run();
+		// this.mx10.logInfo.next("mx10.getSpecialFx.rv: " + JSON.stringify(rv));
+		this.sfxQ.unlock();
+		this.sfxQ = undefined;
+		return rv;
 	}
 
+	async setSpecialFx(nid: number, sfxNr: SpecialFxNr, state: number)
+	{
+		if(this.sfxQ !== undefined && !await this.sfxQ.lock()) {
+			this.mx10.logInfo.next("mx10.setSpecialFx: failed to acquire lock");
+			return undefined;
+		}
+		this.sfxQ = new Query(MsgSpecialFx.header(MsgMode.CMD, nid), this.onCallSpecialFunction);
+		this.sfxQ.tx = ((header) => {
+			const msg = new MsgSpecialFx(header, sfxNr, state);
+			// this.mx10.logInfo.next('sfx query tx: ' + JSON.stringify(msg));
+			this.mx10.sendMsg(msg);
+		});
+		this.sfxQ.match = ((msg) => {
+			// this.mx10.logInfo.next('sfx query rx: ' + JSON.stringify(msg));
+			return (msg.nid() === nid);
+		})
+		const rv = await this.sfxQ.run();
+		// this.mx10.logInfo.next("mx10.setSpecialFx.rv: " + JSON.stringify(rv));
+		this.sfxQ.unlock();
+		this.sfxQ = undefined;
+		return rv;
+	}
+
+	// changeSpecialFunction(vehicleAddress: number, specialFunctionMode: SpecialFunctionMode,
+	// 	specialFunctionStatus: Manual | ShuntingFunction | Direction) {
+	// 	this.mx10.sendData(0x02, 0x05, [
+	// 		{value: vehicleAddress, length: 2},
+	// 		{value: specialFunctionMode, length: 2},
+	// 		{value: specialFunctionStatus, length: 2},
+	// 	]);
+	// }
+
 	// 0x02.0x10
 	activeModeTrain(vehicleAddress: number) {
 		return this.mx10.sendData(0x02, 0x10, [
@@ -288,17 +334,9 @@ export default class VehicleGroup
 	// 0x02.0x05
 	private parseVehicleSpecialFunction(size: number, mode: number, nid: number, buffer: Buffer)
 	{
-		if (this.onCallSpecialFunction.observed) {
-			const NID = buffer.readUInt16LE(0);
-			const specialFunctionMode = buffer.readUInt16LE(2);
-			const specialFunctionState = buffer.readUInt16LE(4);
-
-			this.onCallSpecialFunction.next({
-				nid: NID,
-				specialFunctionMode,
-				specialFunctionState,
-			});
-		}
+		if(!this.onCallSpecialFunction.observed)
+			return;
+		this.onCallSpecialFunction.next(MsgSpecialFx.fromBuffer(mode, buffer));
 	}
 
 	// 0x02.0x12

package/src/loco/vehicleMsg.ts

@@ -1,7 +1,7 @@
 
 import { Header, Message } from "../common/communication";
 import { Ranger } from "../common/utils";
-import { Direction, MaxSpeedSteps, MsgMode, OperatingMode } from "../common/enums";
+import { Direction, MaxSpeedSteps, MsgMode, OperatingMode, SpecialFxNr } from "../common/enums";
 import { directACKBites, directionBites, eastWestBites_, emergencyStopB, speedBites____ } from "../common/bites";
 
 
@@ -162,4 +162,30 @@ export class MsgVehicleLastCtl extends Message
 		const msg = new MsgVehicleLastCtl(MsgVehicleLastCtl.header(mode, nid), type, ctlNid, seconds);
 		return msg;
 	}
+}
+
+export class MsgSpecialFx extends Message
+{
+	public static header = (mode: MsgMode, nid: number) => {return {group: 0x2, cmd: 0x5, mode, nid}}
+
+	constructor(header: Header, sfxNr: SpecialFxNr, state?: number)
+	{
+		super(header);
+		super.push({value: sfxNr || 0, length: 2});
+		if(header.mode === MsgMode.REQ)
+			return;
+		super.push({value: state || 0, length: 2});
+	}
+	nid(): number {return this.header.nid || 0}
+	sfxNr(): number {return this.data[0].value as number;}
+	state(): number | undefined {return this.data.length < 2 ? undefined : this.data[1].value as number;}
+
+	public static fromBuffer(mode: MsgMode, buffer: Buffer)
+	{
+		const nid = buffer.readUInt16LE(0);
+		const sfxNr = buffer.readUInt16LE(2);
+		const state = buffer.readUint16LE(4);
+		const msg = new MsgSpecialFx(MsgVehicleState.header(mode, nid), sfxNr, state);
+		return msg;
+	}
 }