Class: APGpsSteerDirector
An autopilot GPS roll-steering director.
Implements
Constructors
constructor
• new APGpsSteerDirector(bus, apValues, steerCommand, options?): APGpsSteerDirector
Creates a new instance of APGpsSteerDirector.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
apValues | APValues | Autopilot values from this director's parent autopilot. |
steerCommand | Accessible<Readonly<APGpsSteerDirectorSteerCommand>> | The steering command used by this director. |
options? | Readonly<APGpsSteerDirectorOptions> | Options to configure the new director. |
Returns
Defined in
src/sdk/autopilot/directors/APGpsSteerDirector.ts:114
Properties
driveBank
• Optional driveBank: (bank: number, rate?: number) => void
A function used to drive the autopilot commanded bank angle toward a desired value.
Param
The desired bank angle, in degrees. Positive values indicate left bank.
Param
The rate at which to drive the commanded bank angle, in degrees per second. If not defined, a default rate will be used.
Type declaration
▸ (bank, rate?): void
Parameters
| Name | Type |
|---|---|
bank | number |
rate? | number |
Returns
void
Inherit Doc
Implementation of
Defined in
src/sdk/autopilot/directors/APGpsSteerDirector.ts:90
onActivate
• Optional onActivate: () => void
A callback called when a mode signals it should be activated.
Type declaration
▸ (): void
Returns
void
Inherit Doc
Implementation of
Defined in
src/sdk/autopilot/directors/APGpsSteerDirector.ts:84
onArm
• Optional onArm: () => void
A callback called when a mode signals it should be armed.
Type declaration
▸ (): void
Returns
void
Inherit Doc
Implementation of
Defined in
src/sdk/autopilot/directors/APGpsSteerDirector.ts:87
state
• state: DirectorState
The current director state.
Implementation of
Defined in
src/sdk/autopilot/directors/APGpsSteerDirector.ts:81
Methods
activate
▸ activate(): void
Activates the guidance mode.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APGpsSteerDirector.ts:168
arm
▸ arm(): void
Arms the guidance mode.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APGpsSteerDirector.ts:177
deactivate
▸ deactivate(): void
Deactivates the guidance mode.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APGpsSteerDirector.ts:190
update
▸ update(): void
Updates the guidance mode control loops.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APGpsSteerDirector.ts:196