Emontx component documentation #5004

FredM67 · 2025-06-17T20:06:15Z

Description:

Documentation for the new component Emontx

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

emonTx component esphome#9027

Checklist:

I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
or
I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.
Link added in /components/index.rst when creating new documents for new components or cookbook.

netlify · 2025-06-17T20:08:30Z

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	`0392f1c`
🔍 Latest deploy log	https://app.netlify.com/projects/esphome/deploys/685e4723c8bc6d0008af475e
😎 Deploy Preview	https://deploy-preview-5004--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

…tation

…etails

…Tx documentation

…instructions

…section

…entation

borpin · 2025-06-19T15:23:16Z

components/sensor/emontx.rst

+Component/Hub
+-------------
+
+The ``emontx`` component allows you to use an EmonTx device with ESPHome.


allows you to use ESPHome to create a connection to an OpenEnergyMonitor emonTX via a supported device (ESP32 recommended).

borpin · 2025-06-19T15:23:23Z

components/sensor/emontx.rst

+
+The ``emontx`` component allows you to use an EmonTx device with ESPHome.
+This component is a global hub that establishes the connection to the EmonTx via :ref:`UART <uart>` and translates the received data.
+Using the :ref:`emontx sensors <emontx-sensors>`, you can then create sensors for Home Assistant that track voltage, current, power, and temperature readings from the EmonTx.


you can then create sensors for Home Assistant that track voltage, current, power as measured by CTs (up to 12), pulse data, and temperature depending on the configuration of the emonTX.

borpin · 2025-06-19T15:25:21Z

components/sensor/emontx.rst

+The ``emontx`` component allows you to use an EmonTx device with ESPHome.
+This component is a global hub that establishes the connection to the EmonTx via :ref:`UART <uart>` and translates the received data.
+Using the :ref:`emontx sensors <emontx-sensors>`, you can then create sensors for Home Assistant that track voltage, current, power, and temperature readings from the EmonTx.
+


The component can send data to an MQTT Broker either as JSON or as individual topics to be consumed by any system.

borpin · 2025-06-19T15:25:24Z

components/sensor/emontx.rst

+This component is a global hub that establishes the connection to the EmonTx via :ref:`UART <uart>` and translates the received data.
+Using the :ref:`emontx sensors <emontx-sensors>`, you can then create sensors for Home Assistant that track voltage, current, power, and temperature readings from the EmonTx.
+
+This component can also be used to send data to an `emoncms <https://emoncms.org/>`_ system via HTTP or MQTT. Working directly with emoncms seamlessly is a key benefit of this component, allowing you to integrate your energy monitoring data with powerful visualization and analysis tools.


This component can also be used to send data to a remote emoncms instance such as emoncms.org by HTTP or a locally hosted system via HTTP or MQTT.

components/sensor/emontx.rst

borpin · 2025-06-19T15:26:28Z

components/sensor/emontx.rst

+
+    OpenEnergyMonitor EmonTx5.
+
+As the communication with the EmonTx is done using UART, you need to have an :ref:`UART bus <uart>` in your configuration with the ``rx_pin`` connected to the data pin of the EmonTx and with the baud rate set to 115200.


Possibly a key point that this component can only receive data not send it.

It cannot send data yet, but I could implement it.... We've just to define what to send, and specially how.
No idea if it's possible to implement a UI similar to what exists through https://openenergymonitor.org/serial/.

borpin · 2025-06-19T15:27:04Z

components/sensor/emontx.rst

+
+  - **emoncms_server** (**Required**): The URL of the emoncms server.
+  - **api_key** (**Required**, string): The API write key for the emoncms server.
+  - **node** (**Required**, string): The node ID to use for the emoncms server.


add - (number or text).

There's already a note in the Emoncms Integration section.

borpin · 2025-06-19T15:27:45Z

components/sensor/emontx.rst

+- **emoncms** (*Optional*): For forwarding data to an `emoncms` server.
+
+  - **emoncms_server** (**Required**): The URL of the emoncms server.
+  - **api_key** (**Required**, string): The API write key for the emoncms server.


generally referred to as the Read/Write key, not just the write key.

borpin · 2025-06-19T15:28:35Z

components/sensor/emontx.rst

+
+- **mqtt** (*Optional*): For forwarding data to an MQTT broker, including emoncms via MQTT.
+
+  - **topic_prefix** (**Required**, string): The MQTT topic prefix to use for publishing data.


in MQTT terms this is the base topic.

Here, I wanted to make things even flexibler. A base topic, then "device" topic.
Add also a boolean like "categorize" to sort powers under power, voltages under voltage, ...
Good or bad idea ?
We've to find beyond emoncms, perhaps Jeedom users want it like this.

Yes, I meant that technically, rather than the 'topic prefix' in MQTT terms, the description is the 'base' topic.

borpin

Docs look great to me

FredM67 added 10 commits June 12, 2025 21:51

First check-in for emontx doc

1b7d959

Add some doc for emontx

dd8b5be

Sensors definition

f5cba4d

Add reference link for emontx sensors section

de28161

Add EmonTx sensor entry to Electricity section

703fd42

Update EmonTx image reference in Electricity section

f850034

Fix EmonTx sensor reference and update data format description

f9eaf08

Add EmonTx5 image to the repository

179d356

Update temperature sensor description in EmonTx documentation

621ba8c

Resize image

ae22d04

probot-esphome bot added has-parent next labels Jun 17, 2025

FredM67 mentioned this pull request Jun 17, 2025

emonTx component esphome/esphome#9027

Draft

14 tasks

FredM67 and others added 16 commits June 17, 2025 22:12

Fix formatting and alignment issues in EmonTx documentation

51eff89

Add alt text for EmonTx5 image and improve caption clarity in documen…

65dead5

…tation

Fix alignment of EmonTx5 image in documentation

3792919

Merge branch 'next' into emontx

6c34a8d

Fix sensor reference and enhance EmonTx documentation with indexing d…

4382115

…etails

Fix formatting and improve clarity of sensor indexing section in Emon…

a70295f

…Tx documentation

Improve EmonTx documentation clarity and enhance emoncms integration …

98cf291

…instructions

Fix link reference for http_request component in Emoncms integration …

812b456

…section

Add MQTT forwarding documentation

4a4a7c3

Fix MQTT forwarding documentation

2b8dc7d

Fix bullet list

7b0cd77

Fix typo

bb931d3

Get rid of http_id

2d3b87a

Clarify required parameters for emoncms and MQTT integration in docum…

9c49716

…entation

Get rid of mqtt_id

53b52e0

Some fixes in the doc

d90f732

Fix blank on empty line

ade4b76

borpin reviewed Jun 19, 2025

View reviewed changes

components/sensor/emontx.rst Outdated Show resolved Hide resolved

borpin reviewed Jun 19, 2025

View reviewed changes

Implement borpin's reviews

840fd23

borpin approved these changes Jun 22, 2025

View reviewed changes

FredM67 and others added 8 commits June 24, 2025 16:04

Update component config

b8a33eb

Fix formatting for default value in MQTT base prefix documentation

4fcfff2

Update accuracy settings for sensor configurations

fc8d8a1

Add MQTT publish mode options for emontx component

f928e91

Add MQTT publish mode option for emontx component

61a4cd8

Update emontx.rst

b0dfc00

Fix emoncms configuration key in emontx documentation

7a2a820

Fix emoncms API key parameter name in documentation

0392f1c


		OpenEnergyMonitor EmonTx5.

		As the communication with the EmonTx is done using UART, you need to have an :ref:`UART bus <uart>` in your configuration with the ``rx_pin`` connected to the data pin of the EmonTx and with the baud rate set to 115200.


		- mqtt (Optional): For forwarding data to an MQTT broker, including emoncms via MQTT.

		- topic_prefix (Required, string): The MQTT topic prefix to use for publishing data.

Uh oh!

Emontx component documentation #5004

Are you sure you want to change the base?

Emontx component documentation #5004

Uh oh!

Conversation

FredM67 commented Jun 17, 2025

Description:

Checklist:

Uh oh!

netlify bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for esphome ready!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

borpin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

netlify bot commented Jun 17, 2025 •

edited

Loading