Add Libre Hardware Monitor integration #140449

Sab44 · 2025-03-12T13:11:53Z

Proposed change

The current Open Hardware Monitor legacy integration is for a software that has not been updated in more than 4 years. It's successor is Libre Hardware Monitor.

While the legacy integration technically also works for Libre Hardware Monitor, it has many issues and is not maintained.

This integration has been rewritten from scratch following the best practices from the current developer docs, providing:

config flow
~~configurable scan interval~~
~~add only user selected hardware devices~~
entities grouped by hardware device
~~reconfigure anytime via UI reconfigure flow~~
robust against hardware changes on the host system
much improved code complexity and readability
extensive test coverage
quality scale: silver

In my opinion, we should deprecate the legacy integration and redirect users to this one.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: n/a
This PR is related to issue: n/a
Link to documentation pull request: Add docs for Libre Hardware Monitor integration home-assistant.io#37941
Link to developer documentation pull request: n/a
Link to frontend pull request: n/a

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

tr4nt0r

There are a few things you have to consider for a new integration. First of all, the PR scope has to be kept small. Only implement the user config flow, the reconfigure flow can be added in a follow-up PR.
Also variable/configurable scan interval is not allowed in core integrations.

Sab44 · 2025-03-13T07:29:35Z

Hi @tr4nt0r thanks for the feedback.

Regarding the reconfigure flow: sure I can take this out and submit it in a follow-up PR.

Regarding the configurable scan interval: could you point me to the developer docs where it is outlined that it cannot be configurable? I found the custom polling interval docs before, but it does not really say that a configurable scan interval is disallowed.
I just want to note that I did set limitations to adhere to HA's minimum polling interval of 5 seconds. I feel like for a System Monitor it is vital to allow the user to specify their desired polling interval - ideally in a intuitive way during integration setup. But of course, if this is not desired then I can set a sensible default value and redirect to the custom polling interval docs on the integration docs.

joostlek · 2025-03-13T10:50:47Z

Please note that someone is taking on the work on open hardware monitor and there's a PR for that at the moment.

Is the API of both applications the same?

Sab44 · 2025-03-13T11:54:30Z

Hi @joostlek
wow, what are the odds after years of legacy status... Not sure what to make of this.

Here's my thought process when I started working on implementing this integration from scratch:

Open Hardware Monitor is legacy software, nobody should use it anymore. Instead they should use Libre Hardware Monitor. The integration name should reflect this, guiding new users intuitively to the right integration.
The new integration should reflect the current state of development i.e. fulfill at least all the bronze quality requirements.

After a quick look at the other PR for openhardwaremonitor, in comparison this new integration provides:

re-implementation instead of re-factor, avoiding pitfalls that are present in the old integration (and still are there after the re-factor, e.g. if hardware exposed by LHM changes, it will break the integration as sensors are based on indices that will no longer be present/valid)
allow users to select which devices they want to add to Home Assistant
high unit test coverage
updated documentation & higher quality icon

Regarding the API, Libre Hardware Monitor seems to be backwards compatible, which is why the current openhardwaremonitor integration does technically still work. However, I have not tested whether my implementation will work with Open Hardware Monitor installations, as I don't think this is a valid use case anymore. Presumably it should work though.

joostlek · 2025-03-13T11:58:38Z

I am also not saying which one is better, PRs should be well scoped, so I don't think comparing PRs is fair here, as new integrations are always bigger and contain more feature than an integration that is trying to modernize.

joostlek · 2025-03-13T12:10:13Z

cc @LazyTarget just as an FYI.

We just discussed this in the architecture meeting, and we think its fine to have them co-exist.

Sab44 · 2025-03-13T12:21:10Z

Glad to hear that, thanks for clarifying and sorry for the hassle.

If someone could give me a quick hint why the tests on the CI are complaining about missing data_description translations when to my knowledge those are optional, I'd appreciate it. What am I missing there?

joostlek · 2025-03-13T12:22:55Z

They are not optional for the quality_scale rule :)

LazyTarget · 2025-03-13T19:46:43Z

wow, what are the odds after years of legacy status... Not sure what to make of this.
@Sab44

What ARE the odds?! 😄

Cool to see that we both identify the need for an update, and interesting to see our different takes (even not all to different)
Really great job! I see you also put some hours into it.
I will see if can test yours out tomorrow

