Interface Encoder

Represents a physical encoder.

interface Encoder {
    doCommand: ((command) => Promise<StructType>);
    getPosition(positionType?, extra?): Promise<readonly [number, EncoderPositionType]>;
    getProperties(extra?): Promise<encoderApi.GetPropertiesResponse.AsObject>;
    resetPosition(extra?): Promise<void>;
}

Hierarchy (view full)

Resource
- Encoder

Implemented by

EncoderClient

Index

Properties

Methods

getPosition getProperties resetPosition

Properties

doCommand

doCommand: ((command) => Promise<StructType>)

Send/Receive arbitrary commands to the resource.

Type declaration

- (command): Promise<StructType>
- Parameters
  - command: StructType
    The command to execute.
  Returns Promise<StructType>

Methods

getPosition

getPosition(positionType?, extra?): Promise<readonly [number, EncoderPositionType]>
Return the current position either in relative units (ticks away from a zero position) or absolute units (degrees along a circle).
Parameters
- Optional positionType: EncoderPositionType
  The type of position the encoder returns (ticks or degrees)
- Optional extra: StructType
Returns Promise<readonly [number, EncoderPositionType]>

getProperties

getProperties(extra?): Promise<encoderApi.GetPropertiesResponse.AsObject>
Return the encoder's properties.
Parameters
- Optional extra: StructType
Returns Promise<encoderApi.GetPropertiesResponse.AsObject>

resetPosition

resetPosition(extra?): Promise<void>
Set the current position of the encoder as the new zero position.
Parameters
- Optional extra: StructType
Returns Promise<void>

Generated using TypeDoc