Skip to content

Commit

Permalink
Merge branch '0.7.0' of https://github.com/yetanothercarbot/openHASP-…
Browse files Browse the repository at this point in the history 
…docs into 0.7.0
  • Loading branch information
@yetanothercarbot
yetanothercarbot committed Jul 30, 2024
2 parents 74020d7 + b7c02bc commit ca50218
Show file tree
Hide file tree
Showing 13 changed files with 423 additions and 71 deletions.
1 change: 1 addition & 0 deletions docs/design/objects/.pages
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ nav:
- spinner.md
- switch.md
- tabview.md
- qrcode.md
Binary file added docs/design/objects/images/lv_ex_qrcode_1.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs/design/objects/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ There are two ways to create an object on the screen:
| arc | Range | [Arc](#arc) | indicator, knob
| linemeter | Range | [Line Meter](#line-meter) |
| gauge | Range | [Gauge](#gauge) | indicator, ticks
| qrcode | Visual | [Qrcode](#qrcode) |


## Common Parameters

Expand Down Expand Up @@ -724,6 +726,24 @@ Either PNG or BIN image files are supported, from flash:
{"page":1,"id":34,"obj":"img","src":"L:/image.png","auto_size":0,"w":50}
```

# QR-Code
**obj:`qrcode`**

![lv_qrcode](images/lv_ex_qrcode_1.png)

| Property | Value | Default | Description
|----------|--------------|---------|--------------------------
| text | [string][10] | "" | The text to encode to QR code
| size | [int16][9] | 140 | The object is always a square with a width and a height that correspond to size.


???+ example "Example `jsonl`"
```json linenums="1"
{"page":1,"id":42,"obj":"qrcode","text":"www.openhasp.com/0.7.0/design/objects/","x":520,"y":20,"size":200}
```

!!! note :
The maximum text length depends on the QR code version. By default, the maximum version 7 is used, which corresponds to a maximum text length of 122 characters.

## Base Object
**obj:`obj`**
Expand Down
38 changes: 38 additions & 0 deletions docs/design/objects/qrcode.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# QR-Code
**obj:`qrcode`**

![lv_qrcode](images/lv_ex_qrcode_1.png)

| Property | Value | Default | Description
|----------|------------|---------|--------------------------
| text | [string][10] | "" | The text to encode to QR code
| size | [int16][9] | 140 | The object is always a square with a width and a height that correspond to size.


???+ example "Example `jsonl`"
```json linenums="1"
{"page":1,"id":42,"obj":"qrcode","text":"www.openhasp.com/0.7.0/design/objects/","x":520,"y":20,"size":200}
```

!!! note :
The maximum text length depends on the QR code version. By default, the maximum version 7 is used, which corresponds to a maximum text length of 122 characters.


[1]: ../../data-types/#colors
[2]: ../../data-types/#boolean
[3]: ../../../configuration/gpio/#groupid
[4]: ../../styling/#general
[5]: ../../styling/#image
[6]: ../../styling/#value
[7]: ../../styling/#line
[8]: ../../styling/#scale
[9]: ../../data-types/#integer
[10]: ../../data-types/#string
[11]: ../../data-types/#json-object
[12]: ../../styling/
[13]: ../../styling/#padding-and-margin
[14]: ../../styling/#text
[15]: ../../data-types/#variables
[16]: https://lvgl.io/tools/imageconverter
[17]: ../../../integrations/home-assistant/sampl_conf/#using-tags
[18]: ../../styling/#parts
68 changes: 34 additions & 34 deletions docs/hardware/adafruit/featherwing.md
View file
Original file line number Diff line number Diff line change
@@ -1,60 +1,61 @@
# Adafruit

<div class="row justify-content-center">
<a href="../images/featherwing24.png" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-6" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing'>Adafruit Featherwing 2.4&quot;</a>" data-footer="Original image by <a href='https://learn.adafruit.com/assets/40718'>Ruiz Brothers</a> - LICENSE: <a href='https://creativecommons.org/licenses/by-sa/3.0/'>Attribution-ShareAlike Creative Commons</a>">
<img src="../images/featherwing24.png" class="img-fluid">
</a>
<a href="../images/featherwing35.jpg" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-6" data-title="<a href='https://learn.adafruit.com/touch-deck-diy-tft-customized-control-pad/assemble-the-touch-deck'>Adafruit Featherwing 3.5&quot;</a>" data-footer="Original image by <a href='https://learn.adafruit.com/assets/100822'>John Park</a> - LICENSE: <a href='http://creativecommons.org/licenses/by-nc-sa/3.0/'>Attribution-NonCommercial-ShareAlike Creative Commons</a>">
<img src="../images/featherwing35.jpg" class="img-fluid">
</a>
<a href="../images/featherwing24.png" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-6" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing' target='_blank'>Adafruit Featherwing 2.4&quot;</a>" data-footer="Original image by <a href='https://learn.adafruit.com/assets/40718' target='_blank'>Ruiz Brothers</a> - LICENSE: <a href='https://creativecommons.org/licenses/by-sa/3.0/' target='_blank'>Attribution-ShareAlike Creative Commons</a>">
<img src="../images/featherwing24.png" class="img-fluid">
</a>
<a href="../images/featherwing35.jpg" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-6" data-title="<a href='https://learn.adafruit.com/touch-deck-diy-tft-customized-control-pad/assemble-the-touch-deck' target='_blank'>Adafruit Featherwing 3.5&quot;</a>" data-footer="Original image by <a href='https://learn.adafruit.com/assets/100822' target='_blank'>John Park</a> - LICENSE: <a href='http://creativecommons.org/licenses/by-nc-sa/3.0/' target='_blank'>Attribution-NonCommercial-ShareAlike Creative Commons</a>">
<img src="../images/featherwing35.jpg" class="img-fluid">
</a>
</div>

openHASP runs on Adafruit's ESP32 Feather Boards and supports Adafruit's TFT Featherwing resistive touch screens. Build configurations and precompiled firmware binaries are available for these popular hardware combinations to help you get started quickly.

## Supported Boards

openHASP supports the following Adafruit Feather boards (and the many different versions and variations based on them)
openHASP supports the following Adafruit Feather boards (and the many different versions and variations based on them):

- Adafruit HUZZAH32 - ESP32 Feather (4MB Flash, No PSRAM)
- Adafruit ESP32-S3 Feather (4MB Flash, 2MB PSRAM)
- Adafruit ESP32 Feather V2 (8MB Flash, 2MB PSRAM)

These boards are virtually plug-and-play when combined with Adafruit TFT FeatherWing displays. Many of these boards come in versions with pre-soldered headers (no soldering required)
These boards are virtually plug-and-play when combined with Adafruit TFT FeatherWing displays. Many of these boards come in versions with pre-soldered headers (no soldering required).

!!! note " Note" Don't use the Adafruit ESP8266-based Feather HUZZAH board as it lacks both sufficient memory and MCU power.

!!! note " Note" Boards with PSRAM are highly recommended, and required for image processing.
!!! warning
Don't use the Adafruit ESP8266-based Feather HUZZAH as it lacks both sufficient memory and MCU power.

!!! note
Boards with PSRAM are highly recommended, and required for image processing.

## Supported Displays

- TFT FeatherWing - 2.4" 320x240 Touchscreen *(ILI9341 with STMPE610 resistive touch)*
- [TFT FeatherWing - 2.4" 320x240 Touchscreen V2](https://www.adafruit.com/product/3315) *(ILI9341 with TSC2007 resistive touch)*
- [TFT FeatherWing - 2.4" 320x240 Touchscreen V2](https://www.adafruit.com/product/3315){target=_blank} *(ILI9341 with TSC2007 resistive touch)*
- TFT FeatherWing - 3.5" 480x320 Touchscreen *(HX8357D with STMPE610 resistive touch)*
- [TFT FeatherWing - 3.5" 480x320 Touchscreen V2](https://www.adafruit.com/product/3651): *(HX8357D with TSC2007 resistive touch)*
- [TFT FeatherWing - 3.5" 480x320 Touchscreen V2](https://www.adafruit.com/product/3651){target=_blank} *(HX8357D with TSC2007 resistive touch)*

<div class="row justify-content-center">
<a href="../images/feather_3405_iso_ORIG.jpg" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing'>TFT Feather Wing Enclosure</a>" data-footer="Original image by <a href='https://learn.adafruit.com/users/adafruit2'>lady ada</a> - All rights reserved">
<img src="../images/feather_3405_iso_ORIG.jpg" class="img-fluid">
</a>
<a href="../images/feather_3591_iso_ORIG.jpg" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing'>TFT Feather Wing Enclosure</a>" data-footer="Original image by <a href='https://learn.adafruit.com/users/adafruit2'>lady ada</a> - All rights reserved">
<img src="../images/feather_3591_iso_ORIG.jpg" class="img-fluid">
</a>
<a href="../images/feather_3619_iso_ORIG.jpg" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing'>TFT Feather Wing Enclosure</a>" data-footer="Original image by <a href='https://learn.adafruit.com/users/adafruit2'>lady ada</a> - All rights reserved">
<img src="../images/feather_3619_iso_ORIG.jpg" class="img-fluid">
</a>
<a href="../images/feather_3405_iso_ORIG.jpg" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing' target='_blank'>TFT Feather Wing Enclosure</a>" data-footer="Original image by <a href='https://learn.adafruit.com/users/adafruit2' target='_blank'>lady ada</a> - All rights reserved">
<img src="../images/feather_3405_iso_ORIG.jpg" class="img-fluid">
</a>
<a href="../images/feather_3591_iso_ORIG.jpg" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing' target='_blank'>TFT Feather Wing Enclosure</a>" data-footer="Original image by <a href='https://learn.adafruit.com/users/adafruit2' target='_blank'>lady ada</a> - All rights reserved">
<img src="../images/feather_3591_iso_ORIG.jpg" class="img-fluid">
</a>
<a href="../images/feather_3619_iso_ORIG.jpg" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing' target='_blank'>TFT Feather Wing Enclosure</a>" data-footer="Original image by <a href='https://learn.adafruit.com/users/adafruit2' target='_blank'>lady ada</a> - All rights reserved">
<img src="../images/feather_3619_iso_ORIG.jpg" class="img-fluid">
</a>
</div>

Check out Adafruit's [TFT Featherwing tutorial](https://learn.adafruit.com/adafruit-2-4-tft-touch-screen-featherwing) on [learn.adafruit.com](https://learn.adafruit.com/) for detailed information and wiring diagrams.
Check out Adafruit's [TFT Featherwing tutorial](https://learn.adafruit.com/adafruit-2-4-tft-touch-screen-featherwing){target=_blank} on [learn.adafruit.com](https://learn.adafruit.com/){target=_blank} for detailed information and wiring diagrams.

## Backlight

By default, the display is always on and at its maximum brightness. To control backlight dimming or sleeping, you need to solder the `LITE` pin to a PWM output pin (e.g., `GPIO 21`).
By default, the display is always on and at its maximum brightness. To control backlight dimming or sleeping, you need to solder the `LITE` pad on the TFT Featherwing to a PWM output pin on the Feather board (e.g., `GPIO 21` on the Adafruit HUZZAH32 - ESP32 Feather or `GPIO 37` on the Adafruit ESP32 Feather V2, as these are, respectively, the closest pins to the `LITE` pad).

<div class="row justify-content-center">
<a href="../images/featherwing35-backlight.png" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-8" data-title="Backlight Control" data-footer="Original image by altersis">
<img src="../images/featherwing35-backlight.png" class="img-fluid">
</a>
<a href="../images/featherwing35-backlight.png" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-8" data-title="Backlight Control" data-footer="Original image by altersis">
<img src="../images/featherwing35-backlight.png" class="img-fluid">
</a>
</div>

## Product Videos
Expand Down Expand Up @@ -93,16 +94,15 @@ Check out these enclosures available on Thingiverse:
- [3.5" TFT FeatherWing Touch Deck](https://www.thingiverse.com/thing:4803265){target=_blank}

<div class="row justify-content-center">
<a href="../images/3d_printing_done-assembly.gif" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing'>TFT Feather Wing Enclosure</a>" data-footer="Original image by <a href='https://learn.adafruit.com/assets/40717'>Ruiz Brothers</a> - LICENSE: <a href='https://creativecommons.org/licenses/by-sa/3.0/'>Attribution-ShareAlike Creative Commons</a>">
<img src="../images/3d_printing_done-assembly.gif" class="img-fluid">
</a>
<a href="../images/3d_printing_touchdeck.gif" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/touch-deck-diy-tft-customized-control-pad/assemble-the-touch-deck'>Adafruit Featherwing 3.5&quot; Touch Deck</a>" data-footer="Original image by <a href='https://learn.adafruit.com/assets/100924'>John Park</a> - LICENSE: <a href='http://creativecommons.org/licenses/by-nc-sa/3.0/'>Attribution-NonCommercial-ShareAlike Creative Commons</a>">
<img src="../images/3d_printing_touchdeck.gif" class="img-fluid">
</a>
<a href="../images/3d_printing_done-assembly.gif" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/3d-printed-case-for-adafruit-feather/tft-feather-wing' target='_blank'>TFT Feather Wing Enclosure</a>" data-footer="Original image by <a href='https://learn.adafruit.com/assets/40717' target='_blank'>Ruiz Brothers</a> - LICENSE: <a href='https://creativecommons.org/licenses/by-sa/3.0/' target='_blank'>Attribution-ShareAlike Creative Commons</a>">
<img src="../images/3d_printing_done-assembly.gif" class="img-fluid">
</a>
<a href="../images/3d_printing_touchdeck.gif" data-toggle="lightbox" data-gallery="example-gallery" class="col-sm-4" data-title="<a href='https://learn.adafruit.com/touch-deck-diy-tft-customized-control-pad/assemble-the-touch-deck' target='_blank'>Adafruit Featherwing 3.5&quot; Touch Deck</a>" data-footer="Original image by <a href='https://learn.adafruit.com/assets/100924' target='_blank'>John Park</a> - LICENSE: <a href='http://creativecommons.org/licenses/by-nc-sa/3.0/' target='_blank'>Attribution-NonCommercial-ShareAlike Creative Commons</a>">
<img src="../images/3d_printing_touchdeck.gif" class="img-fluid">
</a>
</div>



!!! info "About Adafruit"
*Adafruit invests time and resources providing open source code and libraries,
please support Adafruit and open-source hardware by purchasing products from Adafruit!*
4 changes: 3 additions & 1 deletion docs/hardware/elecrow/.pages
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
title: Elecrow
nav:
- Elecrow: esp32-terminal.md
- CrowPanel HMI RGB: crowpanel-hmi-rgb.md
- CrowPanel HMI SPI: crowpanel-hmi-spi.md
- ESP32 Terminal: esp32-terminal.md
Loading

0 comments on commit ca50218

Please sign in to comment.