pamoja for TypeScript - v0.1.17
    Preparing search index...

    Variable offboardConst

    offboard: {
        globalPosition(
            header: MavlinkHeader,
            timeBootMs: number,
            coordinateFrame: number,
            targetSystem: number,
            targetComponent: number,
            latInt: number,
            lonInt: number,
            alt: number,
        ): MavlinkFrame;
        localPosition(
            header: MavlinkHeader,
            timeBootMs: number,
            coordinateFrame: number,
            targetSystem: number,
            targetComponent: number,
            x: number,
            y: number,
            z: number,
        ): MavlinkFrame;
        localVelocity(
            header: MavlinkHeader,
            timeBootMs: number,
            coordinateFrame: number,
            targetSystem: number,
            targetComponent: number,
            vx: number,
            vy: number,
            vz: number,
        ): MavlinkFrame;
        typeMask(flags: number): number;
    } = ...

    The setpoint constructors for offboard control, each returning a frame ready to send.

    Type Declaration

    • globalPosition: function
      • Builds a global-frame position setpoint.

        Parameters

        • header: MavlinkHeader

          The addressing fields to stamp on the frame.

        • timeBootMs: number

          The sender's boot timestamp, in milliseconds.

        • coordinateFrame: number

          The MAV_FRAME of the setpoint.

        • targetSystem: number

          The target system id.

        • targetComponent: number

          The target component id.

        • latInt: number

          The latitude, in degrees times ten million.

        • lonInt: number

          The longitude, in degrees times ten million.

        • alt: number

          The altitude, in metres.

        Returns MavlinkFrame

        The SET_POSITION_TARGET_GLOBAL_INT frame.

    • localPosition: function
      • Builds a local-frame position setpoint.

        Parameters

        • header: MavlinkHeader

          The addressing fields to stamp on the frame.

        • timeBootMs: number

          The sender's boot timestamp, in milliseconds.

        • coordinateFrame: number

          The MAV_FRAME of the setpoint.

        • targetSystem: number

          The target system id.

        • targetComponent: number

          The target component id.

        • x: number

          The position along x, in metres in the chosen frame.

        • y: number

          The position along y.

        • z: number

          The position along z.

        Returns MavlinkFrame

        The SET_POSITION_TARGET_LOCAL_NED frame.

    • localVelocity: function
      • Builds a local-frame velocity setpoint.

        Parameters

        • header: MavlinkHeader

          The addressing fields to stamp on the frame.

        • timeBootMs: number

          The sender's boot timestamp, in milliseconds.

        • coordinateFrame: number

          The MAV_FRAME of the setpoint.

        • targetSystem: number

          The target system id.

        • targetComponent: number

          The target component id.

        • vx: number

          The velocity along x, in metres per second in the chosen frame.

        • vy: number

          The velocity along y.

        • vz: number

          The velocity along z.

        Returns MavlinkFrame

        The SET_POSITION_TARGET_LOCAL_NED frame.

    • typeMask: function
      • Builds a setpoint type_mask from the fields to use.

        Parameters

        Returns number

        The mask, as the type_mask field of a setpoint carries it.