Skip to content

Commit

Permalink
Merge pull request letscontrolit#4818 from tonhuisman/feature/P036-up…
Browse files Browse the repository at this point in the history
…dates-for-documentation

[P036] Updates for documentation
  • Loading branch information
TD-er authored Sep 26, 2023
2 parents de55dbb + 725c640 commit 18270ad
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/source/Plugin/P036.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,21 @@ Device Settings
.. image:: P036_ScrollOptions.png

* **Scroll**: Switching between pages can be "instant", "scrolling" or a "ticker" band. Please note that scrolling will need more resources of the ESP, which can have an effect on other active tasks of the node.

For the ``Ticker`` there are some restrictions:

* Depending on the build used (NORMAL and CUSTOM) this option is available
* only one line is displaying the ticker string
* all line contents are parsed and combined to this ticker string, the parsing happens only at each ticker start (using the setting ``Interval``)
* the optional split token ``<|>`` is replaced by three spaces
* the gaps between the ticker items must be set by the ``line content`` (tailing spaces)
* the gaps between the ticker items must be set by the ``line content`` (trailing spaces)
* the starting alignment (left, center, right) depends on the setting ``Align content (global)``
* the font is taken from the setting ``Modify font`` of the first line, the ``Alignment`` settings of the lines are ignored (always right aligned)
* the ticker speed depends on the length of the ticker string and the setting ``Interval`` setting
* the ticker speed depends on the length of the ticker string and the task ``Interval`` setting
* the footer is automatically hidden

.. spacer
* **GPIO <- Display button**: Setting up a ``Display Button``, allows to configure a Display Timeout and wake the display on demand, either by a button, or by using some presence detection.

.. image:: P036_PinModeOptions.png
Expand Down Expand Up @@ -108,7 +112,7 @@ Content

.. image:: P036_HeaderOptions.png

* **Header** / **Header (alternate)**: The plugin allows for a header line, which may show some user selectable information. When using a different setting for **Header (alternate)**, the header will be updated halfway of the Interval time.
* **Header** / **Header (alternate)**: The plugin allows for a header line, which may show some user selectable information. When using a different setting for **Header (alternate)**, the header will be updated halfway of the Interval time. The **User defined 1/2** options are not available in all builds. If they are available, their content can be set using the ``oledframedcmd,userDef1,'<user Defined Header1>'`` and ``oledframedcmd,userDef2,'<user Defined Header2>'`` commands (by default they are empty), see the command reference below for details.

* **Scroll long lines**: When checked, lines that won't fit on the display will be scrolled to be completely shown.

Expand Down
Binary file modified docs/source/Plugin/P036_HeaderOptions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 18270ad

Please sign in to comment.