diff --git a/docs/calibration.md b/docs/calibration.md index 41c654a..59d0f37 100644 --- a/docs/calibration.md +++ b/docs/calibration.md @@ -18,7 +18,7 @@ You can always view the hue value on your Moab by navigating to and selecting HU ## Servo Offset (plate level) calibration -The servo offset calibration is a bit more advanced and is only necessary to do if your Moab is having trouble balancing the ball or the plate visibly needs to be leveled. It is important to complete the Ball Hue and Position calibration step before following this procedure. +The servo offset calibration is a bit more advanced and is only necessary to do if your Moab is having trouble balancing the ball or the plate visibly needs to be leveled. It is important to complete the Ball Hue and Position calibration step before following this procedure. [Connecting](https://github.com/microsoft/moabian/blob/docs-v3-updates/docs/connecting.md) to your Moab is a prerequisite to this procedure. @@ -34,7 +34,7 @@ The servo offset calibration is a bit more advanced and is only necessary to do ![bot-json](images/bot-json.png) -5. Restart the Moab software using the command bot reset in the command line. +5. Restart the Moab software using the command **bot reset** in the command line. 6. Check the level of the plate using JOYSTICK mode. diff --git a/docs/readme.md b/docs/readme.md index 93e84af..0eae7bd 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -11,13 +11,12 @@ This can take up to a minute if Moab is not connected to internet. 1. **Joystick Mode** - Once Moab has booted, "MANUAL" mode will be displayed on the - screen. Press the joystick to select Manual mode. The plate will + Navigate to and select "JOYSTICK" mode by presssing the joystick. The plate will rise up and now you can manually control the pitch and roll of the plate using the joystick. Place the ping pong ball on the plate and try balancing the ball manually! - To exit Manual mode, select the menu button next to the joystick. + To exit Joystick mode, select the menu button next to the joystick. 2. **PID Mode** @@ -26,24 +25,23 @@ This can take up to a minute if Moab is not connected to internet. works by minimizing the error between the actual ball position and velocity, and the desired ball position and velocity. This type of controller is the most commonly found in industrial control - applications. + applications. This controller has been tuned specifially for the ping pong ball. - Move the joystick down and select "CLASSIC" mode. Place the orange + Move the joystick down and select "PID" mode. Place the orange ping pong ball on the plate and watch Moab automatically balance the ball. Try disturbing the ball by poking it or blowing on it and watch Moab return the ball to the center. - If Moab is unable to balance a ball or making erratic movements, go - on to step 4. Troubleshooting. + If Moab is unable to balance a ball or making erratic movements, see [Troubleshooting](https://github.com/microsoft/moabian/blob/docs-v3-updates/docs/troubleshooting.md). - To exit Classic mode, select the menu button next to the joystick. + To exit PID mode, select the menu button next to the joystick. 3. **Brain Mode** This is a brain that has been trained using the Bonsai platform. The brain is a neural network that has been trained using two goals: prevent the ball from falling off the plate, and balance the ball at - the center of the plate. + the center of the plate. For details of how this brain was trained, see [Moab Tutorial 2](https://microsoft.github.io/moab/tutorials/2-robustness/index.html). Move the joystick down and select "BRAIN" mode. Place the orange ping pong ball on the plate and watch Moab automatically balance diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index e7e9809..8b05d05 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -2,12 +2,13 @@ If your Moab is not able to balance a ball in PID or BRAIN1 mode, we recommend the following troubleshooting steps: -1. Check your lighting situation. Are there any objects or lights in - the room that Moab could be mistaking for orange ping pong balls? You can check by viewing the camera stream. Follow the directions [here](https://github.com/microsoft/moabian/blob/docs-update/docs/view-camera-stream.md). If this is the case try moving Moab to another location, blocking the lights, or changing the lighting situation. You could also try using a different ball color. +1. Check your lighting situation. Are there any objects or lights in the room that Moab could be mistaking for orange ping pong balls? You can check by viewing the camera stream. Follow the directions [here](https://github.com/microsoft/moabian/blob/docs-update/docs/view-camera-stream.md). + + If this is the case try moving Moab to another location, blocking the lights, or changing the lighting situation. -2. Calibrate the camera. Move the joystick down and select - "CALIBRATE". Follow the instructions on the screen to calibrate - the camera to recognize the color of the ball. +2. Calibrate the ball hue and position. These instructions can be found on the [Calibration](https://github.com/microsoft/moabian/blob/docs-v3-updates/docs/calibration.md) page. If calibrating the ball hue and position does not solve the problem, complete the Servo Offset calibration as well. + +3. If your Moab is still having trouble after calibrating, try using different colored balls, such as [these](https://www.amazon.com/STIGA-Assorted-Multicolor-Recreational-Quality-Regulation/dp/B000GF6030/ref=sr_1_20?dchild=1&keywords=ping+pong+balls+color&qid=1617201019&sr=8-20). 3. If your Moab is still unable to balance a ball after following - the steps above, please contact us for a troubleshooting guide. + the steps above, please contact us for troubleshooting assistance.