Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Next usb_device #4295

Open
wants to merge 11 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions components/usb_device.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
USB Device
==========

ESP32S2 and ESP32S3 allow to develop USB devices. One of the examples of USB device is ``USB_CDC`` :doc:`logger component </components/logger>`.

.. seo::
:description: Instructions for setting up USB Device in ESPHome.

USB Device Configuration
------------------------

.. code-block:: yaml

binary_sensor:
- platform: usb_device
configured:
name: USB is configured


Binary Sensor
-------------

A binary sensor platform to read USB devices status

Configuration variables:
************************

- **configured** (*Optional*): On if USB device is configured.

- **name** (**Required**, string): The name for the configured binary sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this binary sensor for use in lambdas.
- All other options from :ref:`Binary sensor <config-binary_sensor>`.

See Also
--------

- :ref:`logger`
- :ghedit:`Edit`
1 change: 1 addition & 0 deletions images/usb-port.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,7 @@ Miscellaneous
Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg
Tuya Binary Sensor, components/binary_sensor/tuya, tuya.png
WireGuard, components/wireguard, wireguard_custom_logo.svg, dark-invert
USB Device, components/usb_device, usb-port.svg

Output Components
-----------------
Expand Down