Skip to content

Commit

Permalink
boards/esp32s3-devkit: fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gschorcht committed Jul 7, 2023
1 parent e487ac5 commit 1155b6a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
2 changes: 2 additions & 0 deletions boards/esp32s3-devkit/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,8 @@ UART_DEV(0) RxD | GPIO44 | Console (configuration is fixed) | \ref esp32_uart_in
</center>
\n

@note The RGB-LED is connected to GPIO38 on ESP32-S3-DevKitC-1 revision 1.1 boards.

For detailed information about the peripheral configurations of ESP32-S3
boards, see section \ref esp32_peripherals "Common Peripherals".

Expand Down
16 changes: 9 additions & 7 deletions boards/esp32s3-devkit/include/board.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,15 @@
/**
* @brief Default button GPIO pin definition
*
* ESP32-S3-DevKit boards have a BOOT button connected to GPIO9, which can be
* used as button during normal operation. Since the GPIO9 pin is pulled up,
* ESP32-S3-DevKit boards have a BOOT button connected to GPIO0, which can be
* used as button during normal operation. Since the GPIO0 pin is pulled up,
* the button signal is inverted, i.e., pressing the button will give a
* low signal.
*/
#define BTN0_PIN GPIO0

/**
* @brief Default button GPIO mode definition
*
* Since the GPIO of the button is pulled up with an external resistor, the
* mode for the GPIO pin has to be GPIO_IN.
*/
#define BTN0_MODE GPIO_IN_PU

Expand All @@ -74,8 +71,13 @@
/**
* @name LED (on-board) configuration
*
* ESP32-S3-DevKit boards have a SK68XXMINI-HS smart RGB-LED connected to
* GPIO48 on-board. The WS281x driver module `ws281x` can be used to control it.
* ESP32-S3-DevKit boards have a SK68XXMINI-HS smart RGB LED on-board connected
* to either
*
* - GPIO48 (ESP32-S3-DevKitC-1 revision 1.0 and all ESP32-S3-DevKitM-1 boards) or
* - GPIO38 (ESP32-S3-DevKitC-1 revision 1.1).
*
* The WS281x driver module `ws281x` can be used for control.
* @{
*/
#ifndef WS281X_PARAM_PIN
Expand Down

0 comments on commit 1155b6a

Please sign in to comment.