Power

For clients to the Spot CAM Power service.

class bosdyn.client.spot_cam.power.PowerClient[source]

Bases: BaseClient

A client calling Spot CAM Power service.

default_service_name = 'spot-cam-power'
service_type = 'bosdyn.api.spot_cam.PowerService'
get_power_status(**kwargs)[source]

Retrieve on/off state of device.

get_power_status_async(**kwargs)[source]

Async version of get_power_status()

set_power_status(ptz=None, aux1=None, aux2=None, external_mic=None, **kwargs)[source]

Turn on/off the desire device. Should not be used on PTZ for non-IR units as it can cause the stream to crash. If the intent is to reset the PTZ autofocus, try PtzClient.initialize_lens instead. If the intent is to recover the PTZ stream in another way, you may need to power cycle the robot.

set_power_status_async(ptz=None, aux1=None, aux2=None, external_mic=None, **kwargs)[source]

Async version of set_power_status()

cycle_power(ptz=None, aux1=None, aux2=None, external_mic=None, **kwargs)[source]

Turn power off then back on for the desired devices. Should not be used on PTZ for non-IR units as it can cause the stream to crash. If the intent is to reset the PTZ autofocus, try PtzClient.initialize_lens instead. If the intent is to recover the PTZ stream in another way, you may need to power cycle the robot.

cycle_power_async(ptz=None, aux1=None, aux2=None, external_mic=None, **kwargs)[source]

Async version of cycle_power()