Class CommandProtocol

Tracks one command awaiting its acknowledgment.

Wraps the generated class so an unrelated acknowledgment reports null rather than an absent key, matching the rest of this package.

Index

Constructors

Accessors

command confirmation

Methods

onFrame onTimeout

Constructors

constructor

new CommandProtocol(
command: number,
maxRetries?: number,
): mavlink.CommandProtocol
Starts tracking a command.
Parameters
- command: number
  The MAV_CMD id being sent.
- OptionalmaxRetries: number
  How many times the command may be resent after a timeout before the caller gives up; defaults to MAX_RETRIES.
Returns mavlink.CommandProtocol
- Defined in mavlink/dist/index.d.ts:271

Accessors

command

get command(): number
The command id being tracked.

Returns number
- Defined in mavlink/dist/index.d.ts:273

confirmation

get confirmation(): number
The confirmation count to stamp on the command being sent: zero for the first transmission, incremented on each retransmission.

Returns number
- Defined in mavlink/dist/index.d.ts:278

Methods

onFrame

onFrame(frame: mavlink.MavlinkFrame): mavlink.AckOutcome | null
Classifies an incoming frame against the command in flight.
Parameters
- frame: mavlink.MavlinkFrame
  The frame off the link.
Returns mavlink.AckOutcome | null
The outcome, or null if the frame is not a COMMAND_ACK.
- Defined in mavlink/dist/index.d.ts:285

onTimeout

onTimeout(): number | null
Records a timeout and reports whether the command may be resent.

Returns number | null
The new confirmation count to stamp on the resend, or null once the retry budget is exhausted.
- Defined in mavlink/dist/index.d.ts:292