LazyTarget · 2025-03-13T19:51:52Z

I am also not saying which one is better, PRs should be well scoped, so I don't think comparing PRs is fair here, as new integrations are always bigger and contain more feature than an integration that is trying to modernize.

We just discussed this in the architecture meeting, and we think its fine to have them co-exist.

@joostlek
Sounds good. Should I revisit my PR a bit and make sure avoid breaking changes as much as possible?
Like continue supporting the YAML configuration?

joostlek · 2025-03-13T19:52:57Z

With the migration to the UI we should import the YAML config and that is an expected breaking change

Sab44 · 2025-03-14T07:05:16Z

@Sab44
What ARE the odds?! 😄

Yep, I guess it really was time to finally update this as LHM is such a nice tool and the legacy integration was increasingly becoming a pain point.
Thank you too for your work and improvements! Let me know if you find any problems during your tests.

Sab44 · 2025-03-16T18:57:46Z

There were a couple of code coverage warnings which are now resolved, so this is now ready for review.
If there is anything left to do from my side, please let me know.

LazyTarget

Like mentioned in the other comment, In my case Libre Open Hardware Monitor is not able to get any sensors from my motherboard, which failed the startup.

Everything else looks and works great, truly good job!

homeassistant/components/librehardwaremonitor/coordinator.py

homeassistant/components/librehardwaremonitor/__init__.py

homeassistant/components/librehardwaremonitor/config_flow.py

homeassistant/components/librehardwaremonitor/coordinator.py

homeassistant/components/librehardwaremonitor/quality_scale.yaml

homeassistant/components/librehardwaremonitor/sensor.py

…re types

* add mock_config_entry fixture * combine error config flow tests * remove unnecessary config flow test

Copilot

Pull Request Overview

This PR introduces a new integration for Libre Hardware Monitor to replace the legacy Open Hardware Monitor integration. The changes include implementing a config flow with proper error handling, rebuilding the coordinator and sensor entities for improved robustness and maintainability, and adding comprehensive tests and dependency updates to support quality scale silver.

Reviewed Changes

