esphome-docs/components/sensor/kuntze.rst
Samuel Sieb f7420c857f
fix kuntze docs (#2698)
Co-authored-by: Samuel Sieb <samuel@sieb.net>
2023-03-09 15:48:13 +13:00

89 lines
2.5 KiB
ReStructuredText

Kuntze pool monitor
===================
.. seo::
:description: Instructions for setting up Kuntze pool monitor in ESPHome.
:image: kuntze.jpg
The ``kuntze`` component allows you to integrate the Kuntze water measurement
instrument in ESPHome. It uses :ref:`UART <uart>` (ModBUS) for communication.
Once configured you can use sensors as described below for your projects.
.. figure:: ../../images/kuntze.jpg
:align: center
Kuntze Neon® Multi instrument
Overview
--------
Kuntze devices have an RS485 (ModBUS RTU) communication port. Please see the
Kuntze papers for the pinout of the RS485 connector on your unit. ModBUS line
has to be terminated properly (with a ``120Ω`` resistor), and since this is likely
your only unit connected to ESPHome, you should activate bus termination in the
Network menu (this component doesn't support multiple Kuntze devices on the same
bus). ModBUS address should remain at factory default value.
The device communicates at ``19200`` baud ``8E1``. To connect to ESPHome, an RS485
transceiver is needed. Choose a type which does not need a trigger to send and
receive data, for example:
.. figure:: ../../images/rs485.jpg
The controller connects to the UART of the MCU. For ESP32 GPIO `16` to `TXD` and `17`
to RXD are the default ones but any other pins can be used as well. 3.3V to VCC and GND to GND.
.. warning::
If you are using the :ref:`logger` make sure you are not using the same pins for it or otherwise disable the UART
logging with the ``baud_rate: 0`` option.
Component
---------
A configured modbus component is optional. It will be automatically created.
.. code-block:: yaml
# Example configuration entry
uart:
- id: uart_bus
tx_pin: GPIO16
rx_pin: GPIO17
baud_rate: 19200
parity: EVEN
sensor:
- platform: kuntze
id: my_kuntze
ph:
id: ph
temperature:
id: temperature
Configuration variables:
- **ph**: Measured pH value
- **temperature**: Measured temperature value
- **dis1**: Measured DIS 1 value
- **dis2**: Measured DIS 2 value
- **redox**: Measured Redox value
- **ec**: Measured EC value
- **oci**: Measured OCI value
All sensors are *Optional* and support all other options from :ref:`Sensor <config-sensor>`.
See Also
--------
- :ref:`uart`
- :ref:`logger`
- :ref:`Sensor <config-sensor>`
- `Kuntze manuals <https://www.kuntze.com/en/downloads-2/>`__
- `Communication protocol <https://www.kuntze.com/wp-content/uploads/2021/05/2019_Manual_Modbus-RTU_ENG.pdf>`__
- :ghedit:`Edit`