wei.routers.admin_routes

Implements routes for the /admin commands

Functions

cancel_module(module_name)	Cancels a module
cancel_workcell()	Cancels the workcell
cancel_workflow(wf_run_id)	Cancels a workflow
lock_module(module_name)	Locks a module
lock_workcell()	Locks the workcell
pause_module(module_name)	Pauses a module
pause_workcell()	Pauses the workcell
pause_workflow(wf_run_id)	Pauses a workflow
reset_module(module_name)	Resets a module
reset_workcell()	Resets the entire workcell
reset_workflow(wf_run_id)	Restarts a workflow
resume_module(module_name)	Resumes a module
resume_workcell()	Resumes the workcell
resume_workflow(wf_run_id)	Resumes a workflow
safety_stop_module(module_name)	Safety-stops a module
safety_stop_workcell()	Safety-stops a workcell
shutdown_module(module_name)	Shuts down a module
shutdown_workcell([modules])	Shuts down the workcell
unlock_module(module_name)	Unlocks a module
unlock_workcell()	Unlocks the workcell

wei.routers.admin_routes.cancel_module(module_name: str) → None

Cancels a module

wei.routers.admin_routes.cancel_workcell() → None

Cancels the workcell

wei.routers.admin_routes.cancel_workflow(wf_run_id: str) → None

Cancels a workflow

wei.routers.admin_routes.lock_module(module_name: str) → None

Locks a module

wei.routers.admin_routes.lock_workcell() → None

Locks the workcell

wei.routers.admin_routes.pause_module(module_name: str) → None

Pauses a module

wei.routers.admin_routes.pause_workcell() → None

Pauses the workcell

wei.routers.admin_routes.pause_workflow(wf_run_id: str) → None

Pauses a workflow

wei.routers.admin_routes.reset_module(module_name: str) → None

Resets a module

wei.routers.admin_routes.reset_workcell() → None

Resets the entire workcell

wei.routers.admin_routes.reset_workflow(wf_run_id: str) → None

Restarts a workflow

wei.routers.admin_routes.resume_module(module_name: str) → None

Resumes a module

wei.routers.admin_routes.resume_workcell() → None

Resumes the workcell

wei.routers.admin_routes.resume_workflow(wf_run_id: str) → None

Resumes a workflow

wei.routers.admin_routes.safety_stop_module(module_name: str) → None

Safety-stops a module

wei.routers.admin_routes.safety_stop_workcell() → None

Safety-stops a workcell

wei.routers.admin_routes.shutdown_module(module_name: str) → None

Shuts down a module

wei.routers.admin_routes.shutdown_workcell(modules: bool = False) → None

Shuts down the workcell

wei.routers.admin_routes.unlock_module(module_name: str) → None

Unlocks a module

wei.routers.admin_routes.unlock_workcell() → None

Unlocks the workcell