diff --git a/docs/01-hardware.md b/docs/01-hardware.md index 7f2971ef..c62c9746 100644 --- a/docs/01-hardware.md +++ b/docs/01-hardware.md @@ -40,11 +40,9 @@ table th:last-of-type { [4]: https://www.aliexpress.com/item/32815530502.html [5]: https://www.aliexpress.com/item/32977375539.html -> [!WARNING] -> \* *Due to the large number of possible hardware options a selection of 3 popular ESP development boards has been made for the precompiled binaries.* +!> \* *Due to the large number of possible hardware options a selection of 3 popular ESP development boards has been made for the precompiled binaries.* -> [!NOTE] -> Advanced users can build and compile custom configurations using PlatformIO, however this is not currently supported. +?> Advanced users can build and compile custom configurations using PlatformIO, however this is not currently supported. ## Recommended Display @@ -68,8 +66,7 @@ To use PWM dimming on the Lolin TFT 2.4" you must solder the TFT-LED pin to eith ![TFT-LED PWM dimming](assets/images/tft-led-pwm.png) -> [!WARNING] -> Do *not* use D3 for backlight control because it is already in use for touch! +!> Do *not* use D3 for backlight control because it is already in use for touch! > [!ATTENTION] > It is also *not* recommended to use D4 for backlight control because it is already in use for PSram on the ESP32-Wrover. @@ -90,9 +87,8 @@ no need to use any jumper cables: - Wemos D1 Mini ESP8266 - Lolin D1 Mini Pro ESP8266 V2.0.0 -> [!NOTE] -> If you have a Lolin TFT 2.4" Display and a compatible ESP development board, you have all the hardware that is needed. -> In that case you can skip ahead to the [Firmware Installation](./installation.md). +?> If you have a Lolin TFT 2.4" Display and a compatible ESP development board, you have all the hardware that is needed. +?> In that case you can skip ahead to the [Firmware Installation](./installation.md). ## Alternative SPI Display @@ -153,7 +149,6 @@ The following boards are being tested: - Documentation can be found on [GitHub](https://github.com/mcauser/BLACK_F407ZG) -> [!NOTE] -> The STM32F4 boards do not have network connectivity. You can use a compatible network adapter and configure it in PlatformIO. +?> The STM32F4 boards do not have network connectivity. You can use a compatible network adapter and configure it in PlatformIO. Images of STM32 boards are [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) from https://stm32-base.org/ \ No newline at end of file diff --git a/docs/02-installation.md b/docs/02-installation.md index d4387cdb..0ebd1853 100644 --- a/docs/02-installation.md +++ b/docs/02-installation.md @@ -8,8 +8,7 @@ There are currently 2 download options, pick the one appropriate for your hardwa - hasp-lvgl-0.2.0-esp32_ili9341_spi.bin + boot files - hasp-lvgl-0.2.0-esp8266_ili9341_spi.bin -> [!NOTE] -> If no precompiled firmware file is available for your board you can configure, compile and upload the firmware yourself using PlatformIO. +?> If no precompiled firmware file is available for your board you can configure, compile and upload the firmware yourself using PlatformIO. ## Install the firmware @@ -56,8 +55,7 @@ Change `COM1` to the correct port on your computer and `4m` to the correct size ### STM32F407 devEbox -> [!NOTE] -> There is no precompiled firmware file available for STM32F4 boards. You will need to configure, compile and upload the firmware yourself using PlatformIO. +?> There is no precompiled firmware file available for STM32F4 boards. You will need to configure, compile and upload the firmware yourself using PlatformIO. #### Using Serial diff --git a/docs/Configuration/32-mqtt.md b/docs/Configuration/32-mqtt.md index ba3be6cd..cdbbaa7e 100644 --- a/docs/Configuration/32-mqtt.md +++ b/docs/Configuration/32-mqtt.md @@ -1,11 +1,9 @@ -## MQTT - All communication between **HASP Open Display** and your Home Automation service is done over MQTT. You will need an already working MQTT Broker. :question: If you do not know what MQTT is you can find more about the protocol on [MQTT Essentials](http://www.hivemq.com/mqtt-essentials/) -![MQTT Settings](assets/images/settings/mqtt_settings.png "MQTT Settings") +![MQTT Settings](../assets/images/settings/mqtt_settings.png "MQTT Settings") ### MQTT Settings diff --git a/docs/Configuration/33-hasp.md b/docs/Configuration/33-hasp.md index a309d199..f1a21f47 100644 --- a/docs/Configuration/33-hasp.md +++ b/docs/Configuration/33-hasp.md @@ -1,9 +1,7 @@ -## HASP interface - You can configure the general look and feel for the interface by uploading you favorite fonts and selecting your favorite theme and color. -![HASP Settings](assets/images/settings/hasp_settings.png "HASP Settings") +![HASP Settings](../assets/images/settings/hasp_settings.png "HASP Settings") ### HASP Settings diff --git a/docs/Configuration/34-wifi.md b/docs/Configuration/34-wifi.md index fbfe3fe6..62f01329 100644 --- a/docs/Configuration/34-wifi.md +++ b/docs/Configuration/34-wifi.md @@ -1,9 +1,7 @@ -## Wifi - When using a wireless network adapter, you need to configure the SSID to connect. -![HASP Settings](assets/images/settings/wifi_settings.png "Wifi Settings") +![HASP Settings](../assets/images/settings/wifi_settings.png "Wifi Settings") ### Wifi Settings diff --git a/docs/Configuration/35-display.md b/docs/Configuration/35-display.md index 6ea2a238..d5c28722 100644 --- a/docs/Configuration/35-display.md +++ b/docs/Configuration/35-display.md @@ -1,8 +1,6 @@ -## Display - You can configure the general look and feel for the interface by uploading you favorite fonts and selecting your favorite theme and color. -![HASP Settings](assets/images/settings/hasp_settings.png "HASP Settings") +![HASP Settings](../assets/images/settings/hasp_settings.png "HASP Settings") ### HASP Settings diff --git a/docs/Configuration/36-gpio.md b/docs/Configuration/36-gpio.md index fb8596cc..f1a21f47 100644 --- a/docs/Configuration/36-gpio.md +++ b/docs/Configuration/36-gpio.md @@ -1,9 +1,7 @@ -## GPIO - You can configure the general look and feel for the interface by uploading you favorite fonts and selecting your favorite theme and color. -![HASP Settings](assets/images/settings/hasp_settings.png "HASP Settings") +![HASP Settings](../assets/images/settings/hasp_settings.png "HASP Settings") ### HASP Settings diff --git a/docs/Configuration/37-debug.md b/docs/Configuration/37-debug.md index a0f00900..f1a21f47 100644 --- a/docs/Configuration/37-debug.md +++ b/docs/Configuration/37-debug.md @@ -1,9 +1,7 @@ -## Debug - You can configure the general look and feel for the interface by uploading you favorite fonts and selecting your favorite theme and color. -![HASP Settings](assets/images/settings/hasp_settings.png "HASP Settings") +![HASP Settings](../assets/images/settings/hasp_settings.png "HASP Settings") ### HASP Settings diff --git a/docs/Configuration/_sidebar.md b/docs/Configuration/_sidebar.md index 8588aea3..5775da37 100644 --- a/docs/Configuration/_sidebar.md +++ b/docs/Configuration/_sidebar.md @@ -1,10 +1,10 @@ - **Configuration** -- [HTTP](./configuration/30-http.md) -- [MQTT](./configuration/32-mqtt.md) -- [HASP](./configuration/33-hasp.md) -- [Wifi](./configuration/34-wifi.md) -- [Display](./configuration/35-display.md) -- [GPIO](./configuration/36-gpio.md) -- [Debug](./configuration/37-debug.md) +- [HTTP](./Configuration/30-http.md) +- [MQTT](./Configuration/32-mqtt.md) +- [HASP](./Configuration/33-hasp.md) +- [Wifi](./Configuration/34-wifi.md) +- [Display](./Configuration/35-display.md) +- [GPIO](./Configuration/36-gpio.md) +- [Debug](./Configuration/37-debug.md) diff --git a/docs/displays/Waveshare_40RPi_LCD(C).md b/docs/displays/Waveshare_40RPi_LCD(C).md index f75b90e9..f25d0f37 100644 --- a/docs/displays/Waveshare_40RPi_LCD(C).md +++ b/docs/displays/Waveshare_40RPi_LCD(C).md @@ -27,8 +27,7 @@ Pin |Function |ESP32 Pin |Config Name|Display Pin | 25 |Module Ground |GND | |GND 26 |Touch Chip Select |GPIO22 |TOUCH_CS |TP_CS -> [!WARNING] -> (*)Only the WaveShare 4.0" RPi LCD Revision C has a solder jumper on the back to enable PWM backlight dimming. +!> (*)Only the WaveShare 4.0" RPi LCD Revision C has a solder jumper on the back to enable PWM backlight dimming. Other revisions of this board do not have this feature. SPI MISO, MOSI and SCLK are shared between the touch controller and the lcd controller.