Skip to content

Commit

Permalink
Add status_code def to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cyhuang1230 committed Mar 29, 2024
1 parent 5654fc8 commit 72f5cb0
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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' ] |

Expand Down

0 comments on commit 72f5cb0

Please sign in to comment.