diff --git a/components/sensor/honeywellabp.rst b/components/sensor/honeywellabp.rst new file mode 100644 index 000000000..e72e26e9d --- /dev/null +++ b/components/sensor/honeywellabp.rst @@ -0,0 +1,69 @@ +Honeywell ABP Pressure Sensors +============================== + +.. seo:: + :description: Instructions for setting up Honeywell ABP Pressure sensors + :image: honeywellabp.jpg + :keywords: Honeywell ABP + +The ``honeywellabp`` sensor platform allows you to use your Honeywell ABP +(`website `__, +`datasheet `__, +`Mouser `_) pressure and temperature sensors with ESPHome. The :ref:`SPI ` is +required to be set up in your configuration for this sensor to work + +.. figure:: images/honeywellabp.jpg + :align: center + :width: 50.0% + + Honeywell ABP Pressure and Temperature Sensor. + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: honeywellabp + pressure: + name: "Honeywell pressure" + unit_of_measurement: "psi" + min_pressure: 0 + max_pressure: 15 + temperature: + name: "Honeywell temperature" + cs_pin: GPIO5 #D5 + +Configuration variables: +------------------------ + +The values for ``min_pressure`` and ``max_pressure`` can be found in the device datasheet for the specific device. These are used to calculate +the pressure reading published by the sensor. Some sensors measure pressure in ``bar`` or ``kPa``; set ``min_pressure`` and ``max_pressure`` to +the measurement range and ``unit_of_measurement`` to the appropriate unit for your device. + +- **pressure** (*Optional*): The information for the pressure sensor. + + - **name** (**Required**, string): The name for the pressure sensor. + - **min_pressure** (**Required**, int or float): Minumim pressure for the pressure sensor, default unit ``psi``. + - **max_pressure** (**Required**, int or float): Maximum pressure for the pressure sensor, default unit ``psi``. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +Some sensors do not have temperature sensing ability, see datasheet. In some cases the sensor may return a valid temperature even though the +datasheet indicates that the sensor does not measure temperature. + +- **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 `. + + +- **cs_pin** (**Required**, :ref:`SPI `): Chip select pin. +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the + sensor. Defaults to ``60s``. + +See Also +-------- + +- :ref:`sensor-filters` +- :apiref:`honeywellabp/honeywellabp.h` +- :ghedit:`Edit` diff --git a/components/sensor/images/honeywellabp.jpg b/components/sensor/images/honeywellabp.jpg new file mode 100644 index 000000000..011731975 Binary files /dev/null and b/components/sensor/images/honeywellabp.jpg differ diff --git a/images/honeywellabp.jpg b/images/honeywellabp.jpg new file mode 100644 index 000000000..011731975 Binary files /dev/null and b/images/honeywellabp.jpg differ diff --git a/index.rst b/index.rst index a708cf292..f61c1a4e0 100644 --- a/index.rst +++ b/index.rst @@ -292,6 +292,7 @@ Environmental DHT, components/sensor/dht, dht.jpg, Temperature & Humidity DHT12, components/sensor/dht12, dht12.jpg, Temperature & Humidity HDC1080, components/sensor/hdc1080, hdc1080.jpg, Temperature & Humidity + Honeywell ABP, components/sensor/honeywellabp, honeywellabp.jpg, Pressure & Temperature HTU21D, components/sensor/htu21d, htu21d.jpg, Temperature & Humidity Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity MCP9808, components/sensor/mcp9808, mcp9808.jpg, Temperature