Skip to content

MiP_Position

github-actions[bot] edited this page Aug 11, 2026 · 9 revisions

Class MiP_Position

Manages reporting of MiP's physical orientation and stance position.

Table of Contents


Public Functions

read

Signature: MiPPosition read()

Summary: Reads MiP's current physical position or orientation.

Details:

Uses cached status data (updated automatically from Out-Of-Band status events). No new serial request is sent to the robot hardware.

Returns: MiPPosition Current physical position as a MiPPosition enum value. Returns MIP_POSITION_ON_BACK_WITH_KICKSTAND if uninitialized.


isOnBack

Signature: bool isOnBack()

Summary: Checks if MiP is lying on back position.

Returns: true if MiP is lying on back, false otherwise.


isFaceDown

Signature: bool isFaceDown()

Summary: Checks if MiP is face down.

Returns: true if MiP is lying face down, false otherwise.


isUpright

Signature: bool isUpright()

Summary: Checks if MiP is upright.

Returns: true if MiP is standing upright, false otherwise.


isPickedUp

Signature: bool isPickedUp()

Summary: Checks if MiP has been picked up.

Returns: true if MiP is currently picked up off the surface, false otherwise.


isHandStanding

Signature: bool isHandStanding()

Summary: Checks if MiP is in a hand-standing position.

Returns: true if MiP is in a hand-stand position, false otherwise.


isFaceDownOnTray

Signature: bool isFaceDownOnTray()

Summary: Checks if MiP is face down on tray position.

Returns: true if MiP is face down on tray, false otherwise.


isOnBackWithKickstand

Signature: bool isOnBackWithKickstand()

Summary: Checks if MiP is on back with the kickstand deployed.

Returns: true if MiP is on back with kickstand deployed, false otherwise.


Clone this wiki locally