Class VisionClient

A gRPC-web client for a Vision service.

Implements

Vision

Index

Constructors

constructor

new VisionClient(client, name, options?): VisionClient
Parameters
- client: RobotClient
- name: string
- options: Options = {}
Returns VisionClient

Properties

`Private` client

client: VisionServiceClient

`Private` `Readonly` name

name: string

`Private` `Readonly` options

options: Options

Accessors

`Private` service

get service(): VisionServiceClient
Returns VisionServiceClient

Methods

captureAllFromCamera

captureAllFromCamera(cameraName, __namedParameters, extra?): Promise<{
    classifications: visionApi.Classification.AsObject[];
    detections: visionApi.Detection.AsObject[];
    image: undefined | cameraApi.Image.AsObject;
    objectPointClouds: commonApi.PointCloudObject.AsObject[];
}>
Parameters
- cameraName: string
- __namedParameters: CaptureAllOptions
- extra: {} = {}
Returns Promise<{
    classifications: visionApi.Classification.AsObject[];
    detections: visionApi.Detection.AsObject[];
    image: undefined | cameraApi.Image.AsObject;
    objectPointClouds: commonApi.PointCloudObject.AsObject[];
}>
Implementation of Vision.captureAllFromCamera

doCommand

doCommand(command): Promise<StructType>
Parameters
- command: StructType
Returns Promise<StructType>
Implementation of Vision.doCommand

getClassifications

getClassifications(image, width, height, mimeType, count, extra?): Promise<visionApi.Classification.AsObject[]>
Parameters
- image: Uint8Array
- width: number
- height: number
- mimeType: MimeType
- count: number
- extra: StructType = {}
Returns Promise<visionApi.Classification.AsObject[]>
Implementation of Vision.getClassifications

getClassificationsFromCamera

getClassificationsFromCamera(cameraName, count, extra?): Promise<visionApi.Classification.AsObject[]>
Parameters
- cameraName: string
- count: number
- extra: StructType = {}
Returns Promise<visionApi.Classification.AsObject[]>
Implementation of Vision.getClassificationsFromCamera

getDetections

getDetections(image, width, height, mimeType, extra?): Promise<visionApi.Detection.AsObject[]>
Parameters
- image: Uint8Array
- width: number
- height: number
- mimeType: MimeType
- extra: StructType = {}
Returns Promise<visionApi.Detection.AsObject[]>
Implementation of Vision.getDetections

getDetectionsFromCamera

getDetectionsFromCamera(cameraName, extra?): Promise<visionApi.Detection.AsObject[]>
Parameters
- cameraName: string
- extra: StructType = {}
Returns Promise<visionApi.Detection.AsObject[]>
Implementation of Vision.getDetectionsFromCamera

getObjectPointClouds

getObjectPointClouds(cameraName, extra?): Promise<commonApi.PointCloudObject.AsObject[]>
Parameters
- cameraName: string
- extra: StructType = {}
Returns Promise<commonApi.PointCloudObject.AsObject[]>
Implementation of Vision.getObjectPointClouds

getProperties

getProperties(extra?): Promise<{
    classificationsSupported: boolean;
    detectionsSupported: boolean;
    objectPointCloudsSupported: boolean;
}>
Parameters
- extra: {} = {}
Returns Promise<{
    classificationsSupported: boolean;
    detectionsSupported: boolean;
    objectPointCloudsSupported: boolean;
}>
Implementation of Vision.getProperties

Class VisionClient

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VisionClient

Properties

Private client

Private Readonly name

Private Readonly options

Accessors

Private service

Returns VisionServiceClient

Methods

captureAllFromCamera

Parameters

Returns Promise<{ classifications: visionApi.Classification.AsObject[]; detections: visionApi.Detection.AsObject[]; image: undefined | cameraApi.Image.AsObject; objectPointClouds: commonApi.PointCloudObject.AsObject[]; }>

doCommand

Parameters

Returns Promise<StructType>

getClassifications

Parameters

Returns Promise<visionApi.Classification.AsObject[]>

getClassificationsFromCamera

Parameters

Returns Promise<visionApi.Classification.AsObject[]>

getDetections

Parameters

Returns Promise<visionApi.Detection.AsObject[]>

getDetectionsFromCamera

Parameters

Returns Promise<visionApi.Detection.AsObject[]>

getObjectPointClouds

Parameters

Returns Promise<commonApi.PointCloudObject.AsObject[]>

getProperties

Parameters

Returns Promise<{ classificationsSupported: boolean; detectionsSupported: boolean; objectPointCloudsSupported: boolean; }>

Settings

Member Visibility

Theme

On This Page

`Private` client

`Private` `Readonly` name

`Private` `Readonly` options

`Private` service

Returns Promise<{
classifications: visionApi.Classification.AsObject[];
detections: visionApi.Detection.AsObject[];
image: undefined | cameraApi.Image.AsObject;
objectPointClouds: commonApi.PointCloudObject.AsObject[];
}>

Returns Promise<{
classificationsSupported: boolean;
detectionsSupported: boolean;
objectPointCloudsSupported: boolean;
}>