Class MissionReceiver

Requests a plan's items in order and collects them, ending with an acknowledgement.

Index

Constructors

Accessors

complete expected

Methods

onFrame requestList

Constructors

constructor

new MissionReceiver(
    targetSystem: number,
    targetComponent: number,
    missionType?: number | null,
): MissionReceiver
Creates a receiver for a plan from a target vehicle.
Parameters
- targetSystem: number
  The sending system's id.
- targetComponent: number
  The sending component's id.
- OptionalmissionType: number | null
  The MAV_MISSION_TYPE to transfer; defaults to the main mission.
Returns MissionReceiver
- Defined in index.d.ts:986

Accessors

complete

get complete(): boolean
Whether every item has been received and the acknowledgement produced.

Returns boolean
- Defined in index.d.ts:1006

expected

get expected(): number
The next sequence number the receiver expects.

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

Methods

onFrame

onFrame(frame: MavlinkFrame, header: MavlinkHeader): ReceiverStep | null
Handles an incoming frame, if it is one this transfer is waiting for.

A MISSION_COUNT opens the transfer and a MISSION_ITEM_INT advances it.
Parameters
- frame: MavlinkFrame
  The frame off the link.
- header: MavlinkHeader
  The addressing fields to stamp on the reply.
Returns ReceiverStep | null
The step taken, or null if the frame carries a message this transfer does not handle.
- Defined in index.d.ts:1004

requestList

requestList(header: MavlinkHeader): MavlinkFrame
Builds the frame that starts a download.
Parameters
- header: MavlinkHeader
  The addressing fields to stamp on the frame.
Returns MavlinkFrame
The MISSION_REQUEST_LIST frame.
- Defined in index.d.ts:993