control

System.control(command: str, hid: str | None = None, wait_for_completion: bool = True, timeout: float | int = 100) → str | None

Control the node state.

Parameters:

command: str

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

hid: str, optional

Hid entry. The default is None. The actor unique ID is required.

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:

bool

True when successful, False when failed.