esphome · tdy91 · Dec 30, 2024 · Jan 7, 2025 · Jan 15, 2025 · Jan 15, 2025
diff --git a/components/binary_sensor/dallas_pio.rst b/components/binary_sensor/dallas_pio.rst
@@ -0,0 +1,92 @@
+Dallas PIO Binary Sensor
+========================
+
+.. seo::
+    :description: Instructions for setting up Dallas 1-Wire PIO addressable switch as ESPHome binary sensor
+    :image: dallas_pio.jpg
+    :keywords: Dallas, ds2413, ds2406, ds2408, onewire
+
+The ``dallas_pio`` component allows you to use 
+`DS2413 <https://www.adafruit.com/product/1551>`__
+(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS2413.pdf>`__),
+`DS2406`
+(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS2406.pdf>`__),
+`DS2408`
+(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS2408.pdf>`__)
+and similar 1-Wire Dallas addressable switches PIO as ESPHome binary sensors.  A :ref:`Dallas PIO <dallas_pio>` is
+required to be set up in your configuration for this binary sensor to work.
+
+Example Configuration
+*********************
+
+Below are configuration examples for different Dallas devices, including DS2408 with P0-P7 pin usage.
+
+**Single DS2413 on One-Wire Bus**
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    binary_sensor:
+      - platform: dallas_pio
+        name: ds2413 binary sensor  # Friendly name for the binary sensor
+        dallas_pio_id: ds2413_ic1   # Reference to the Dallas PIO component
+        id: ds2413_binary_sensor    # Optional ID for internal reference
+        pin:
+          number: PIOA              # Pin to use on the Dallas device (PIOA/PIOB for DS2413/DS2406, P0-P7 for DS2408)
+          mode:                     # Configuration of the pin's behavior
+            input: true             # If set, must be true to read input values from the pin
+          inverted: true            # Invert the signal (true = active-low, false = active-high)
+        update_interval: 1s         # How often the sensor should poll the pin's state
+
+**Multiple Devices (DS2413 and DS2408) on the Same Bus**
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    binary_sensor:                
+      - platform: dallas_pio      
+        name: ds2413 binary sensor
+        dallas_pio_id: ds2413_ic1 
+        id: ds2413_binary_sensor  
+        pin:                      
+          number: PIOA            
+          mode:                   
+            input: true           
+          inverted: true          
+        update_interval: 1s       
+
+      - platform: dallas_pio      
+        name: ds2408 binary sensor
+        dallas_pio_id: ds2408_ic2 
+        id: ds2408_binary_sensor  
+        pin:                      
+          number: P0            
+          mode:                   
+            input: true           
+          inverted: true          
+        update_interval: 1s       
+
+
+Configuration variables:
+************************
+
+- **name** (*Optional*, string): The name for the sensor. At least one of **id** and **name** must be specified.
+- **id** (*Optional*, string): Manually specify the ID for code generation. At least one of **id** and **name** must be specified.
+- **dallas_pio_id** (*Required*, string): The ID of the dallas pio to use.
+- **pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The PIO pin to use for the binary sensor.
+
+Options:
+  - **number**: The pin to use. For DS2413 or DS2406, use `PIOA` or `PIOB`. For DS2408, use `P0` to `P7`.
+  - **mode**:
+      - `input: true`: Configure the pin as an input (default)
+      - `input: false`: not allowed (binary sensor acts necessarily as an input).
+  - **inverted**: Set to `true` to interpret a high signal as low (active-low). Useful for devices where a low voltage signifies an active state. Defaults to `false`.
+
+- **update_interval** (*Optional*, :ref:`config-time`): The interval that the binary sensors should be checked. Defaults to 1 second.
+- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
+
+See Also
+--------
+
+- :apiref:`dallas_pio/binary_sensor.h`
+- :ghedit:`Edit`
diff --git a/components/dallas_pio.rst b/components/dallas_pio.rst
@@ -0,0 +1,78 @@
+.. _dallas_pio:
+
+Dallas PIO
+==========
+
+.. seo::
+    :description: Instructions for setting up Dallas 1-Wire addressable switches
+    :image: dallas_pio.jpg
+    :keywords: Dallas, PIO, DS2413, DS2406, DS2408, onewire, 1-wire
+
+The ``dallas_pio`` component allows you to use 
+`DS2413 <https://www.adafruit.com/product/1551>`__
+(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS2413.pdf>`__),
+`DS2406`
+(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS2406.pdf>`__),
+`DS2408`
+(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS2408.pdf>`__)
+and similar 1-Wire addressable switches.  A :ref:`1-Wire bus <one_wire>` is
+required to be set up in your configuration for this sensor to work.
+
+Example Configuration
+*********************
+
+Below are configuration examples for different Dallas devices.
+
+**Single DS2413 on One-Wire Bus**
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    dallas_pio:
+      - id: ds2413_ic1
+        name: DS2413 IC1
+        reference: DS2413
+        address: 0xfe10055073e122ba
+        one_wire_id: OneWireBus1
+
+**Multiple Devices (DS2413 and DS2408) on the Same Bus**
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    dallas_pio:
+      - id: ds2413_ic1
+        name: DS2413 IC1
+        reference: DS2413
+        address: 0xfe10055073e122ba
+        one_wire_id: OneWireBus1
+
+      - id: ds2408_ic2
+        name: DS2408 IC2
+        reference: DS2408
+        address: 0x1234567812345628
+        one_wire_id: OneWireBus1
+
+**Address Format**
+
+The `address` parameter specifies the unique 1-Wire address of the device. This address is an 8-byte hexadecimal value (e.g., `0xfe10055073e122ba`) and can typically be obtained using a 1-Wire bus scanner or through the Dallas 1-Wire library.
+
+
+Configuration variables:
+************************
+- **id** (*Optional*, string): Manually specify the ID for code generation. At least one of **id** and **name** must be specified.
+- **name** (*Optional*, string): The name for the sensor. At least one of **id** and **name** must be specified.
+- **reference** (*Optional*, string): The dallas reference of adressable switch among DS2413 (default), DS2406 or DS2408 (see warning note below).
+- **address** (*Required*, int): The address of the sensor. Required if there is more than one device on the bus.
+- **crc** (*Optional*, bool): [DS2406 only] Use CRC if true. Defaults to false.
+- **one_wire_id** (*Required*, :ref:`config-id`): Manually specify the ID used for code generation.  Required if you have multiple busses.
+
+
+See Also
+--------
+
+- :doc:`/components/binary_sensor/index`
+- :doc:`/components/switch/index`
+- :doc:`/components/one_wire`
+- :apiref:`dallas_pio/dallas_pio.h`
+- :ghedit:`Edit`
diff --git a/components/switch/dallas_pio.rst b/components/switch/dallas_pio.rst
@@ -0,0 +1,96 @@
+Dallas PIO Switch
+=================
+
+.. seo::
+    :description: Instructions for setting up Dallas 1-Wire PIO addressable switch as ESPHome switch
+    :image: dallas_pio.jpg
+    :keywords: Dallas, ds2413, ds2406, ds2408, onewire
+
+The ``dallas_pio`` component allows you to use 
+`DS2413 <https://www.adafruit.com/product/1551>`__
+(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS2413.pdf>`__),
+`DS2406`
+(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS2406.pdf>`__),
+`DS2408`
+(`datasheet <https://datasheets.maximintegrated.com/en/ds/DS2408.pdf>`__)
+and similar 1-Wire Dallas addressable switches PIO as ESPHome switch.  A :ref:`Dallas PIO <dallas_pio>` is
+required to be set up in your configuration for this binary sensor to work.
-and similar 1-Wire Dallas addressable switches PIO as ESPHome switch.  A :ref:`Dallas PIO <dallas_pio>` is
-required to be set up in your configuration for this binary sensor to work.
+and similar 1-Wire Dallas addressable switches PIO as ESPHome switch.  A :ref:`Dallas PIO <dallas_pio>` is
+required to be set up in your configuration for this switch to work.
-and similar 1-Wire Dallas addressable switches PIO as ESPHome switch.  A :ref:`Dallas PIO <dallas_pio>` is
-required to be set up in your configuration for this binary sensor to work.
+and similar 1-Wire Dallas addressable switches PIO as ESPHome switch.  A :ref:`Dallas PIO <dallas_pio>` is
+required to be set up in your configuration for this switch to work.
+
+.. warning::
+
+    **DS2408**: don't forget to put a pull up resistor to Vcc on the RSTZ pin to enable writing to ports P0 to P7 !  
+
+Example Configuration
+*********************
+
+Below are configuration examples for different Dallas devices, including DS2408 with P0-P7 pin usage.
+
+**Single DS2413 on One-Wire Bus**
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    switch:
+      - platform: dallas_pio
+        name: ds2413 switch        # Friendly name for the switch
+        dallas_pio_id: ds2413_ic1  # Reference to the Dallas PIO component
+        id: ds2413_switch          # Optional ID for internal reference
+        pin:
+          number: PIOB             # Pin to use on the Dallas device (PIOA/PIOB for DS2413/DS2406, P0-P7 for DS2408)
+          mode:                    # Configuration of the pin's behavior
+            output: true           # If set, must be true to output values to the pin
+          inverted: true           # Invert the signal (true = active-low, false = active-high)
+        inverted: false            # Invert the switch
+
+**Multiple Devices (DS2413 and DS2408) on the Same Bus**
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    switch:
+      - platform: dallas_pio
+        name: ds2413 switch
+        dallas_pio_id: ds2413_ic1
+        id: ds2413_switch
+        pin:
+          number: PIOB
+          mode:
+            output: true
+          inverted: true
-        pin:
-          number: PIOB
-          mode:
-            output: true
-          inverted: true
+        pin:
+          number: PIOB
+          mode:
+            output: true
+          inverted: true
+
+**pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The PIO pin to use for the switch.
+  - **mode** (*Optional*): Configure the pin mode.
+    - **output** (*Optional*, bool): Set to true to configure the pin as output (default: false).
-        pin:
-          number: PIOB
-          mode:
-            output: true
-          inverted: true
+        pin:
+          number: PIOB
+          mode:
+            output: true
+          inverted: true
+
+**pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The PIO pin to use for the switch.
+  - **mode** (*Optional*): Configure the pin mode.
+    - **output** (*Optional*, bool): Set to true to configure the pin as output (default: false).
+        inverted: false
+
+      - platform: dallas_pio
+        name: ds2408 switch
+        dallas_pio_id: ds2408_ic2
+        id: ds2408_switch
+        pin:
+          number: P0
+          mode:
+            output: true
+          inverted: true
+        inverted: false
+
+
+Configuration variables:
+************************
+
+- **name** (*Optional*, string): The name for the sensor. At least one of **id** and **name** must be specified.
+- **id** (*Optional*, string): Manually specify the ID for code generation. At least one of **id** and **name** must be specified.
+- **dallas_pio_id** (*Required*, string): The ID of the dallas pio to use.
+- **pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The PIO pin to use for the switch.
+
+Options:
+  - **number**: The pin to use. For DS2413 or DS2406, use `PIOA` or `PIOB`. For DS2408, use `P0` to `P7`.
+  - **mode**: 
+      - `output: true`: Configure the pin as an output (default)
+      - `output: false`: not allowed (switch acts necessarily as an output).
+  - **inverted**: Set to `true` to interpret a high signal as low (active-low). Useful for devices where a low voltage signifies an active state. Defaults to `false`.
+
+- **inverted** (*Optional*, bool): Switch inverted if true (default: false).
+- All other options from :ref:`Switch <config-switch>`.
+
+See Also
+--------
+
+- :apiref:`dallas_pio/switch.h`
+- :ghedit:`Edit`
diff --git a/images/dallas_pio.jpg b/images/dallas_pio.jpg
diff --git a/images/dallas_pio_ds2406.jpg b/images/dallas_pio_ds2406.jpg
diff --git a/images/dallas_pio_ds2408.jpg b/images/dallas_pio_ds2408.jpg
diff --git a/images/dallas_pio_ds2413.jpg b/images/dallas_pio_ds2413.jpg
diff --git a/index.rst b/index.rst
@@ -290,6 +290,9 @@ I/O Expanders/Multiplexers
     TCA9555, components/tca9555, tca9555.svg
     WeiKai SPI/I²C UART/IO Expander, components/weikai, wk2168.jpg
     XL9535, components/xl9535, xl9535.svg
+    DS2413, components/dallas_pio, dallas_pio_ds2413.jpg
+    DS2406, components/dallas_pio, dallas_pio_ds2406.jpg
+    DS2408, components/dallas_pio, dallas_pio_ds2408.jpg
 
 CAN Bus
 -------