Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EZSP: Attempt to handle correctly and reconnect on errors. #697

Merged
merged 7 commits into from
Apr 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/adapter/ezsp/driver/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ export interface EZSPFrameDesc {
ID: number,
request: ParamsDesc,
response: ParamsDesc,
minV?: number,
maxV?: number
}

export const FRAMES: {[key: string]: EZSPFrameDesc} = {
Expand Down Expand Up @@ -2231,6 +2233,7 @@ export const FRAMES: {[key: string]: EZSPFrameDesc} = {
newChildId: EmberNodeId,
newParentId: EmberNodeId
},
maxV: 8
},
incomingNetworkStatusHandler: {
ID: 0x00C4,
Expand All @@ -2239,6 +2242,7 @@ export const FRAMES: {[key: string]: EZSPFrameDesc} = {
errorCode: uint8_t,
target: EmberNodeId
},
minV: 9
},
setSourceRouteDiscoveryMode: {
ID: 0x005a,
Expand Down
2 changes: 1 addition & 1 deletion src/adapter/ezsp/driver/driver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ export class Driver extends EventEmitter {

this.multicast = new Multicast(this);
await this.multicast.startup([]);
await this.multicast.subscribe(242, greenPowerGroup);
await this.multicast.subscribe(greenPowerGroup, 242);
// await this.multicast.subscribe(1, 901);
return result;
}
Expand Down
19 changes: 15 additions & 4 deletions src/adapter/ezsp/driver/ezsp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,20 +59,26 @@ export class EZSPFrameData {
/* eslint-disable-next-line @typescript-eslint/no-explicit-any*/
[name: string]: any;

static createFrame(frame_id: number, isRequest: boolean, params: ParamsDesc | Buffer): EZSPFrameData {
static createFrame(
ezspv: number, frame_id: number, isRequest: boolean, params: ParamsDesc | Buffer
): EZSPFrameData {
const names = FRAME_NAMES_BY_ID[frame_id];
if (!names) {
throw new Error(`Unrecognized frame FrameID ${frame_id}`);
}
let frm: EZSPFrameData;
names.every((frameName)=>{
const frameDesc = EZSPFrameData.getFrame(frameName);
if ((frameDesc.maxV && frameDesc.maxV < ezspv) || (frameDesc.minV && frameDesc.minV > ezspv)) {
return true;
}
try {
frm = new EZSPFrameData(frameName, false, params);
return false;
frm = new EZSPFrameData(frameName, isRequest, params);
} catch (error) {
debug.error(`Frame ${frameName} parsing error: ${error.stack}`);
return true;
}
return false;
});
return frm;
}
Expand Down Expand Up @@ -288,6 +294,7 @@ export class Ezsp extends EventEmitter {
if (force) {
clearTimeout(this.watchdogTimer);
}
this.queue.clear();
await this.serialDriver.close();
}

Expand Down Expand Up @@ -317,7 +324,11 @@ export class Ezsp extends EventEmitter {
data = data.subarray(2);
}
}
const frm = EZSPFrameData.createFrame(frame_id, false, data);
const frm = EZSPFrameData.createFrame(this.ezspV, frame_id, false, data);
if (!frm) {
debug.error(`Unparsed frame 0x${frame_id.toString(16)}. Skipped`);
return;
}
debug.log(`<== 0x${frame_id.toString(16)}: ${JSON.stringify(frm)}`);
const handled = this.waitress.resolve({
frameId: frame_id,
Expand Down
8 changes: 5 additions & 3 deletions src/adapter/ezsp/driver/uart.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class SerialDriver extends EventEmitter {
constructor() {
super();
this.initialized = false;
this.queue = new Queue(8);
this.queue = new Queue(1);
this.waitress = new Waitress<EZSPPacket, EZSPPacketMatcher>(
this.waitressValidator, this.waitressTimeoutFormatter);
}
Expand Down Expand Up @@ -287,6 +287,7 @@ export class SerialDriver extends EventEmitter {
async reset(): Promise<void> {
debug('Uart reseting');
this.parser.reset();
this.queue.clear();
return this.queue.execute<void>(async (): Promise<void> => {
debug(`--> Write reset`);
const waiter = this.waitFor(-1, 10000).start();
Expand All @@ -305,24 +306,25 @@ export class SerialDriver extends EventEmitter {

public close(): Promise<void> {
return new Promise((resolve, reject): void => {
this.queue.clear();
if (this.initialized) {
if (this.portType === 'serial') {
this.serialPort.flush((): void => {
this.serialPort.close((error): void => {
this.initialized = false;
this.emit('close');
error == null ?
resolve() :
reject(new Error(`Error while closing serialport '${error}'`));
this.emit('close');
});
});
} else {
this.socketPort.destroy();
resolve();
}
} else {
resolve();
this.emit('close');
resolve();
}
});
}
Expand Down
15 changes: 13 additions & 2 deletions test/adapter/ezsp/frame.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,28 @@ import {EZSPFrameData} from '../../../src/adapter/ezsp/driver/ezsp';

describe('FRAME Parsing', () => {
it('changeSourceRouteHandler', async () => {
const frm = EZSPFrameData.createFrame(0x00C4, false, Buffer.from('05e399a000', 'hex'));
const frm = EZSPFrameData.createFrame(8, 0x00C4, false, Buffer.from('05e399a000', 'hex'));
expect(frm._cls_).toBe('changeSourceRouteHandler');
expect(frm._id_).toBe(0x00C4);
expect(frm.newChildId).toBe(0xe305);
expect(frm.newParentId).toBe(0xa099);
});
it('changeSourceRouteHandler', async () => {
const frm = EZSPFrameData.createFrame(9, 0x00C4, false, Buffer.from('05e399a000', 'hex'));
expect(frm._cls_).toBe('incomingNetworkStatusHandler');
expect(frm._id_).toBe(0x00C4);
expect(frm.errorCode).toBe(0x05);
expect(frm.target).toBe(0x99e3);
});
it('incomingNetworkStatusHandler', async () => {
const frm = EZSPFrameData.createFrame(0x00C4, false, Buffer.from('0b044e', 'hex'));
const frm = EZSPFrameData.createFrame(9, 0x00C4, false, Buffer.from('0b044e', 'hex'));
expect(frm._cls_).toBe('incomingNetworkStatusHandler');
expect(frm._id_).toBe(0x00C4);
expect(frm.errorCode).toBe(0x0b);
expect(frm.target).toBe(0x4e04);
});
it('incomingNetworkStatusHandler', async () => {
const frm = EZSPFrameData.createFrame(8, 0x00C4, false, Buffer.from('0b044e', 'hex'));
expect(frm).toBe(undefined);
});
});
4 changes: 2 additions & 2 deletions test/adapter/ezsp/uart.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,10 @@ describe('UART', () => {
serialDriver.sendDATA(Buffer.from([1,2,3]));
serialDriver.sendDATA(Buffer.from([1,2,3]));
serialDriver.sendDATA(Buffer.from([1,2,3]));
expect(writeBufferSpy).toHaveBeenCalledTimes(9);
expect(writeBufferSpy).toHaveBeenCalledTimes(2);
// send another 2 frame - not counted, until resolve 8 promices
serialDriver.sendDATA(Buffer.from([1,2,3]));
serialDriver.sendDATA(Buffer.from([1,2,3]));
expect(writeBufferSpy).toHaveBeenCalledTimes(9);
expect(writeBufferSpy).toHaveBeenCalledTimes(2);
});
});