Copilot reviewed 19 out of 21 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/components/librehardwaremonitor/test_sensor.py	Tests for sensor creation, update, and handling of missing data.
tests/components/librehardwaremonitor/test_coordinator.py	Tests for coordinator error handling, data refresh, and orphaned device removal.
tests/components/librehardwaremonitor/test_config_flow.py	Tests for proper error messaging and flow recovery in the config flow.
tests/components/librehardwaremonitor/conftest.py	Common fixtures and sample data for the Libre Hardware Monitor tests.
tests/components/librehardwaremonitor/snapshots/*	Snapshot tests ensuring sensor state consistency.
requirements_test_all.txt / requirements_all.txt	Dependency updates to include the librehardwaremonitor-api package.
mypy.ini	Updated mypy configuration for the new integration.
homeassistant/components/librehardwaremonitor/sensor.py	Implementation of sensor entities with formatted numeric values.
homeassistant/components/librehardwaremonitor/coordinator.py	Coordinator that fetches data and handles device changes, including orphan device removal.
homeassistant/components/librehardwaremonitor/config_flow.py	Config flow implementation with error handling for connectivity and missing devices.
homeassistant/components/librehardwaremonitor/manifest.json, quality_scale.yaml, etc.	Integration metadata and quality scale configuration.

Copilot · 2025-06-27T07:07:37Z

homeassistant/components/librehardwaremonitor/coordinator.py

+            DeviceId(next(iter(device.identifiers))[1]): DeviceName(device.name)
+            for device in device_entries
+            if device.identifiers and device.name


Consider using a more robust approach to extract the identifier by filtering the identifiers for the one associated with the integration rather than using next(iter(...)) directly, which may be error-prone if multiple identifiers are present.

Suggested change

DeviceId(next(iter(device.identifiers))[1]): DeviceName(device.name)

for device in device_entries

if device.identifiers and device.name

DeviceId(

identifier[1]

): DeviceName(device.name)

for device in device_entries

if device.identifiers and device.name

for identifier in device.identifiers

if identifier[0] == DOMAIN

home-assistant bot added cla-signed has-tests new-integration integration: librehardwaremonitor quality-scale labels Mar 12, 2025

This was referenced Mar 12, 2025

Add icon for Libre Hardware Monitor integration home-assistant/brands#6731

Open

Add docs for Libre Hardware Monitor integration home-assistant/home-assistant.io#37941

Open

Sab44 force-pushed the add_librehardwaremonitor_integration branch from 3cf04fc to 457ff11 Compare March 12, 2025 15:52

tr4nt0r suggested changes Mar 12, 2025

View reviewed changes

Sab44 force-pushed the add_librehardwaremonitor_integration branch from 457ff11 to c1f6f18 Compare March 13, 2025 10:41

Sab44 force-pushed the add_librehardwaremonitor_integration branch from c1f6f18 to c5f5867 Compare March 13, 2025 13:02

Sab44 force-pushed the add_librehardwaremonitor_integration branch 2 times, most recently from 5c0c784 to 259f931 Compare March 16, 2025 18:16

Sab44 force-pushed the add_librehardwaremonitor_integration branch from 259f931 to babf625 Compare March 25, 2025 10:04

LazyTarget suggested changes Apr 8, 2025

View reviewed changes

homeassistant/components/librehardwaremonitor/coordinator.py Outdated Show resolved Hide resolved

joostlek requested changes Apr 8, 2025

View reviewed changes

home-assistant bot marked this pull request as draft April 8, 2025 16:32

Sab44 added 23 commits June 27, 2025 08:08

move sensor parsing logic to librehardwaremonitor api package; add mo…

b7d008d

…re types

remove configurable scan interval

0a42d11

update quality scale with complete checklist

e728c6a

remove custom backoff time when host unreachable

b4ec88d

remove manual device selection and reconfiguration flow

d7da0bb

use device registry as source of truth for active devices

12a7b29

fulfill strict typing quality scale requirement

6e0d37e

bump librehardwaremonitor-api dependency

d8f3009

remove debug lines from config flow

39586d7

small refactor; resolve minor comments

b15760b

log connection error

6cc458a

extract config schema into constant

0e326fd

remove dummy manufacterer name

8f2b9fc

replace unique id with async_abort_entries_match

425b3ef

remove redundant list designation for sensor entities

0e490a3

rework unit tests

06a8919

* add mock_config_entry fixture * combine error config flow tests * remove unnecessary config flow test

patch async_setup_entry to avoid leaking setups

a27941b

add snapshot test to assert created entities state

cf37a53

provide unique device id for hardware device

f1b8438

various smaller PR review improvements

6573c26

check changes in devices based on device ids

f2f44e7

do not automatically add new devices

b701870

remove config entry None check

8bb9cc5

Sab44 force-pushed the add_librehardwaremonitor_integration branch from bb84471 to 8bb9cc5 Compare June 27, 2025 06:08

Sab44 marked this pull request as ready for review June 27, 2025 06:34

home-assistant bot requested a review from joostlek June 27, 2025 06:34

frenck requested review from Copilot and removed request for LazyTarget and tr4nt0r June 27, 2025 07:07

Copilot AI reviewed Jun 27, 2025

View reviewed changes

Uh oh!

Add Libre Hardware Monitor integration #140449

Are you sure you want to change the base?

Add Libre Hardware Monitor integration #140449

Uh oh!

Conversation

Sab44 commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

tr4nt0r left a comment

Choose a reason for hiding this comment

Uh oh!

Sab44 commented Mar 13, 2025

Uh oh!

joostlek commented Mar 13, 2025

Uh oh!

Sab44 commented Mar 13, 2025

Uh oh!

joostlek commented Mar 13, 2025

Uh oh!

joostlek commented Mar 13, 2025

Uh oh!

Sab44 commented Mar 13, 2025

Uh oh!

joostlek commented Mar 13, 2025

Uh oh!

LazyTarget commented Mar 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LazyTarget commented Mar 13, 2025

Uh oh!

joostlek commented Mar 13, 2025

Uh oh!

Sab44 commented Mar 14, 2025

Uh oh!

Sab44 commented Mar 16, 2025

Uh oh!

LazyTarget left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Sab44 commented Mar 12, 2025 •

edited

Loading

LazyTarget commented Mar 13, 2025 •

edited

Loading