Skip to content

MiP_EEPROM

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

Class MiP_EEPROM

Manages access to MiP's EEPROM for reading and writing.

Table of Contents


Public Functions

read

Signature: uint8_t read(uint8_t addressOffset)

Summary: Reads a byte from MiP's EEPROM.

Details:

Performs a verified read with retries on communication errors.

Parameters:

Parameter Description
addressOffset Offset from BASE_EEPROM_ADDRESS (0-15).

Returns: The stored byte value, or 0 on error.


write

Signature: void write(uint8_t addressOffset, uint8_t userData)

Summary: Writes a byte to MiP's EEPROM area and verifies it.

Details:

This function performs a verified write: it sends the data, reads it back, and retries (up to MIP_MAX_RETRIES) if the value doesn't match or an error occurs.

Parameters:

Parameter Description
addressOffset Offset from BASE_EEPROM_ADDRESS (0-15).
userData Byte value to store (0-255).

Public Variables

MIP_CMD_SET_USER_DATA

Signature: constexpr uint8_t MIP_CMD_SET_USER_DATA

Summary: MiP protocol command to write to EEPROM.


MIP_CMD_GET_USER_DATA

Signature: constexpr uint8_t MIP_CMD_GET_USER_DATA

Summary: MiP protocol command to read from EEPROM.


BASE_EEPROM_ADDRESS

Signature: constexpr uint8_t BASE_EEPROM_ADDRESS

Summary: The EEPROM boundaries. Attempts to write outside these addresses will fail.


LAST_EEPROM_ADDRESS

Signature: constexpr uint8_t LAST_EEPROM_ADDRESS


Clone this wiki locally