From 72f5cb074367c15e80bc44a83f14746d6f7e12c9 Mon Sep 17 00:00:00 2001 From: Denny Huang Date: Fri, 29 Mar 2024 10:51:30 +0000 Subject: [PATCH] Add status_code def to README.md --- src/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/README.md b/src/README.md index 34b10f1..6a63c66 100644 --- a/src/README.md +++ b/src/README.md @@ -84,6 +84,7 @@ dpsl.diagnostics.getAvailableRoutines().then((routineList) => { | progress_percent | number | Percentage of the routine progress | | output* | string | Accumulated output, like logs | | status | string | Current status of the routine. One of ['ready', 'running', 'waiting_user_action', 'passed', 'failed', 'error', 'cancelled', 'failed_to_start', 'removed', 'cancelling', 'unsupported', 'not_run', 'unknown'] | +| status_code* | number | The corresponding code for the status message | | status_message | string | More detailed status message | | user_message* | string | The requested user action. Note: used in interactive routines only. Possible values ['unplug_ac_power', 'plug_in_ac_power', 'press_power_button', 'unknown' ] |