GitHub
Preparing search index...
The search index is not available
Viam SDK
Viam SDK
ArmClient
Class ArmClient
A gRPC-web client for the Arm component.
Implements
Arm
Index
Constructors
constructor
Properties
client
name
options
Accessors
Arm
Service
Methods
do
Command
get
End
Position
get
Joint
Positions
is
Moving
move
To
Joint
Positions
move
To
Position
stop
Constructors
constructor
new
Arm
Client
(
client
,
name
,
options
?
)
:
ArmClient
Parameters
client
:
RobotClient
name
:
string
options
:
Options
= {}
Returns
ArmClient
Properties
Private
client
client
:
ArmServiceClient
Private
Readonly
name
name
:
string
Private
Readonly
options
options
:
Options
Accessors
Private
Arm
Service
get
ArmService
(
)
:
ArmServiceClient
Returns
ArmServiceClient
Methods
do
Command
do
Command
(
command
)
:
Promise
<
StructType
>
Parameters
command
:
StructType
Returns
Promise
<
StructType
>
get
End
Position
get
End
Position
(
extra
?
)
:
Promise
<
commonApi
.
Pose
.
AsObject
>
Parameters
extra
:
{}
= {}
Returns
Promise
<
commonApi
.
Pose
.
AsObject
>
get
Joint
Positions
get
Joint
Positions
(
extra
?
)
:
Promise
<
JointPositions
>
Parameters
extra
:
{}
= {}
Returns
Promise
<
JointPositions
>
is
Moving
is
Moving
(
)
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
move
To
Joint
Positions
move
To
Joint
Positions
(
jointPositionsList
,
extra
?
)
:
Promise
<
void
>
Parameters
jointPositionsList
:
number
[]
extra
:
{}
= {}
Returns
Promise
<
void
>
move
To
Position
move
To
Position
(
pose
,
extra
?
)
:
Promise
<
void
>
Parameters
pose
:
commonApi
.
Pose
.
AsObject
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
Arm
Service
do
Command
get
End
Position
get
Joint
Positions
is
Moving
move
To
Joint
Positions
move
To
Position
stop
Viam SDK
Loading...
Generated using
TypeDoc
A gRPC-web client for the Arm component.