Class: LinearServo
Defined in: src/sdk/utils/controllers/LinearServo.ts:2
A class that linearly drives a SimVar value towards a given set point.
Constructors
Constructor
new LinearServo(
rate):LinearServo
Defined in: src/sdk/utils/controllers/LinearServo.ts:11
Creates an instance of a LinearServo.
Parameters
| Parameter | Type | Description |
|---|---|---|
rate | number | The default rate to drive this servo, in units per second. |
Returns
LinearServo
Properties
rate
rate:
number
Defined in: src/sdk/utils/controllers/LinearServo.ts:11
The default rate to drive this servo, in units per second.
Methods
drive()
drive(
currentValue,setValue,time,rate):number
Defined in: src/sdk/utils/controllers/LinearServo.ts:22
Drives this servo towards the set point.
Parameters
| Parameter | Type | Description |
|---|---|---|
currentValue | number | The current value. |
setValue | number | The value to drive towards. |
time | number | The current timestamp, in milliseconds. Defaults to the current operating system time, as a Javascript timestamp. |
rate | number | The rate to use to drive this servo, in units per second. Defaults to this servo's default rate. |
Returns
number
The output value.
reset()
reset():
void
Defined in: src/sdk/utils/controllers/LinearServo.ts:45
Resets the servo to initial state
Returns
void