depth

Documentation

Overview

Package depth implements the Depth sensor. Warning: The code in this package might be transient. Stability is not guaranteed.

Index

• type Depth
  • func New(deps resource.Dependencies, sensors []string, sensorIndex int) (Depth, error)
  • func (depth Depth) GetData(ctx context.Context) ([]byte, func(), error)

Types

type Depth

type Depth struct {
	Name string
	// contains filtered or unexported fields
}

Depth represents a depth sensor.

func New

func New(deps resource.Dependencies, sensors []string, sensorIndex int) (Depth, error)

New creates a new Depth sensor based on the sensor definition and the service config.

func (Depth) GetData

func (depth Depth) GetData(ctx context.Context) ([]byte, func(), error)

GetData returns data from the depth sensor. The returned function is a release function that must be called once the caller of GetData is done using the image.