Feat(docs): proofread docs batch17 (#7680)
This commit is contained in:
@@ -4,12 +4,12 @@
|
||||
Arduino ESP littlefs
|
||||
====================
|
||||
|
||||
LittleFS is a little fail-safe filesystem designed for microcontrollers and integrated in the Arduino framework
|
||||
LittleFS is a little fail-safe filesystem designed for microcontrollers and integrated in the Arduino framework
|
||||
when used with ESP32 and ESP8266.
|
||||
|
||||
Detailed introduction:
|
||||
For a detailed introduction, see:
|
||||
|
||||
- https://github.com/esp8266/Arduino
|
||||
- https://github.com/esp8266/Arduino
|
||||
- https://github.com/espressif/arduino-esp32
|
||||
|
||||
|
||||
|
||||
@@ -4,11 +4,11 @@
|
||||
Arduino SD
|
||||
==========
|
||||
|
||||
Enables reading and writing on SD cards.
|
||||
Once an SD memory card is connected to the SPI interface of the Arduino or Genuino board you can create files
|
||||
and read/write on them. You can also move through directories on the SD card..
|
||||
Enables reading from and writing to SD cards.
|
||||
Once an SD memory card is connected to the SPI interface of the Arduino or Genuino board, you can create files
|
||||
and read from, and write to them. You can also move through directories on the SD card.
|
||||
|
||||
Detailed introduction:
|
||||
For a detailed introduction, see:
|
||||
|
||||
- https://www.arduino.cc/reference/en/libraries/sd/
|
||||
|
||||
|
||||
@@ -4,47 +4,55 @@
|
||||
Barcode
|
||||
=======
|
||||
|
||||
Barcode generation with LVGL. Uses
|
||||
`code128 <https://github.com/fhunleth/code128>`__ by
|
||||
The LVGL Barcode utility enables you to generate Code-128 bar codes. It uses the
|
||||
`code128 <https://github.com/fhunleth/code128>`__ library by
|
||||
`fhunleth <https://github.com/fhunleth>`__.
|
||||
|
||||
|
||||
|
||||
.. _barcode_usage:
|
||||
|
||||
Usage
|
||||
-----
|
||||
*****
|
||||
|
||||
Enable :c:macro:`LV_USE_BARCODE` in ``lv_conf.h``.
|
||||
Set :c:macro:`LV_USE_BARCODE` to ``1`` in ``lv_conf.h``.
|
||||
|
||||
Use :cpp:func:`lv_barcode_create` to create a barcode object, and use
|
||||
:cpp:func:`lv_barcode_update` to generate a barcode.
|
||||
|
||||
Call :cpp:func:`lv_barcode_set_scale` to adjust scaling,
|
||||
call :cpp:func:`lv_barcode_set_dark_color` and :cpp:func:`lv_barcode_set_light_color`
|
||||
adjust color, call :cpp:func:`lv_barcode_set_direction` will set
|
||||
direction to display, and call :cpp:func:`lv_barcode_update` again to regenerate
|
||||
the barcode.
|
||||
adjust colors. Call :cpp:func:`lv_barcode_set_direction` to set the bar code's
|
||||
orientation. After any of a bar code's settings have changed, call
|
||||
:cpp:func:`lv_barcode_update` again to regenerate it.
|
||||
|
||||
|
||||
|
||||
Notes
|
||||
-----
|
||||
*****
|
||||
|
||||
- It is best not to manually set the width of the barcode, because when
|
||||
the width of the Widget is lower than the width of the barcode, the
|
||||
display will be incomplete due to truncation.
|
||||
- The scale adjustment can only be an integer multiple, for example,
|
||||
:cpp:expr:`lv_barcode_set_scale(barcode, 2)` means 2x scaling.
|
||||
- The direction adjustment can be :cpp:enumerator:`LV_DIR_HOR` or :cpp:enumerator:`LV_DIR_VER`
|
||||
- The direction setting can be :cpp:enumerator:`LV_DIR_HOR` or :cpp:enumerator:`LV_DIR_VER`.
|
||||
|
||||
|
||||
|
||||
.. _barcode_example:
|
||||
|
||||
Example
|
||||
-------
|
||||
*******
|
||||
|
||||
.. include:: ../../examples/libs/barcode/index.rst
|
||||
|
||||
|
||||
|
||||
.. _barcode_api:
|
||||
|
||||
API
|
||||
---
|
||||
***
|
||||
|
||||
:ref:`code128_h`
|
||||
|
||||
|
||||
@@ -1,54 +1,60 @@
|
||||
.. _bmp:
|
||||
|
||||
===========
|
||||
BMP decoder
|
||||
BMP Decoder
|
||||
===========
|
||||
|
||||
This extension allows the use of BMP images in LVGL.
|
||||
This BMP Decoder utility allows you to use images from .BMP files in LVGL.
|
||||
|
||||
Library source: https://github.com/caj-johnson/bmp-decoder
|
||||
|
||||
The pixels are read on demand (not the whole image is loaded)
|
||||
Instead of loading the whole image at once, BMP pixels are read on demand,
|
||||
so using BMP images requires very little RAM.
|
||||
|
||||
If enabled in ``lv_conf.h`` by :c:macro:`LV_USE_BMP` LVGL will register a new
|
||||
image decoder automatically so BMP files can be directly used as image
|
||||
sources. For example:
|
||||
If enabled in ``lv_conf.h`` by setting :c:macro:`LV_USE_BMP` to ``1``, LVGL will
|
||||
register a new image decoder automatically so BMP files can be directly used as image
|
||||
sources. Example:
|
||||
|
||||
.. code-block:: c
|
||||
|
||||
lv_image_set_src(my_img, "S:path/to/picture.bmp");
|
||||
|
||||
Note that, a file system driver needs to registered to open images from
|
||||
files. Read more about it :ref:`overview_file_system` or just
|
||||
enable one in ``lv_conf.h`` with ``LV_USE_FS_...``
|
||||
Note that, a :ref:`file_system` driver needs to registered to open images from
|
||||
files. Follow the instructions in :ref:`file_system`.
|
||||
|
||||
|
||||
|
||||
.. _bmp_limitations:
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
***********
|
||||
|
||||
- Only BMP files are supported and BMP images as C array
|
||||
(:c:struct:`lv_image_dsc_t`) are not. It's because there is no practical
|
||||
- Only BMP files are supported. BMP images as C arrays
|
||||
(:c:struct:`lv_image_dsc_t`) are not. This is because there is no practical
|
||||
differences between how the BMP files and LVGL's image format stores
|
||||
the image data.
|
||||
- BMP files can be loaded only from file. If you want to store them in
|
||||
flash it's better to convert them to C array with `LVGL's image converter <https://lvgl.io/tools/imageconverter>`__.
|
||||
- The BMP files color format needs to match with :c:macro:`LV_COLOR_DEPTH`.
|
||||
Use GIMP to save the image in the required format. Both RGB888 and
|
||||
ARGB888 works with :c:macro:`LV_COLOR_DEPTH` ``32``
|
||||
- Palette is not supported.
|
||||
- Because not the whole image is read in cannot be zoomed or rotated.
|
||||
- BMP files can be loaded only from .BMP files. If you want to store them in
|
||||
flash it's better to convert them to a C array with `LVGL's image converter <https://lvgl.io/tools/imageconverter>`__.
|
||||
- The BMP file's color format needs to match the configured :c:macro:`LV_COLOR_DEPTH`
|
||||
of the display on which it will be rendered. You can use GIMP to save the image
|
||||
in the required format. Both RGB888 and ARGB888 works with
|
||||
:c:macro:`LV_COLOR_DEPTH` ``32``
|
||||
- Color palettes are not supported.
|
||||
- Because the whole image is not loaded, it cannot be zoomed or rotated.
|
||||
|
||||
|
||||
|
||||
.. _bmp_example:
|
||||
|
||||
Example
|
||||
-------
|
||||
*******
|
||||
|
||||
.. include:: ../../examples/libs/bmp/index.rst
|
||||
|
||||
|
||||
|
||||
.. _bmp_api:
|
||||
|
||||
API
|
||||
---
|
||||
***
|
||||
|
||||
|
||||
Reference in New Issue
Block a user