Skip to content

Commit 227fe0c

Browse files
committed
moved bluetooth connection faq stuff to dedicated bluetooth page. added power file in main guide. moved reading datasheets to resources
1 parent f15d598 commit 227fe0c

File tree

15 files changed

+51
-33
lines changed

15 files changed

+51
-33
lines changed
146 KB
Loading

docs/_sections/_guide-FAQ/competition_logistics.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,6 @@ TODO address given materials not being enough to finish mechanical challenge as
2626
TODO make list of things
2727

2828
## Where can we store our robot in the RAS office?
29-
TODO
29+
TODO
30+
31+
## What can we keep after the competition?

docs/_sections/_guide-FAQ/technical.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,12 @@ There is a maximum storage of 4 Bluetooth addresses in the allow-list. Simply re
2525
<img src="{{ '/_assets/images/allowlist_remove.png' | prepend: site.baseurl }}" alt="allowlist_remove :(">
2626
<img src="{{ '/_assets/images/allowlist_add.png' | prepend: site.baseurl }}" alt="allowlist_add :(">
2727

28+
If this fails, then try [hard resetting your ESP32’s flash memory](https://randomnerdtutorials.com/esp32-erase-flash-memory/) and try again!
2829

29-
## I tried doing the above, but my controller isn’t connecting! How do I troubleshoot?
30-
See [BluePad32's official docs](https://bluepad32.readthedocs.io/en/latest/FAQ/#:~:text=true%3B%0A%7D-,Using%20allowlist%20commands%20from%20the%20USB%20console,%C2%B6,-Note)
3130

32-
This is probably an issue with BluePad32’s whitelisted connections. You will not be able to connect your controller to the ESP32 without adding your controller’s Bluetooth address to the whitelist.
33-
34-
Try manually adding your controller's Bluetooth address through the serial terminal
35-
36-
If this fails, then try [hard resetting your ESP32’s flash memory](https://randomnerdtutorials.com/esp32-erase-flash-memory/)
3731

3832
## Why bother with the whitelisted Bluetooth connections for the controller?
39-
In previous years, connecting the controller when many robots were powered on in close proximity was a nightmare because connecting to the wrong robot was unfortunately inevitable.
33+
Connecting the controller without a specific address when many robots are powered on in close proximity is a nightmare.
4034

4135
## I can’t flash my ESP32 because of a “fatal error”! What should I do?
4236
<img src="{{ '/_assets/images/fatal_error.png' | prepend: site.baseurl }}" alt="fatal_error.png :(">
@@ -52,16 +46,13 @@ If that fails, close VS Code and reopen it.
5246

5347
If *that* fails, then check if there are any other applications on your computer that are occupying the COM port (extreme solution is to restart computer).
5448

55-
## How to calibrate the QTR line sensor?
56-
TODO actualy make sure u incorporate this in the main guide portion lol
57-
5849
## How does the ESP-IDF build system work?
5950
This information is not required for the competition, but it can be good to know if you'd like to continue IoT develpoment with Espressif MCU's.
6051

6152
Here is a link to their official documentation: [https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html#component-requirements](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html#component-requirements)
6253

6354
## What is ESP-IDF?
64-
ESP-IDF (**Esp**ressif **I**oT **D**evelopment **F**ramework) is the official development framework for building applications for Espressif's ESP32 microcontroller series.
55+
ESP-IDF (**Esp**ressif **I**oT **D**evelopment **F**ramework) is the official development framework for Espressif's ESP32 microcontroller series.
6556

6657
For Robotathon, you will use the VS Code ESP-IDF extension to develop your robot's software.
6758

docs/_sections/_guide-primaries/getting-started/bluepad.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,37 @@ nav_order: 6
88

99
# Bluetooth Controller
1010

11-
The purpose of the remote controller is to allow manual control of your robot for triggering your autonomous modes, moving between challenges, and firing your launching mechanism.
11+
You will be connecting a game controller to your ESP32 for controlling your robot (i.e. triggering autonomous modes, moving between challenges, and firing your launching mechanism)
1212

13-
That being said, you will not be allowed to manually drive your robot through the challenges, as that defeats the purpose of having the sensors
13+
That being said, you will not be allowed to manually drive your robot through the challenges, as that defeats the purpose of having the sensors.
1414

15-
It is highly recommended that you program specific functions of the sensors (line, color, distance) to specific buttons on the remote controller so that you have more control over your robot's behavior (i.e. press A -> color sensing mode).
15+
It is highly recommended that you program specific functions of the sensors (line, color, distance) to specific buttons on the remote controller so that you have more control over your robot's behavior (i.e. press A -> color autonomy mode, press B -> exit to normal drive mode).
1616

17+
## Connecting the Controller
1718

19+
See [BluePad32's official docs](https://bluepad32.readthedocs.io/en/latest/FAQ/#:~:text=true%3B%0A%7D-,Using%20allowlist%20commands%20from%20the%20USB%20console,%C2%B6,-Note) if you'd like to see other features.
1820

19-
## How do I find out what my controller’s Bluetooth address is?
20-
1. Plug in your ESP32 and flash it with the starter code in your forked repository if you haven't already
21+
22+
First you will need to find out what your controller's Bluetooth address is.
23+
1. Plug in your ESP32 and flash it with the starter code
2124
1. Open the serial monitor
22-
1. You should see this in the serial monitor while trying to connect your controller:
25+
1. You should see this in the serial monitor while trying to connect your controller (press and hold power button on controller until lights slowly and then rapidly move):
2326
<img src="{{ '/_assets/images/controller_address.png' | prepend: site.baseurl }}" alt="controller_address :(">
24-
The string of octets (something like “98:B6:E1:7C:C3:95”) is your controller’s Bluetooth address
27+
The string of octets (something like `98:B6:E1:7C:C3:95`) is your controller’s Bluetooth address
28+
29+
1. Try adding your controller's Bluetooth address through the serial terminal:
30+
<img src="{{ '/_assets/images/add_bluetooth.png' | prepend: site.baseurl }}" alt="add_bluetooth.png :(">
31+
32+
1. Controller should connect automatically, and the controller data should begin streaming in the serial monitor
33+
34+
## Using the Controller
35+
36+
- BP32.update()
37+
- for loop in loop()
38+
- todo: actually figure out how the iterator works and make it something more standard to be understandable by anyone
39+
40+
- accessing controller data
2541

26-
## How do I connect my controller?
27-
1. Make sure you have added your controller’s Bluetooth address to the ESP32 ([How do I do that?](TODO WRITE THIS))
28-
1. Power and flash ESP32 with starter code
29-
1. Press and hold the home button on your controller (big H button in the middle) until the lights turn on and then speed up
30-
1. Controller should connect automatically
3142

3243

3344

docs/_sections/_guide-primaries/getting-started/environment-setup/environment-setup.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ parent: Getting Started
88
nav_order: 3
99
---
1010

11+
# Environment Setup
12+
1113
The exact process to arrive at this goal depends on what OS your computer is running (Windows, macOS, etc.), so this article will be split into Windows and MacOS setup. If you happen to use another OS, then talk to a mentor for help.
1214

1315
The end goal of this section is to flash your ESP32 with an LED blink program. It will take you from having nothing installed to the full coding environment you'll need for the competition!

docs/_sections/_guide-primaries/getting-started/environment-setup/mac-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ grand_parent: Getting Started
77
nav_order: 1
88
---
99

10-
## macOS Setup
10+
# macOS Setup
1111
https://docs.espressif.com/projects/vscode-esp-idf-extension/en/latest/installation.html
1212

1313

docs/_sections/_guide-primaries/getting-started/environment-setup/windows-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ grand_parent: Getting Started
77
nav_order: 1
88
---
99

10-
## Windows Setup
10+
# Windows Setup
1111

1212
{: .highlight}
1313
It is highly recommended to follow each component installation in order!

docs/_sections/_guide-primaries/getting-started/git.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ It is your job to go into the file and delete **all** the special markers along
9292

9393
For example, let's say we had some C++ file that had a merge conflict:
9494

95+
96+
TODO make this code something more like robotathon code?? (oh no oh no namespaces oh no)
97+
9598
```cpp
9699
#include <iostream>
97100

@@ -106,7 +109,7 @@ int main() {
106109
}
107110
```
108111

109-
You would have to modify the content accordingly to look something like this:
112+
You could modify the content accordingly to look something like this:
110113
```cpp
111114
#include <iostream>
112115

docs/_sections/_guide-primaries/sensors-and-actuators/actuators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: default
33
title: Actuators
44
nav_include: true
55
parent: Sensors and Actuators
6-
nav_order: 4
6+
nav_order: 5
77
---
88

99
# Actuators

docs/_sections/_guide-primaries/sensors-and-actuators/color-sensors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: default
33
title: Color Sensor
44
nav_include: true
55
parent: Sensors and Actuators
6-
nav_order: 1
6+
nav_order: 2
77
---
88

99
# Color Sensor

0 commit comments

Comments
 (0)