Compositor

For clients to the Spot CAM Compositor service.

class bosdyn.client.spot_cam.compositor.CompositorClient

Bases: BaseClient

A client calling Spot CAM Compositor services.

default_service_name = 'spot-cam-compositor'

service_type = 'bosdyn.api.spot_cam.CompositorService'

set_screen(name, **kwargs)

Change the current view that is being streamed over the network

set_screen_async(name, **kwargs)

Async version of set_screen()

get_screen(**kwargs)

Get the currently selected screen

get_screen_async(**kwargs)

Async version of get_screen()

list_screens(**kwargs)

List available screens

list_screens_async(**kwargs)

Async version of list_screens()

get_visible_cameras(**kwargs)

List cameras on Spot CAM

get_visible_cameras_async(**kwargs)

Async version of get_visible_cameras()

set_ir_colormap(colormap, min_temp, max_temp, auto_scale, **kwargs)

Set IR colormap to use on Spot CAM

Parameters:

• colormap (bosdyn.api.spot_cam.compositor_pb2.IrColorMap.ColorMap) – IR display colormap

• min_temp (Float) – minimum temperature on the temperature scale

• max_temp (Float) – maximum temperature on the temperature scale

• auto_scale (Boolean) – Auto-scale the color map. This is the most human-understandable option. min_temp and max_temp are ignored if this is set to True

• kwargs – extra arguments for controlling RPC details.

set_ir_colormap_async(colormap, min_temp, max_temp, auto_scale, **kwargs)

Async version of set_ir_colormap()

get_ir_colormap(**kwargs)

Get currently selected IR colormap on Spot CAM

get_ir_colormap_async(**kwargs)

Async version of get_ir_colormap()

set_ir_meter_overlay(x, y, enable, unit, **kwargs)

Set IR reticle position to use on Spot CAM IR

Parameters:

• x (Float) – (0,1) horizontal coordinate of reticle

• y (Float) – (0,1) vertical coordinate of reticle

• enable (Boolean) – Enable the reticle on the display

• unit (TempUnit) – Temperature unit to display

• kwargs – extra arguments for controlling RPC details.

set_ir_meter_overlay_async(x, y, enable, unit, **kwargs)

Async version of set_ir_meter_overlay()

set_multi_ir_meter_overlay(coords, enable, unit, **kwargs)

Set multiple IR reticle positions to use on Spot CAM IR

Parameters:

• coords (List[Tuple(Float, Float)]) – List of (x, y) reticle coordinates in range (0,1) e.g. [(0.1, 0.2), (0.2, 0.4), (0.7, 0.7)]

• enable (Boolean) – Enable the reticles on the display

• unit (TempUnit) – Temperature unit to display

• kwargs – extra arguments for controlling RPC details.

set_multi_ir_meter_overlay_async(coords, enable, unit, **kwargs)

Async version of set_multi_ir_meter_overlay()

get_ir_meter_overlay(**kwargs)

Get current IR reticle positions

get_ir_meter_overlay_async(**kwargs)

Async version of get_ir_meter_overlay()