Skip to content

MiP_Radar

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

Class MiP_Radar

Manages MiP's radar proximity tracking system.

Table of Contents


Public Functions

clear

Signature: void clear()

Summary: Resets cached radar tracking data back to MIP_RADAR_INVALID.


enable

Signature: void enable()

Summary: Enables radar tracking mode on MiP.

Details:

Uses verified mode switching (sends mode command + read-back confirmation with automatic retries on failure).


disable

Signature: void disable()

Summary: Disables radar tracking mode.

Details:

Uses verified mode switching (sends disable command + read-back confirmation with automatic retries on failure).


isEnabled

Signature: bool isEnabled()

Summary: Checks whether radar tracking mode is currently active on MiP.

Returns: true if radar mode is enabled (mode equals MIP_RADAR), false otherwise.


read

Signature: MiPRadar read()

Summary: Reads the most recent radar tracking distance data.

Details:

Uses cached value from the latest Out-Of-Band status event. Processes pending serial data first.

Returns: MiPRadar Current radar proximity range, or MIP_RADAR_INVALID if no data received yet.


Public Variables

MIP_CMD_GET_GESTURE_RADAR_MODE

Signature: constexpr uint8_t MIP_CMD_GET_GESTURE_RADAR_MODE

Summary: MiP protocol command byte to query the current gesture/radar operating mode.


MIP_CMD_SET_GESTURE_RADAR_MODE

Signature: constexpr uint8_t MIP_CMD_SET_GESTURE_RADAR_MODE

Summary: MiP protocol command byte to configure the gesture/radar operating mode.


MIP_CMD_GET_RADAR_RESPONSE

Signature: constexpr uint8_t MIP_CMD_GET_RADAR_RESPONSE

Summary: MiP protocol notification byte received when a radar distance update arrives.


Clone this wiki locally