Skip to content

Commit

Permalink
Update udp.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
nagyrobi authored Jun 7, 2024
1 parent f6cd9a5 commit 40d30fe
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions components/binary_sensor/udp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,28 @@ The ``udp`` binary sensor platform allows you to receive binary sensor data from
id: switch_status
remote_id: light_switch
Configuration variables
-----------------------

- **name** (*Optional*, string): The name of the binary sensor.
- **internal** (*Optional*, boolean): Whether the sensor should be exposed via API (e.g. to Home Assistant.) Defaults to true if name is not set, required if name is provided.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **remote_id** (*Optional*, :ref:`config-id`): The ID of the binary sensor in the remote device. If not specified defaults to the ID configured with ``id:``.
- **remote_id** (*Optional*, :ref:`config-id`): The ID of the original binary sensor in the provider device. If not specified defaults to the ID configured with ``id:``.
- **name** (*Optional*, string): The name of the binary sensor.
- **internal** (*Optional*, boolean): Whether the sensor should be exposed via API (e.g. to Home Assistant.) Defaults to ``true`` if name is not set, required if name is provided.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.

At least one of ``id`` and ``remote_id`` must be configured.


Publishing to Home Assistant
----------------------------

Typically this type of binary sensor would be used for internal automation purposes rather than having it published to
HA, since it will be a duplicate of the remote sensor.
Typically this type of binary sensor would be used for internal automation purposes rather than having it published back to
Home Assistant, since it will be a duplicate of the original sensor.

If it *is* desired to expose the sensor to HA, then the ``internal:`` configuration setting needs to be explicitly
If it *is* desired to expose the binary sensor to Home Assistant, then the ``internal:`` configuration setting needs to be explicitly
set to ``false`` and a name provided.
Only the state (i.e. binary value) of the remote sensor is received by the consumer, so any other attributes must be explicitly
configured.


See Also
--------

Expand Down

0 comments on commit 40d30fe

Please sign in to comment.