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.

Sign up for GitHub

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

feat: abort Send Data commands early after timeout, reduce callback timeout #6411

Merged
merged 2 commits into from
Oct 17, 2023
Merged

feat: abort Send Data commands early after timeout, reduce callback timeout #6411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ddc733
feat: abort SendData commands early after timeout
AlCalzone Oct 17, 2023
23fd719
fix: disable test debugging
AlCalzone Oct 17, 2023
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
13 changes: 11 additions & 2 deletions docs/api/driver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,8 +689,17 @@ interface ZWaveOptions extends ZWaveHostOptions {
*/
response: number; // [500...60000], default: 10000 ms

/** How long to wait for a callback from the host for a SendData[Multicast]Request */
sendDataCallback: number; // >=10000, default: 65000 ms
/**
* How long to wait for a callback from the host for a SendData[Multicast]Request
* before aborting the transmission.
*/
sendDataAbort: number; // >=5000, <=(sendDataCallback - 5000), default: 20000 ms

/**
* How long to wait for a callback from the host for a SendData[Multicast]Request
* before considering the controller unresponsive.
*/
sendDataCallback: number; // >=10000, default: 30000 ms

/** How much time a node gets to process a request and send a response */
report: number; // [500...10000], default: 1000 ms
Expand Down
15 changes: 14 additions & 1 deletion packages/zwave-js/src/lib/driver/Driver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,8 @@ const defaultOptions: ZWaveOptions = {
response: 10000,
report: 1000, // ReportTime timeout SHOULD be set to CommandTime + 1 second
nonce: 5000,
sendDataCallback: 65000, // as defined in INS13954
sendDataAbort: 20000, // If a controller takes over 15s to reach a node, it's probably not going to happen
sendDataCallback: 30000, // INS13954 defines this to be 65000 ms, but waiting that long causes issues with reporting devices
sendToSleep: 250, // The default should be enough time for applications to react to devices waking up
retryJammed: 1000,
refreshValue: 5000, // Default should handle most slow devices until we have a better solution
Expand Down Expand Up @@ -340,6 +341,18 @@ function checkOptions(options: ZWaveOptions): void {
ZWaveErrorCodes.Driver_InvalidOptions,
);
}
if (
options.timeouts.sendDataAbort < 5000
|| options.timeouts.sendDataAbort
> options.timeouts.sendDataCallback - 5000
) {
throw new ZWaveError(
`The Send Data Abort Callback timeout must be between 5000 and ${
options.timeouts.sendDataCallback - 5000
} milliseconds!`,
ZWaveErrorCodes.Driver_InvalidOptions,
);
}
if (
options.timeouts.serialAPIStarted < 1000
|| options.timeouts.serialAPIStarted > 30000
Expand Down
10 changes: 9 additions & 1 deletion packages/zwave-js/src/lib/driver/SerialAPICommandMachine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ export type SerialAPICommandMachineOptions = Partial<
export type SerialAPICommandMachineParams = {
timeouts: Pick<
ZWaveOptions["timeouts"],
"ack" | "response" | "sendDataCallback"
"ack" | "response" | "sendDataAbort" | "sendDataCallback"
>;
attempts: Pick<ZWaveOptions["attempts"], "controller">;
};
Expand Down Expand Up @@ -312,6 +312,13 @@ export function getSerialAPICommandMachineConfig(
],
},
after: {
// Abort Send Data when it takes too long
SENDDATA_ABORT_TIMEOUT: {
cond: "isSendData",
actions: [
() => sendDataAbort(),
],
},
CALLBACK_TIMEOUT: {
target: "failure",
actions: assign({
Expand Down Expand Up @@ -446,6 +453,7 @@ export function getSerialAPICommandMachineOptions(
|| timeoutConfig.sendDataCallback
);
},
SENDDATA_ABORT_TIMEOUT: timeoutConfig.sendDataAbort,
ACK_TIMEOUT: timeoutConfig.ack,
},
};
Expand Down
13 changes: 11 additions & 2 deletions packages/zwave-js/src/lib/driver/ZWaveOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,17 @@ export interface ZWaveOptions extends ZWaveHostOptions {
*/
response: number; // [500...60000], default: 10000 ms

/** How long to wait for a callback from the host for a SendData[Multicast]Request */
sendDataCallback: number; // >=10000, default: 65000 ms
/**
* How long to wait for a callback from the host for a SendData[Multicast]Request
* before aborting the transmission.
*/
sendDataAbort: number; // >=5000, <=(sendDataCallback - 5000), default: 20000 ms

/**
* How long to wait for a callback from the host for a SendData[Multicast]Request
* before considering the controller unresponsive.
*/
sendDataCallback: number; // >=10000, default: 30000 ms

/** How much time a node gets to process a request and send a response */
report: number; // [500...10000], default: 1000 ms
Expand Down
Loading