Skip to content

MiP_Shake

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

Class MiP_Shake

Manages MiP's shake event detection system.

Detailed Description

Monitors physical shake events detected by MiP's internal accelerometers and maintains internal state flags for one-shot event reading.

Table of Contents


Public Functions

read

Signature: bool read()

Summary: Checks whether the MiP has been shaken since the last call.

Details:

Flushes pending serial transport data, inspects the internal shake flag, and clears the flag after returning true (one-shot detection).

Returns: true if a shake was detected since the last call, false otherwise.


Public Variables

MIP_CMD_SHAKE_RESPONSE

Signature: constexpr uint8_t MIP_CMD_SHAKE_RESPONSE

Summary: MiP protocol notification byte received when a physical shake event occurs.

Details:

Dispatched asynchronously by MiP over UART as an Out-Of-Band (OOB) notification when the robot experiences a physical shake motion.


Clone this wiki locally