MiP_Version

Class MiP_Version

Manages reading MiP's hardware and software versions and library versioning.

Table of Contents

• Public Functions
• Public Variables & Constants

---

Public Functions

readSoftware

Signature: void readSoftware(MiPSoftwareVersion &software)

Summary: Reads MiP's software/firmware version details.

Details:

Sends the get software version request over UART and populates software with the year, month, day, and unique version identifier. Performs retries automatically if communication errors occur.

Parameters:

Parameter	Description
software	Reference to a MiPSoftwareVersion object to populate.

---

readHardware

Signature: void readHardware(MiPHardwareInfo &hardware)

Summary: Reads MiP's hardware and voice chip revision numbers.

Details:

Sends the get hardware info request over UART and populates hardware with the voice chip and main body hardware revision numbers. Performs retries automatically if communication errors occur.

Parameters:

Parameter	Description
hardware	Reference to a MiPHardwareInfo object to populate.

---

readMPUString

Signature: const char * readMPUString() const

Summary: Returns the Semantic Version string of this Arduino library.

Returns: const char* Static C-string representation of the library version (e.g. "2.0.1").

---

readMPUNumber

Signature: uint32_t readMPUNumber() const

Summary: Returns the encoded integer version number of this Arduino library.

Details:

Encodes major, minor, and patch numbers into a single integer suitable for preprocessor checks (e.g., version 2.0.1 is encoded as 20001).

Returns: uint32_t Encoded library version number.

---

Public Variables

MIP_CMD_GET_SOFTWARE_VERSION

Signature: constexpr uint8_t MIP_CMD_GET_SOFTWARE_VERSION

Summary: Protocol command byte to query MiP's firmware software version date.

---

MIP_CMD_GET_HARDWARE_INFO

Signature: constexpr uint8_t MIP_CMD_GET_HARDWARE_INFO

Summary: Protocol command byte to query MiP's hardware and voice chip revisions.

---