MiP

Class MiP

Members & Functions

Type	Signature	Description
enum	uint8_t FlagBits
variable	constexpr uint8_t MIP_CMD_DISCONNECT_APPNone	MiP protocol command bytes related to core functions.
variable	constexpr uint8_t MIP_CMD_SLEEPNone
variable	constexpr uint8_t MIP_CMD_GET_STATUSNone
variable	constexpr uint8_t MIP_ERROR_NONENone	Integer error codes that can be encountered by the MiP library.
variable	constexpr uint8_t MIP_ERROR_TIMEOUTNone
variable	constexpr uint8_t MIP_ERROR_NO_EVENTNone
variable	constexpr uint8_t MIP_ERROR_BAD_RESPONSENone
variable	constexpr uint8_t MIP_ERROR_MAX_RETRIESNone
variable	MiP_Battery batteryNone
variable	MiP_ChestLED chestLEDNone
variable	MiP_Clap clapNone
variable	MiP_EEPROM eepromNone
variable	MiP_Gesture gestureNone
variable	MiP_HeadLEDs headLEDsNone
variable	MiP_Infrared infraredNone
variable	MiP_Mode modeNone
variable	MiP_Motion motionNone
variable	MiP_Odometer odometerNone
variable	MiP_Position positionNone
variable	MiP_Radar radarNone
variable	MiP_Serial serialNone
variable	MiP_Shake shakeNone
variable	MiP_Sound soundNone
variable	MiP_Version versionNone
variable	MiP_Weight weightNone
variable	MiP_Wifi wifiNone
friend	class MiP_BatteryNone
friend	class MiP_ChestLEDNone
friend	class MiP_ClapNone
friend	class MiP_EEPROMNone
friend	class MiP_GestureNone
friend	class MiP_HeadLEDsNone
friend	class MiP_InfraredNone
friend	class MiP_ModeNone
friend	class MiP_MotionNone
friend	class MiP_WifiNone
friend	class MiP_OdometerNone
friend	class MiP_PositionNone
friend	class MiP_RadarNone
friend	class MiP_SerialNone
friend	class MiP_ShakeNone
friend	class MiP_SoundNone
friend	class MiP_VersionNone
friend	class MiP_WeightNone
variable	uint8_t m_flagsNone
variable	int8_t m_lastErrorNone
variable	MiPStatus m_lastStatusNone
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)