Compositor

For clients to the Spot CAM Compositor service.

class bosdyn.client.spot_cam.compositor.CompositorClient[source]

Bases: bosdyn.client.common.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)[source]

Change the current view that is being streamed over the network

set_screen_async(name, **kwargs)[source]

Async version of set_screen()

get_screen(**kwargs)[source]

Get the currently selected screen

get_screen_async(**kwargs)[source]

Async version of get_screen()

list_screens(**kwargs)[source]

List available screens

list_screens_async(**kwargs)[source]

Async version of list_screens()

get_visible_cameras(**kwargs)[source]

List cameras on Spot CAM

get_visible_cameras_async(**kwargs)[source]

Async version of get_visible_cameras()

set_ir_colormap(colormap, min_temp, max_temp, auto_scale, **kwargs)[source]

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)[source]

Async version of set_ir_colormap()

get_ir_colormap(**kwargs)[source]

Get currently selected IR colormap on Spot CAM

get_ir_colormap_async(**kwargs)[source]

Async version of get_ir_colormap()

set_ir_meter_overlay(x, y, enable, **kwargs)[source]

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

  • kwargs – extra arguments for controlling RPC details.

set_ir_meter_overlay_async(x, y, enable, **kwargs)[source]

Async version of set_ir_meter_overlay()