From 5aae1e3ae02d9871de1022b931678923759e0b90 Mon Sep 17 00:00:00 2001 From: fvanroie Date: Thu, 24 Dec 2020 00:33:54 +0000 Subject: [PATCH] Update docs --- docs/06-faq.md | 2 +- docs/13-objects.md | 23 ++++++++++++++++++++++- docs/_sidebar.md | 15 ++++++++++----- docs/index.md | 20 ++++++++++++-------- 4 files changed, 45 insertions(+), 15 deletions(-) diff --git a/docs/06-faq.md b/docs/06-faq.md index 45d01801..85c15a14 100644 --- a/docs/06-faq.md +++ b/docs/06-faq.md @@ -26,6 +26,6 @@ When the `edit.htm.gz` file is present on Spiffs you will see an additional File Using that webpage, you can right-click and delete files: ![HTTP configuration](assets/images/faq/faq_file_delete.png "Delete file") -#### :question: Is there a file browser built-in? +#### :question: How to delete files from flash? *See: Is there a file browser built-in?* \ No newline at end of file diff --git a/docs/13-objects.md b/docs/13-objects.md index b92c25ad..5a0a85a9 100644 --- a/docs/13-objects.md +++ b/docs/13-objects.md @@ -1,3 +1,7 @@ +There are 2 ways to create an object on the screen: +- Uploading a pages.jsonl file onto the internal flash +- Use the `jsonl` command, via MQTT, serial or telnet console + ## Common Properties These are the common properties shared among all objects: @@ -46,6 +50,23 @@ You can still hide the object on select pages if needed. Objects on this page ap Each object type is an ID that indicates which object type that line represents. Besides the common properties listed above, each object type can have specific properties. +### Cheatsheet + +| objid | Type | +|:-----:|:-----------| +| 10 | [Button](13-objects?id=button) | +| 11 | [Checkbox](13-objects?id=checkbox) | +| 12 | [Label](13-objects?id=text-label) | +| 20 | [Colorpicker](13-objects?id=colorpicker) | +| 21 | [Spinner](13-objects?id=spinner) | +| 22 | [Arc](13-objects?id=arc) | +| 30 | [Slider](13-objects?id=slider) | +| 31 | [Gauge](13-objects?id=gauge) | +| 32 | [Progressbar](13-objects?id=progressbar) | +| 40 | [Switch](13-objects?id=switch) | +| 41 | [LED](13-objects?id=led-indicator) | +| 50 | [Dropdown List](13-objects?id=dropdown-list) | +| 51 | [Roller](13-objects?id=roller) | ### Button **objid:10** @@ -239,7 +260,7 @@ When the item is changed both `val` and `txt` of the newly selected item are sen | txt | string | no | "" | *Read-only* The text of the selected item | rows | int8 | no | 3 | The number ow rows that are visible -?> A roller does not use the `h` attribute to set its height, but uses the rows to set the visible number of rows instead. +!> A roller does not use the `h` attribute to set its height but uses the `rows` attribute instead. To change the currently selected item, use the `val` attribute. To change the items in the list, use the `options` attribute. diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 053d109f..480084b8 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -39,11 +39,16 @@ - [STM32F4xx](./39-firmware-stm32.md) - **Hardware** - - Alternate Dev Boards - + + - Tested Displays - - [MHS4001](displays/MHS4001.md) - - [WaveShare 4.0" RPi LCD (rev C)](displays/Waveshare_40RPi_LCD(C).md) - - [MRB3511](displays/MRB3511.md) + * [MHS4001](displays/MHS4001.md) + * [MRB3511](displays/MRB3511.md) + * [WaveShare 4.0" RPi LCD (rev C)](displays/Waveshare_40RPi_LCD(C).md) - [**License**](21-license.md) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 19ef47f7..7f6aed42 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,21 +1,25 @@ -# Hasp-lvgl Documentation +# Hasp-lvgl ## Purpose -Hasp-lvgl is a microcontroller firmware that can run on ESP and STM32F4 with an off-the-shelve touch display. +Hasp-lvgl is a microcontroller firmware that runs on ESP and STM32F4 boards using an off-the-shelve touch display. You can use the hasp-lvgl firmware to create a custom touchscreen user interface. -It can display information and you can create objects like touch buttons, switches and LEDs on the touchscreen to interact with your home automation system. - -The communication is done over the network via MQTT. +It can display information received over mqtt and you can create on-screen objects to interact with your home automation system, +like touch buttons, switches, LEDs and more... This project is a re-implementation of the popular HASwitchPlate sketch created by aderusha. The original HASwitchPlate project uses a Wemos D1 mini and requires a Nextion/TJC HMI display. This rewrite removes the Nextion/TJC requirement by using the Littlev Graphics Library on the MCU to drive a cheap commodity display. -This version also adds ESP32 and STM32F4 support to take advantage of the additional hardware capabilities. - ## Requirements -To run the firmware, you only need a compatible microcontroller and touch display. +To run the firmware, you only need a compatible [microcontroller](01-hardware?id=recommended-boards) and [touch display](01-hardware?id=recommended-display). +## Support + +For support using hasp-lvgl, please join the Discord channel +![Discord](https://img.shields.io/discord/538814618106331137?color=%237289DA&label=%23hasp-lvgl&logo=discord&logoColor=white) + + \ No newline at end of file