diff --git a/docs/README.md b/docs/README.md index 8336bfc..5a1f84d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,13 @@ # Little Red Docs +![Many rovers on a table](./_images/home_page.webp) + Welcome to the documentation for the Little Red Rover robotics platform. -Little Red Rover is in development, and is not ready for active use. The current documentation is written for an ongoing user study being conducted at Cornell University, and should not be considered stable or comprehensive. +Little Red Rover is in development, and is not ready for use. +This version of the documentation is written for a user study being conducted at Cornell University, and should not be considered stable or comprehensive. -If you are interested in following the project, check out the [GitHub organization](https://github.com/little-red-rover) for the project, or take a look at the source code: +If you are interested in the project, check out the [GitHub organization](https://github.com/little-red-rover) and take a look at the source code: [Docs](https://github.com/little-red-rover/lrr-docs) diff --git a/docs/_images/home_page.webp b/docs/_images/home_page.webp new file mode 100644 index 0000000..6009f38 Binary files /dev/null and b/docs/_images/home_page.webp differ diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 313b7eb..2d88f77 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -11,5 +11,5 @@ * Contributing - [Coming soon...](contributing.md) * Troubleshooting - - [Coming soon...](troubleshooting.md) + - [FAQs](faqs.md) - [Firmware Tool](firmware_tool.md) diff --git a/docs/assembly.md b/docs/assembly.md index 3b6435d..eabef21 100644 --- a/docs/assembly.md +++ b/docs/assembly.md @@ -27,8 +27,8 @@ In the cable bag: | Item | Quantity | Picture | | ---- | ---- | ---- | -| 4-pin JST GH 1.25mm straight across cable | 1 | ![Motor cables](./_images/assembly/motor_cables-resize.webp) | -| 6-pin JST PH 2.0mm reversed cables | 2 | ![Lidar cable](./_images/assembly/lidar_cable-resize.webp) | +| 4-pin JST GH 1.25mm straight across cable | 1 | ![Motor cables](./_images/assembly/lidar_cable-resize.webp) | +| 6-pin JST PH 2.0mm reversed cables | 2 | ![Lidar cable](./_images/assembly/motor_cables-resize.webp) | In the small parts bag: @@ -123,7 +123,7 @@ Congrats! Your robot is assembled! ## Care for Your Rover The rover has a USB C port which you can use to charge the battery. -Two red status LEDs, directly below charging port, show the charging status. +Two red LEDs, directly below charging port, show the charging status. The first LED, labeled CHARGING, lights up when the battery is actively being charged. Once the battery is fully charged, this light will turn off. diff --git a/docs/faqs.md b/docs/faqs.md new file mode 100644 index 0000000..8e4fddd --- /dev/null +++ b/docs/faqs.md @@ -0,0 +1,23 @@ +# FAQs + +Coming soon... + +This page will contain frequenly requested troubleshooting information. + +## Connectivity + +## Status LEDs + +## Updating Firmware + +Firmware out of date? +Use the [firmware tool](/firmware_tool) to flash the most recent version. + +## Reading the Microcontroller's Console + +While debugging, its sometimes useful to read the logs from the microcontroller on your rover. +The [firmware tool](/firmware_tool) allows you to open a console using your browser. + +## Still Need Help? + +Didn't find what you needed? Try [making a post on the forum](https://github.com/orgs/little-red-rover/discussions). diff --git a/docs/firmware_tool.md b/docs/firmware_tool.md index e7977fd..a8453ab 100644 --- a/docs/firmware_tool.md +++ b/docs/firmware_tool.md @@ -1,3 +1,9 @@ # Firmware Tool +Connect your rover to your computer using the provided USB cable. Turn the rover on. + +To flash it with the newest firmware, click 'Program'. To open a console click 'Open Console'. + +For either option, you'll be asked to select a serial device. Chose the option that says 'USB JTAG / serial debug unit'. + [firmware tool](/firmware_tool.html ':include :type=iframe width=100% height=400px') diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md deleted file mode 100644 index 2cc9f9d..0000000 --- a/docs/troubleshooting.md +++ /dev/null @@ -1,13 +0,0 @@ -# Troubleshooting - -Coming soon... - -This page will contain troubleshooting information. - -## Status LEDs - -## MCU Debug Logs - -## Still Need Help? - -Didn't find what you needed? Try [making a post on the forum](https://github.com/orgs/little-red-rover/discussions).