-
-
Notifications
You must be signed in to change notification settings - Fork 167
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor the resources in docs (#626)
* Refactor the resources in docs * Add alt text to image
- Loading branch information
1 parent
165e6f5
commit 378e8e8
Showing
7 changed files
with
71 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
4 changes: 2 additions & 2 deletions
4
docs/docs/reference/cases.mdx → docs/docs/resources/cases.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
id: gpio | ||
title: GPIO Pinout | ||
description: GPIO pinout of the ESP32 and ESP8266 boards | ||
--- | ||
|
||
# GPIO Pinout | ||
|
||
In this section, you will find the GPIO pinout of the ESP32 and ESP8266 boards. The GPIO pins are used to connect the Photodiode and Status LED to the ESP board of your choice. | ||
|
||
## Photodiode | ||
|
||
How the Photodiode is connected to the ESP board of your choice. | ||
|
||
| PHOTODIODE | ESP32 | ESP8266 | | ||
|------------|--------------|-------------| | ||
| A0 | NOT USING | NOT USING | | ||
| DO | D26 (GPIO26) | D7 (GPIO13) | | ||
| VCC | 3V3 | 3V3 | | ||
| GND | GND | GND | | ||
|
||
## Status LED | ||
|
||
How the status LED is connected to the ESP board of your choice. For each measured pulse, the LED will briefly flash <span style={{ color: 'red' }}>*red*</span> and in case of no WiFi connection, the LED will continue to flash <span style={{ color: 'blue' }}>*blue*</span>. | ||
|
||
| LED | ESP32 | ESP8266 | | ||
|--------|------------|------------| | ||
| RED | D2 (GPIO2) | D4 (GPIO2) | | ||
| GREEN | D4 (GPIO4) | D2 (GPIO4) | | ||
| BLUE | D5 (GPIO5) | D1 (GPIO5) | | ||
| GND | GND | GND | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
id: schematics | ||
title: Schematics | ||
description: How to connect the Photodiode and Status LED based on wiring diagram | ||
--- | ||
|
||
# Schematics | ||
|
||
In this section, you will find the wiring diagram of how to connect the Photodiode and Status LED to the ESP board of your choice. | ||
|
||
## Wiring diagram | ||
|
||
Below you will find a wiring diagram of how everything is connected, depending on the type of board you use, the [GPIO pins](/docs/resources/gpio) may be in a different place. You could also omit the status LED if desired. | ||
|
||
<p align="center"> | ||
<img | ||
width="90%" | ||
src={require('@site/static/img/wiring_diagram.png').default} | ||
alt="Wiring diagram showing connections between Photodiode, Status LED, and ESP board" | ||
/> | ||
</p> | ||
|
||
:::important | ||
Please note that there are different boards in circulation and that the GPIO | ||
pins may be on a different location than in the example above. So always double | ||
check and, if necessary, consult the pin layout of your specific board. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters