MiP_HeadLEDs

Class MiP_HeadLEDs

Manages MiP's eye LEDs.

Table of Contents

• Constructors & Destructors
• Public Functions
• Public Variables & Constants

---

Constructors & Destructors

MiP_HeadLEDs

Signature: MiP_HeadLEDs(MiP &mip)

Summary: Constructs the eye LED manager.

Parameters:

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

---

Public Functions

read

Signature: void read(MiPHeadLEDs &headLEDs)

Summary: Reads the current state of all four head LEDs.

Details:

Performs a verified read with retries on communication failure.

Parameters:

Parameter	Description
headLEDs	Reference to a MiPHeadLEDs struct to fill.

---

write

Signature: void write(MiPHeadLED led1, MiPHeadLED led2, MiPHeadLED led3, MiPHeadLED led4)

Summary: Sets all four head LEDs and verifies the change.

Details:

Sends the command and reads back the state to confirm success. Retries automatically on mismatch or error.

Parameters:

Parameter	Description
led1	Head LED 1 pattern.
led2	Head LED 2 pattern.
led3	Head LED 3 pattern.
led4	Head LED 4 pattern.

---

write

Signature: void write(const MiPHeadLEDs &headLEDs)

Summary: Sets all four head LEDs using a struct and verifies the change.

Parameters:

Parameter	Description
headLEDs	Struct containing the four LED patterns.

---

unverifiedWrite

Signature: void unverifiedWrite(MiPHeadLED led1, MiPHeadLED led2, MiPHeadLED led3, MiPHeadLED led4)

Summary: Sets all four head LEDs without verification (fire-and-forget).

Details:

Faster than the verified version but provides no confirmation that the command succeeded.

Parameters:

Parameter	Description
led1	Head LED 1 pattern.
led2	Head LED 2 pattern.
led3	Head LED 3 pattern.
led4	Head LED 4 pattern.

---

unverifiedWrite

Signature: void unverifiedWrite(const MiPHeadLEDs &headLEDs)

Summary: Sets all four head LEDs using a struct without verification.

Parameters:

Parameter	Description
headLEDs	Struct containing the four LED patterns.

---

Public Variables

MIP_CMD_SET_HEAD_LEDS

Signature: constexpr uint8_t MIP_CMD_SET_HEAD_LEDS

Summary: MiP protocol command bytes used by the head LED 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_HEAD_LEDS

Signature: constexpr uint8_t MIP_CMD_GET_HEAD_LEDS

---