Skip to content

MiP_Mode

github-actions[bot] edited this page Aug 10, 2026 · 8 revisions

Class MiP_Mode

Manages MiP's modes.

Table of Contents


Constructors & Destructors

MiP_Mode

Signature: MiP_Mode(MiP &mip)

Summary: Constructs the mode manager.

Parameters:

Parameter Description
mip A reference to the main MiP object to access core services.

Public Functions

enableApp

Signature: void enableApp()

Summary: Switches MiP into App Mode.

Details:

Verified operation (command sent + state read back with retry).


enableCage

Signature: void enableCage()

Summary: Switches MiP into Cage Mode.

Details:

Verified operation (command sent + state read back with retry).


enableDance

Signature: void enableDance()

Summary: Switches MiP into Dance Mode.

Details:

Verified operation (command sent + state read back with retry).


enableStack

Signature: void enableStack()

Summary: Switches MiP into Stack Mode.

Details:

Verified operation (command sent + state read back with retry).


enableTrick

Signature: void enableTrick()

Summary: Switches MiP into Trick Mode.

Details:

Verified operation (command sent + state read back with retry).


enableRoam

Signature: void enableRoam()

Summary: Switches MiP into Roam Mode.

Details:

Verified operation (command sent + state read back with retry).


isAppEnabled

Signature: bool isAppEnabled()

Summary: Checks if App Mode is currently active.

Returns: true if in App Mode.


isCageEnabled

Signature: bool isCageEnabled()

Summary: Checks if Cage Mode is currently active.

Returns: true if in Cage Mode.


isDanceEnabled

Signature: bool isDanceEnabled()

Summary: Checks if Dance Mode is currently active.

Returns: true if in Dance Mode.


isStackEnabled

Signature: bool isStackEnabled()

Summary: Checks if Stack Mode is currently active.

Returns: true if in Stack Mode.


isTrickEnabled

Signature: bool isTrickEnabled()

Summary: Checks if Trick Mode is currently active.

Returns: true if in Trick Mode.


isRoamEnabled

Signature: bool isRoamEnabled()

Summary: Checks if Roam Mode is currently active.

Returns: true if in Roam Mode.


Public Variables

MIP_CMD_SET_GAME_MODE

Signature: constexpr uint8_t MIP_CMD_SET_GAME_MODE

Summary: MiP protocol command bytes used by the mode subsystem.

Details:

These values are placed in the first byte of requests sent to the MiP (and appear in the corresponding responses). See the official MiP BLE Protocol for the complete list.


MIP_CMD_GET_GAME_MODE

Signature: constexpr uint8_t MIP_CMD_GET_GAME_MODE


Clone this wiki locally