mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-11-18 11:15:36 +01:00
3e74757ce9
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
118 lines
3.8 KiB
ReStructuredText
118 lines
3.8 KiB
ReStructuredText
SCD30 CO₂, Temperature and Relative Humidity Sensor
|
|
===================================================
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up SCD30 CO₂ Temperature and Relative Humidity Sensor
|
|
:image: scd30.jpg
|
|
|
|
The ``scd30`` sensor platform allows you to use your Sensirion SCD30 CO₂
|
|
(`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/9.5_CO2/Sensirion_CO2_Sensors_SCD30_Datasheet.pdf>`__) sensors with ESPHome.
|
|
The :ref:`I²C Bus <i2c>` is required to be set up in your configuration for this sensor to work.
|
|
|
|
.. figure:: images/scd30.jpg
|
|
:align: center
|
|
:width: 80.0%
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
sensor:
|
|
- platform: scd30
|
|
co2:
|
|
name: "Workshop CO2"
|
|
accuracy_decimals: 1
|
|
temperature:
|
|
name: "Workshop Temperature"
|
|
accuracy_decimals: 2
|
|
humidity:
|
|
name: "Workshop Humidity"
|
|
accuracy_decimals: 1
|
|
temperature_offset: 1.5 °C
|
|
address: 0x61
|
|
update_interval: 5s
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
- **co2** (*Optional*): The information for the CO₂ sensor.
|
|
|
|
- **name** (**Required**, string): The name for the CO₂eq sensor.
|
|
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
- All other options from :ref:`Sensor <config-sensor>`.
|
|
|
|
- **temperature** (*Optional*): The information for the Temperature sensor.
|
|
|
|
- **name** (**Required**, string): The name for the temperature sensor.
|
|
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
- All other options from :ref:`Sensor <config-sensor>`.
|
|
|
|
- **humidity** (*Optional*): The information for the Humidity sensor.
|
|
|
|
- **name** (**Required**, string): The name for the humidity sensor.
|
|
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
- All other options from :ref:`Sensor <config-sensor>`.
|
|
|
|
- **temperature_offset** (*Optional*, float): Temperature and humidity
|
|
offsets may occur when operating the sensor in end-customer
|
|
devices. This variable allows the compensation of those effects by
|
|
setting a temperature offset.
|
|
|
|
- **automatic_self_calibration** (*Optional*, boolean): Whether to enable
|
|
automatic self calibration (ASC). Defaults to ``true``.
|
|
|
|
- **ambient_pressure_compensation** (*Optional*, int): Enable compensation
|
|
of measured CO₂ values based on given ambient pressure in mBar.
|
|
|
|
- **altitude_compensation** (*Optional*, int): Enable compensating
|
|
deviations due to current altitude (in metres). Notice: setting
|
|
*altitude_compensation* is ignored if *ambient_pressure_compensation*
|
|
is set.
|
|
|
|
- **address** (*Optional*, int): Manually specify the I²C address of the sensor.
|
|
Defaults to ``0x61``.
|
|
|
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
|
sensor. Defaults to ``60s``.
|
|
|
|
|
|
Manual calibration:
|
|
------------------------
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example on how to implement a UI section in HA for manual calibration.
|
|
# Note: Please enter first a CO2 value before pressing the button.
|
|
button:
|
|
- platform: template
|
|
name: "SCD30 Force manual calibration"
|
|
entity_category: "config"
|
|
on_press:
|
|
then:
|
|
- scd30.force_recalibration_with_reference:
|
|
value: !lambda 'return id(co2_cal).state;'
|
|
|
|
number:
|
|
- platform: template
|
|
name: "CO2 calibration value"
|
|
optimistic: true
|
|
min_value: 350
|
|
max_value: 4500
|
|
step: 1
|
|
id: co2_cal
|
|
icon: "mdi:molecule-co2"
|
|
entity_category: "config"
|
|
|
|
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :ref:`sensor-filters`
|
|
- :doc:`absolute_humidity`
|
|
- :doc:`dht`
|
|
- :doc:`dht12`
|
|
- :doc:`hdc1080`
|
|
- :doc:`htu21d`
|
|
- :apiref:`scd30/scd30.h`
|
|
- :ghedit:`Edit`
|