control#

abstract RootSystem.control(command: str, hid: str | None, wait_for_completion: bool = True, timeout: float | int = 100) bool | None#

Control the node state.

Parameters:
command: str

Command to execute. Options are "start", "restart", "stop_gently", "stop", and "reset".

hid: Optional[str], optional

Hid, by default None.

wait_for_completion: bool, optional

Whether to wait for completion. The default is True.

timeout: Union[float, int], optional

Time limit for monitoring the status of the command. The default is 100 s.

Returns:
Optional[bool]

True when successful, False when failed.