From e306940c09ee6fe79a7df1930fd21ca1fe3073c8 Mon Sep 17 00:00:00 2001 From: Jadson Santos <42282908+gtjadsonsantos@users.noreply.github.com> Date: Tue, 18 Oct 2022 21:44:58 -0300 Subject: [PATCH] Add ethernet_info docs (#2300) --- components/text_sensor/ethernet_info.rst | 30 ++++++++++++++++++++++++ index.rst | 1 + 2 files changed, 31 insertions(+) create mode 100644 components/text_sensor/ethernet_info.rst diff --git a/components/text_sensor/ethernet_info.rst b/components/text_sensor/ethernet_info.rst new file mode 100644 index 000000000..fde771542 --- /dev/null +++ b/components/text_sensor/ethernet_info.rst @@ -0,0 +1,30 @@ +Ethernet Info Text Sensor +========================= + +.. seo:: + :description: Instructions for setting up Ethernet info text sensors. + :image: ethernet.svg + +The ``ethernet_info`` text sensor platform exposes different Ethernet information +via text sensors. + +.. code-block:: yaml + + # Example configuration entry + text_sensor: + - platform: ethernet_info + ip_address: + name: ESP IP Address + + +Configuration variables: +------------------------ + +- **ip_address** (*Optional*): Expose the IP Address of the ESP as a text sensor. All options from + :ref:`Text Sensor `. + +See Also +-------- + +- :apiref:`ethernet_info/ethernet_info_text_sensor.h` +- :ghedit:`Edit` diff --git a/index.rst b/index.rst index 796c21299..955839905 100644 --- a/index.rst +++ b/index.rst @@ -594,6 +594,7 @@ Text Sensor Components MQTT Subscribe Text, components/text_sensor/mqtt_subscribe, mqtt.png Version, components/text_sensor/version, new-box.svg WiFi Info, components/text_sensor/wifi_info, network-wifi.svg + Ethernet Info, components/text_sensor/ethernet_info, ethernet.svg BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg Modbus Text Sensor, components/text_sensor/modbus_controller, modbus.png Template Text Sensor, components/text_sensor/template, description.svg