Class CommandProtocol

Tracks one command awaiting its acknowledgement.

Index

Constructors

Accessors

command confirmation

Methods

onFrame onTimeout

Constructors

constructor

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

Accessors

command

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

Returns number
- Defined in index.d.ts:186

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 index.d.ts:191

Methods

onFrame

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

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 index.d.ts:205