Skip to content

Add documentation for the M3200 component #4802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added components/sensor/images/m3200-dimensions.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added components/sensor/images/m3200-ha-view.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added components/sensor/images/m3200-installed.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
93 changes: 93 additions & 0 deletions components/sensor/m3200.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
M3200 Battery Monitor
===============================================

.. seo::
:description: Instructions for setting up M3200 pressure sensor.
:image: m3200.jpg
:keywords: M3200

The ``M3200`` sensor platform allows you to use a M3200
(`Vendor site <https://www.te.com/en/product-CAT-PTT0068.html>`__)
pressure sensor with ESPHome. This sensor is available in various pressure ranges and contains a temperature sensor.

.. image:: images/m3200-installed.jpg
:width: 30.0%

.. note::

This software may work with other TE digital pressure sensors. It appears that a lot of their sensor share the same digital protocol, but I have not tested this.

Prerequisites:
-----------------------------------------

This component relies on the :ref:`I²C <i2c>` componenent to be setup. See the reference for
that component for details. A basic example of what that looks like is below.

.. code-block:: yaml

i2c:
sda: SDA
scl: SCL
scan: true

Configuration Example:
-----------------------------------------
An example configuration YAML is shown below.

.. code-block:: yaml

sensor:
- platform: m3200
full_scale_pressure: 100
pressure_type: GAGE
temperature:
name: "M3200 Temperature"
pressure:
name: "M3200 Pressure"

Configuration variables:
-----------------------------------------

- **full_scale_pressure** (*required*): The full scale pressure of the sensor in psi

- Valid values are integers between 10 and 6000.

- **pressure_type** (*required*): Is this a gage or a compound pressure sensor?

- Valid values are ``GAGE``, ``GAUGE``, and ``COMPOUND``
- This defines the minimum pressure of your sensor.
- Gage pressure sensors read 0 at atmospheric pressure
- Compound sensors read down to 0 psia (vacuum)

- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``.

Home Assistant View:
-----------------------------------------

When properly set up, the sensor will report values to Home Assistant as shown:

.. image:: images/m3200-ha-view.jpg
:align: center
:width: 40.0%

.. _sensor_setup:

Sensor wiring and install
-----------------------------------------

The details of how to wire up and install the sensor is beyond the scope of this document. However, I have put a few notes below to get you started.

The sensor comes with an integral cable. The wires can be identified by color:

.. image:: images/m3200-dimensions.jpg
:align: center
:width: 40.0%

Wire:
- Red: V+ (2.7 - 5 V)
- Black: Ground
- White: SCL
- Green: SDA

If you are looking for a connector to use with this sensor, I have had good luck with the `Hirose LF <https://www.digikey.com/en/products/detail/hirose-electric-co-ltd/LF07WBP-6P-31/9171027>`__ connectors for being sturdy but not obnoxiusly expensive.
Binary file added images/m3200.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.