Skip to content

Commit

Permalink
Add docs for SDL binary sensor (#4644)
Browse files Browse the repository at this point in the history
Co-authored-by: clydebarrow <[email protected]>
  • Loading branch information
bdm310 and clydebarrow authored Feb 5, 2025
1 parent 865070b commit 73ddef8
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
29 changes: 29 additions & 0 deletions components/binary_sensor/sdl.rst
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`
1 change: 1 addition & 0 deletions components/display/sdl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ See Also
--------

- :ref:`SDL touchscreen <sdl_touchscreen>`
- :doc:`SDL binary sensor </components/binary_sensor/sdl>`
- :doc:`index`
- :apiref:`sdl/sdl_esphome.h`
- :ghedit:`Edit`
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -652,6 +652,7 @@ Core
Home Assistant, components/binary_sensor/homeassistant, home-assistant.svg, dark-invert
Status, components/binary_sensor/status, server-network.svg, dark-invert
Switch, components/binary_sensor/switch, electric-switch.svg, dark-invert
Host SDL2, components/binary_sensor/sdl, sdl.png

Capacitive Touch
****************
Expand Down

0 comments on commit 73ddef8

Please sign in to comment.