forked from esphome/esphome-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add SMT100 Soil Moisture Sensor documentation (esphome#2197)
Co-authored-by: Jesse Hills <[email protected]> Co-authored-by: Dennis Piecha <[email protected]>
- Loading branch information
1 parent
ce3a172
commit c4c056d
Showing
4 changed files
with
83 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
SMT100 Soil Moisture Sensor | ||
================================ | ||
|
||
.. seo:: | ||
:description: Instructions for setting up SMT100 soil moisture and temperature sensor | ||
:image: smt100.jpg | ||
:keywords: smt100 | ||
|
||
|
||
The SMT100 sensor platform allows you to use the SMT100 soil moisture and temperature with ESPHome. | ||
|
||
.. figure:: images/smt100.jpg | ||
:align: center | ||
:width: 50.0% | ||
|
||
|
||
The communication with this integration is done over a UART bus using a simple ASCII protocol. You must therefore have a ``uart:`` entry in your configuration with both the TX and RX pins set to some pins on your board and the baud rate set to 9600. | ||
|
||
|
||
.. code-block:: yaml | ||
# Example configuration entry | ||
uart: | ||
tx_pin: TX | ||
rx_pin: RX | ||
baud_rate: 9600 | ||
sensor: | ||
- platform: smt100 | ||
counts: | ||
name: "Counts" | ||
permittivity: | ||
name: "Permittivity" | ||
temperature: | ||
name: "Temperature" | ||
moisture: | ||
name: "Moisture" | ||
voltage: | ||
name: "Voltage" | ||
Configuration variables: | ||
------------------------ | ||
|
||
- **counts** (*Optional*): Raw measurement data from the sensor electronics (dimensionless quantity). Higher counts mean less moisture. May be used for material specific calibrations. | ||
|
||
- **name** (**Required**): Sensor name. | ||
- All other options from :ref:`Sensor <config-sensor>`. | ||
|
||
- **Permittivity** (*Optional*): Permittivity or dielectric coefficient of the material to be measured (dimensionless quantity. Higher permittivity means higher water content. May be used for material specific calibration. | ||
|
||
- **name** (**Required**): Sensor name. | ||
- All other options from :ref:`Sensor <config-sensor>`. | ||
|
||
- **temperature** (*Optional*): Soil temperature in degrees Celsius. Please note that the temperature sensor is inside the black sensor enclosure and requires some time to equilibrate with the soil temperature. | ||
|
||
- **name** (**Required**): Sensor name. | ||
- All other options from :ref:`Sensor <config-sensor>`. | ||
|
||
- **moisture** (*Optional*): Soil moisture (volumetric water content in %). | ||
|
||
- **name** (**Required**): Sensor name. | ||
- All other options from :ref:`Sensor <config-sensor>`. | ||
|
||
- **voltage** (*Optional*): Supply voltage of the sensor in Volt. | ||
|
||
- **name** (**Required**): Sensor name. | ||
- All other options from :ref:`Sensor <config-sensor>`. | ||
|
||
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component <uart>` if you want | ||
to use multiple UART buses. | ||
|
||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to pull the sensor. Defaults is 60s. | ||
|
||
See Also | ||
-------- | ||
|
||
- :doc:`/components/sensor/smt100` | ||
- :ref:`sensor-filters` | ||
- :apiref:`smt100/smt100.h` | ||
- :ghedit:`Edit` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters