MiP

Class MiP

Members & Functions

Type	Signature	Description
enum	uint8_t FlagBits
variable	constexpr uint8_t MIP_CMD_DISCONNECT_APP	MiP protocol command bytes related to core functions.
variable	constexpr uint8_t MIP_CMD_SLEEP
variable	constexpr uint8_t MIP_CMD_GET_STATUS
variable	constexpr uint8_t MIP_ERROR_NONE	Integer error codes that can be encountered by the MiP library.
variable	constexpr uint8_t MIP_ERROR_TIMEOUT
variable	constexpr uint8_t MIP_ERROR_NO_EVENT
variable	constexpr uint8_t MIP_ERROR_BAD_RESPONSE
variable	constexpr uint8_t MIP_ERROR_MAX_RETRIES
variable	MiP_Battery battery
variable	MiP_ChestLED chestLED
variable	MiP_Clap clap
variable	MiP_EEPROM eeprom
variable	MiP_Gesture gesture
variable	MiP_HeadLEDs headLEDs
variable	MiP_Infrared infrared
variable	MiP_Mode mode
variable	MiP_Motion motion
variable	MiP_Odometer odometer
variable	MiP_Position position
variable	MiP_Radar radar
variable	MiP_Serial serial
variable	MiP_Shake shake
variable	MiP_Sound sound
variable	MiP_Version version
variable	MiP_Weight weight
variable	MiP_Wifi wifi
friend	class MiP_Battery
friend	class MiP_ChestLED
friend	class MiP_Clap
friend	class MiP_EEPROM
friend	class MiP_Gesture
friend	class MiP_HeadLEDs
friend	class MiP_Infrared
friend	class MiP_Mode
friend	class MiP_Motion
friend	class MiP_Wifi
friend	class MiP_Odometer
friend	class MiP_Position
friend	class MiP_Radar
friend	class MiP_Serial
friend	class MiP_Shake
friend	class MiP_Sound
friend	class MiP_Version
friend	class MiP_Weight
variable	uint8_t m_flags
variable	int8_t m_lastError
variable	MiPStatus m_lastStatus
function	MiP()
function	~MiP()
function	bool begin()	Initializes the core UART connection to the MiP robot.
function	void end()	Cleans up the connection to MiP and shuts down network services.
function	void sleep()	Puts the MiP robot to sleep.
function	bool isInitialized()	Check whether the MiP library has completed initialization.
function	int8_t lastCallResult()	Retrieves the error code from the most recently executed MiP API function.
function	bool didLastCallFail()	Checks if the most recently executed MiP API function encountered a critical error.
function	void dispatchEvent(uint8_t command, const uint8_t *payload, size_t)	Central dispatcher for all Out-of-Band events from the transport layer.
function	void printLastCallResult()	Prints a human-readable description of the last error to the debug channel (Serial1).
function	void clear()
function	int8_t attemptMiPConnection(uint32_t baudRate)
function	void mipAssert(bool condition, uint32_t lineNumber, const char *fileName)	Assert mechanism that logs the failure location and then halts.
function	int8_t rawGetStatus(MiPStatus &status)
function	int8_t parseStatus(MiPStatus &status, const uint8_t response[], size_t responseLength)