Documentation for KMeterISO component (#3095)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Rudd-O 2023-08-08 00:32:38 +00:00 committed by GitHub
parent 31b1cfd14d
commit efd37b4e47
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 49 additions and 0 deletions

View File

@ -0,0 +1,48 @@
M5Stack KMeterISO I2C K-Type probe temperature sensor
=====================================================
.. seo::
:description: Instructions for setting up KMeterISO temperature sensors
:image: kmeteriso.jpg
:keywords: BME280
The ``kmeteriso`` sensor platform allows you to use your KMeterISO
(`product <https://docs.m5stack.com/en/unit/KMeterISO%20Unit>`__,
`M5Stack`_) K-Type thermocouple temperature sensor with ESPHome.
The :ref:`I²C <i2c>` is required to be set up in your configuration
for this sensor to work.
.. figure:: ../../images/kmeteriso.jpg
:align: center
:width: 50.0%
M5Stack KMeterISO temperature sensor.
.. _M5Stack: https://docs.m5stack.com/en/unit/KMeterISO%20Unit
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: kmeteriso
temperature:
name: Temperature
internal_temperature:
name: Internal temperature
Configuration variables:
------------------------
- **temperature** (*Optional*): The information for the temperature sensor. All options from :ref:`Sensor <config-sensor>`.
- **internal_temperature** (*Optional*): The information for the temperature sensor inside the probe. All options from :ref:`Sensor <config-sensor>`.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``5s``.
See Also
--------
- :ref:`sensor-filters`
- :doc:`absolute_humidity`
- :apiref:`kmeteriso/kmeteriso.h`
- `M5Stack Unit code <https://github.com/m5stack/M5Unit-KMeterISO>`__ by `M5Stack <https://m5stack.com/>`__
- :ghedit:`Edit`

BIN
images/kmeteriso.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

View File

@ -395,6 +395,7 @@ Thermocouple
************
.. imgtable::
KMeterISO, components/sensor/kmeteriso, kmeteriso.jpg, K-Type,
MAX31855, components/sensor/max31855, max31855.jpg, K-Type
MAX31856, components/sensor/max31856, max31856.jpg, All types
MAX31865, components/sensor/max31865, max31865.jpg, Platinum RTD