-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for SDL binary sensor (#4644)
Co-authored-by: clydebarrow <[email protected]>
- Loading branch information
1 parent
865070b
commit 73ddef8
Showing
3 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
SDL Binary Sensor | ||
================= | ||
|
||
.. seo:: | ||
:description: Instructions for setting up an SDL keyboard binary sensor. | ||
|
||
The ``sdl`` binary sensor platform creates a binary sensor from keyboard presses on the host platform. | ||
The sensor will be true when the key is pressed. | ||
|
||
Configuration variables: | ||
------------------------ | ||
|
||
- **key** (**Required**): The ID of an `SDL key <https://www.libsdl.org/release/SDL-1.2.15/docs/html/sdlkey.html>`_. | ||
- All other variables from :ref:`Binary Sensor <config-binary_sensor>`. | ||
|
||
Example: | ||
|
||
.. code-block:: yaml | ||
binary_sensor: | ||
- platform: sdl | ||
id: key_id | ||
key: SDLK_a | ||
See Also | ||
-------- | ||
- :doc:`Host Platform </components/host>` | ||
- :ref:`SDL display <sdl>` | ||
- :ghedit:`Edit` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters