diff --git a/components/sensor/ain4_20ma.rst b/components/sensor/ain4_20ma.rst new file mode 100644 index 000000000..6e7d78163 --- /dev/null +++ b/components/sensor/ain4_20ma.rst @@ -0,0 +1,46 @@ +AIN4-20mA current analog measurement unit +========================================= + +.. seo:: + :description: Instructions for setting up the AIN4-20mA current analog measurement unit. + :image: ain4_20ma.jpg + :keywords: current, 4-20mA, i2c + +The AIN4-20mA current analog measurement unit sensor allows you to use sensors with a 4-20mA output to use with ESPHome. + +.. figure:: images/ain4_20ma.jpg + :align: center + :width: 50.0% + + AIN4-20mA current analog measurement unit. + (Credit: `M5Stack `__, image cropped and compressed) + +.. _M5Stack: https://docs.m5stack.com/en/unit/AIN4-20mA%20Unit + +The AIN4-20mA Unit is a highly capable single-channel 4~20mA current analog measurement unit. Powered by the STM32G030F6 main control chip, it communicates through i2c, ensuring efficient and reliable data transmission. +It can be used as base sensor for all sensors with a 4-20mA output. + +To use the sensor, first set up an :ref:`I²C Bus ` and connect the sensor to the specified pins. + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: ain4_20ma + name: "Current" + update_interval: 60s + +Configuration variables: +------------------------ + +- **address** (*Optional*, int): Manually specifiy the I²C address of the sensor. Defaults to ``0x55``. +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. +- All other options from :ref:`Sensor `. + +See Also +-------- + +- :ref:`sensor-filters` +- :doc:`template` +- `AIN4-20mA Unit `__ +- :ghedit:`Edit` diff --git a/components/sensor/images/ain4_20ma.jpg b/components/sensor/images/ain4_20ma.jpg new file mode 100644 index 000000000..e4fb5edde Binary files /dev/null and b/components/sensor/images/ain4_20ma.jpg differ diff --git a/images/ain4_20ma.jpg b/images/ain4_20ma.jpg new file mode 100644 index 000000000..e4fb5edde Binary files /dev/null and b/images/ain4_20ma.jpg differ diff --git a/index.rst b/index.rst index 9cc42dae9..0984efc03 100644 --- a/index.rst +++ b/index.rst @@ -287,6 +287,7 @@ Analogue ADC128S102, components/sensor/adc128s102, adc128s102.png , 8-channel ADC ADS1115, components/sensor/ads1115, ads1115.jpg, 4-channel ADC ADS1118, components/sensor/ads1118, ads1118.jpg, 4-channel ADC + AIN4-20mA, components/sensor/ain4_20ma, ain4_20ma.jpg, 4-20mA current measurement CD74HC4067, components/sensor/cd74hc4067, cd74hc4067.jpg, 16-channel analog multiplexer MCP3008, components/sensor/mcp3008, mcp3008.jpg, 8-channel ADC MCP3204 / MCP3208, components/sensor/mcp3204, mcp3204.jpg, 4-channel ADC