diff --git a/components/output/images/x9c.jpg b/components/output/images/x9c.jpg new file mode 100644 index 000000000..b355f2679 Binary files /dev/null and b/components/output/images/x9c.jpg differ diff --git a/components/output/x9c.rst b/components/output/x9c.rst new file mode 100644 index 000000000..b3b496c05 --- /dev/null +++ b/components/output/x9c.rst @@ -0,0 +1,56 @@ +X9C Potentiometer Output +======================== + +.. seo:: + :description: Instructions for setting up a X9C digital potentiometer with ESPHome. + :image: description.svg + +The ``x9c`` output platform allows you to an output that controls a `X9C digital potentiometer `__. + +.. figure:: images/x9c.jpg + :align: center + :width: 70.0% + + X9C digital potentiometer + +The X9C family of digital potentiometers are available in different resistance values. + +==================== ===================== +``X9C102`` ``1kΩ`` +-------------------- --------------------- +``X9C103`` ``10kΩ`` +-------------------- --------------------- +``X9C503`` ``50kΩ`` +-------------------- --------------------- +``X9C104`` ``100kΩ`` +==================== ===================== + +All chips are controlled by a three wire interface and feature 100 possible wiper positions. + +.. code-block:: yaml + + # Example configuration entry + output: + - platform: x9c + id: x9c_pot + cs_pin: GPIO25 + inc_pin: GPIO27 + ud_pin: GPIO26 + initial_value: 0.5 + +Configuration variables: +------------------------ + +- **id** (**Required**, :ref:`config-id`): The id to use for this output component. +- **cs_pin** (**Required**, :ref:`Pin Schema `): Chip Select pin +- **inc_pin** (**Required**, :ref:`Pin Schema `): Increment pin +- **ud_pin** (**Required**, :ref:`Pin Schema `): Up/Down pin +- **initial_value** (*Optional*, float): Manually specify the initial potentiometer value, between ``0.01`` and ``1.0``. Defaults to ``1.0``. +- All other options from :ref:`Output `. + +See Also +-------- + +- :doc:`/components/output/index` +- :apiref:`x9c/x9c.h` +- :ghedit:`Edit` diff --git a/images/x9c.jpg b/images/x9c.jpg new file mode 100644 index 000000000..b355f2679 Binary files /dev/null and b/images/x9c.jpg differ diff --git a/index.rst b/index.rst index eb50b8708..99a5d62e2 100644 --- a/index.rst +++ b/index.rst @@ -447,6 +447,7 @@ Output Components Template Output, components/output/template, description.svg BP1658CJ, components/output/bp1658cj, bp1658cj.svg BP5758D, components/output/bp5758d, bp5758d.svg + X9C Potentiometer, components/output/x9c, x9c.jpg Light Components ----------------