mirror of
https://github.com/HASwitchPlate/openHASP.git
synced 2025-07-27 21:26:43 +00:00
Update docs
This commit is contained in:
fvanroie
parent
5ccbac6ef5
commit
72c25628ae
@ -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
|
||||
|
||||
|
||||
|
||||
> [!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.
|
||||
|
||||
<sub>Images of STM32 boards are [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) from https://stm32-base.org/</sub>
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -1,9 +1,7 @@
|
||||
|
||||
## Wifi
|
||||
|
||||
When using a wireless network adapter, you need to configure the SSID to connect.
|
||||
|
||||
|
||||
|
||||
|
||||
### Wifi Settings
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
<!-- docs/_sidebar.md -->
|
||||
|
||||
- **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)
|
||||
|
||||
@ -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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user