From 06e824824c0a0be831d35f15d4fc2436d0960199 Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Sat, 16 Sep 2023 22:43:24 +0200 Subject: [PATCH] enumerate headings --- docs/Error-Codes.md | 2 +- docs/External-LED.md | 6 +++--- docs/Testing.md | 2 +- mkdocs.yml | 8 +++++--- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/Error-Codes.md b/docs/Error-Codes.md index 5ef25f6..487dad6 100644 --- a/docs/Error-Codes.md +++ b/docs/Error-Codes.md @@ -1,4 +1,4 @@ - # Reduced webinterface (error indication and tracing) +# Reduced webinterface (error indication and tracing) Whenever an error occurs during boot process which avoids loading of regular processing and regular webinterface, a reduced webinterface gets loaded to have at least some visual feedback and the possibilitiy to figure out the root cause by browsing the logfiles or trigger another OTA update. diff --git a/docs/External-LED.md b/docs/External-LED.md index 142833b..337b3f3 100644 --- a/docs/External-LED.md +++ b/docs/External-LED.md @@ -1,4 +1,4 @@ -## External LED +# External LED The internal flash LED is very close to the camera axis. This results in reflection, especially in case of flat glass surfaces such as for power meters. To circumvent this problem, it is now possible to control external LEDs, which than can be places somewhere else in the setup. As not simples LEDs are used, but RGB LEDs with a digital interface like WS2812 not only the position, but also the color and intensity of the illumination can now be adjusted. The following image shows a direct comparison of the "old" internal flash LED and two off axis LEDs. @@ -17,7 +17,7 @@ There is also a new [meter adapter](https://www.thingiverse.com/thing:5028229) a -#### 1. Hardware installation of the LED stripe +## 1. Hardware installation of the LED stripe The control line of the LED stripe is connected with a 470 Ohm resistor to the GPIO12. For power supply stabilization a capacitor between 5V and ground is recommended. Here a 470µF polymer capacitor is used. As a power supply a 5V from the ESP32 is used like in the following wiring. @@ -28,7 +28,7 @@ For power supply stabilization a capacitor between 5V and ground is recommended. -#### 2. Software configuration +## 2. Software configuration The handling of the WS2812 LED controller needs some other libraries, therefore it is controlled within a dedicated section called ``GPIO Settings``. The external LED stripe is connected to GPIO12. After activating the "GPIO Settings" section, the internal flash is per default disabled. In order to activate the external LED, you need to activate ``GPIO 12 state`` and select ``"extern flash light ws281x ..."``. diff --git a/docs/Testing.md b/docs/Testing.md index 3d32f2b..1d42f58 100644 --- a/docs/Testing.md +++ b/docs/Testing.md @@ -1,4 +1,4 @@ -## Testing Option for VSCode +# Testing Option for VSCode You can test your functions directly on the device. diff --git a/mkdocs.yml b/mkdocs.yml index 631e929..07564d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,9 +10,11 @@ theme: plugins: - - search - - awesome-pages: - filename: nav.yml + - search + - awesome-pages: + filename: nav.yml + - enumerate-headings: + increment_across_pages: false # The navigation is configured in the docs/nav.yml file!