Home

Welcome to the MiP_ESP8266_Library wiki!

Here you will find all documentation for the MiP_ESP8266_Library. This is a guide to all functions calls in the API. Functions calls are organized into 17 groups identified in the table below and explained in separate pages listed to the right. Below are links to various examples which demonstrate how to use each function in the library.

Functions

Group	Function
Initialization	MiP()
	begin()
	end()
	sleep()
	isInitialized()
Radar	enableRadarMode()
	disableRadarMode()
	isRadarModeEnabled()
	areGestureAndRadarModesDisabled()
	readRadar()
Gesture	enableGestureMode()
	disableGestureMode()
	isGestureModeEnabled()
	areGestureAndRadarModesDisabled()
	availableGestureEvents()
	readGestureEvent()
Chest LED	writeChestLED()
	readChestLED()
Head LEDs	writeHeadLEDs()
	readHeadLEDs()
Motion	continuousDrive()
	distanceDrive()
	turnLeft()
	turnRight()
	driveForward()
	driveBackward()
	stop()
	fallForward()
	fallBackward()
	getUp()
Sound	playSound()
	beginSoundList()
	addEntryToSoundList()
	playSoundList()
	writeVolume()
	readVolume()
Odometer	readDistanceTravelled()
	resetDistanceTravelled()
Battery Level	readBatteryVoltage()
Position	readPosition()
	isOnBack()
	isFaceDown()
	isUpright()
	isPickedUp()
	isHandStanding()
	isFaceDownOnTray()
	isOnBackWithKickstand()
Weight	readWeight()
Clap	enableClapEvents()
	disableClapEvents()
	areClapEventsEnabled()
	writeClapDelay()
	readClapDelay()
	availableClapEvents()
	readClapEvent()
Shake	hasBeenShaken()
Version Info	readSoftwareVersion()
	readHardwareInfo()
Game Modes	enableAppMode()
	enableCageMode()
	enableDanceMode()
	enableStackMode()
	enableTrickMode()
	enableRoamMode()
	isAppModeEnabled()
	isCageModeEnabled()
	isDanceModeEnabled()
	isStackModeEnabled()
	isTrickModeEnabled()
	isRoamModeEnabled()
EEPROM	setUserData()
	getUserData()
Infrared	enableMiPDetectionMode()
	disableMiPDetectionMode()
	isMiPDetectionModeEnabled()
	readDetectedMiP()
	sendIRDongleCode()
	readIRDongleCode()

Examples

• ChestLED: Take control of the RGB LED in the chest of the MiP.
• Clap: Send descriptive messages to the Arduino IDE about each clap event deteced by the MiP robot.
• ContinuousDrive: You want to control the motion of the MiP in real time? This is the example for you.
• DisconnectApp: Disconnect all apps, including this sketch and any app that may be connected to Bluetooth.
• DistanceDrive: Tell the MiP robot exactly how far to travel and forget about it.
• DriveForwardBackward: Tell the MiP robot how long to drive forward/backward and forget about it.
• EnableGameMode: Cycle through each of the game modes available.
• EnableMiPDetectionMode: Allow your MiP to be discovered by others.
• FallDown: Tired of standing around? Command MiP to fall flat on his face.
• Gesture: Use your hand to make gesture to your MiP robot. Send descriptive messages to the Arduio IDE about each gesture event detected.
• GestureRadarMode: Want to learn more about how to enable/disable IR based gesture and radar measurements? Check out this example.
• GetUp: If your MiP robot falls down, learn how to have him try getting back up on his feetwheels.
• HeadLEDs: Take control of the 4 individual eye LEDs on the MiP robot's head.
• Odometer: How far has your MiP robot been traveling around your personal robot laboratory? This example shows you how to find out and reset its measurement.
• PlaySound: Learn how to get the MiP robot vocalizing under your control!
• Radar: Is there anything in front of your MiP robot? This example sends descriptive text to the Arduino IDE when it detects changes in the obstacles around it.
• RawSendReceive: You found a command in WowWee's Protocol Specification that isn't supported by this library? This example shows you how to experiment with these new commands.
• ReadWriteEeprom: Read and write your own data to MiP's EEPROM. This is useful for storing data across power cycles. See also ZeroEeprom.
• ReadIRDongleCode: Reads IR signals sent from another MiP. See also SendIRDongleCode.
• SendIRDongleCode: Sends IR signals to another MiP. See also ReadIRDongleCode.
• SRSdemo: The MiP robot made an appearance at the Seattle Robotics Society meeting on April 21st, 2018. This is what he was running!
• Shake: Is someone shaking your poor little MiP robot? This example shows you how to detect such rudeness and report it to the Arduino IDE.
• SoftwareHardwareVersion: This example shows you how to peek under the covers and see what hardware / software is running inside your MiP robot.
• Status: Detect changes in the MiP robot's battery level or pose and report them to the Arduino IDE.
• Stop: Danger! Danger! MiP Robot! Stop your MiP robot in its tracks before it gets itself into more trouble.
• TurnLeftRight: Tell the MiP robot exactly how many degrees to turn and forget about it.
• Volume: Your MiP robot is too loud? Turn down the volume with this example.
• Weight: Detect weight changes in what the MiP is carrying and report them to the Arduino IDE.
• ZeroEeprom: Write zeroes to each available byte in EEPROM. See also ReadWriteEeprom.