GitHub
Preparing search index...
The search index is not available
Viam SDK
Viam SDK
GantryClient
Class GantryClient
A gRPC-web client for the Gantry component.
Implements
Gantry
Index
Constructors
constructor
Properties
client
name
options
Accessors
Gantry
Service
Methods
do
Command
get
Lengths
get
Position
home
is
Moving
move
To
Position
stop
Constructors
constructor
new
Gantry
Client
(
client
,
name
,
options
?
)
:
GantryClient
Parameters
client
:
RobotClient
name
:
string
options
:
Options
= {}
Returns
GantryClient
Properties
Private
client
client
:
GantryServiceClient
Private
Readonly
name
name
:
string
Private
Readonly
options
options
:
Options
Accessors
Private
Gantry
Service
get
GantryService
(
)
:
GantryServiceClient
Returns
GantryServiceClient
Methods
do
Command
do
Command
(
command
)
:
Promise
<
StructType
>
Parameters
command
:
StructType
Returns
Promise
<
StructType
>
get
Lengths
get
Lengths
(
extra
?
)
:
Promise
<
number
[]
>
Parameters
extra
:
{}
= {}
Returns
Promise
<
number
[]
>
get
Position
get
Position
(
extra
?
)
:
Promise
<
number
[]
>
Parameters
extra
:
{}
= {}
Returns
Promise
<
number
[]
>
home
home
(
extra
?
)
:
Promise
<
boolean
>
Parameters
extra
:
{}
= {}
Returns
Promise
<
boolean
>
is
Moving
is
Moving
(
)
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
move
To
Position
move
To
Position
(
positionsMm
,
speedsMmPerSec
,
extra
?
)
:
Promise
<
void
>
Parameters
positionsMm
:
number
[]
speedsMmPerSec
:
number
[]
extra
:
{}
= {}
Returns
Promise
<
void
>
stop
stop
(
extra
?
)
:
Promise
<
void
>
Parameters
extra
:
{}
= {}
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
constructor
client
name
options
Gantry
Service
do
Command
get
Lengths
get
Position
home
is
Moving
move
To
Position
stop
Viam SDK
Loading...
Generated using
TypeDoc
A gRPC-web client for the Gantry component.