Hi there,
i am currently migrating from openhab to homeassistant and i have a problem with my Shelly Uni Plus which counts the impluses from my watermeter (1imp/l).
The created entity in HA is created without a unit and the frontend does not let me change it.
It is just a float but there is no unit “m³” or “l”.
How to change the entitiy type so that there is a water unit?
br
Dominik
Bieniu
(Maciek)
August 23, 2024, 2:39pm
2
If you are using xcounts or xfreq values, this will be improved in HA 2024.9
home-assistant:dev
← bieniu:shelly-x-sensor-unit
opened 10:52AM - 20 Aug 24 UTC
<!--
You are amazing! Thanks for contributing to our project!
Please, DO N… OT DELETE ANY TEXT from this template! (unless instructed).
-->
## Breaking change
<!--
If your PR contains a breaking change for existing users, it is important
to tell them what breaks, how to make it work again and why we did this.
This piece of text is published with the release notes, so it helps if you
write it towards our users, not us.
Note: Remove this section if this PR is NOT a breaking change.
-->
## Proposed change
<!--
Describe the big picture of your changes here to communicate to the
maintainers why we should accept this pull request. If it fixes a bug
or resolves a feature request, be sure to link to that issue in the
additional information section.
-->
While implementing Shelly virtual components I realized that we can get units for `xpercent`, `xfreq` and `xcounts` sensors for Shelly Plus Uni from the device configuration. These are sensors for which the user creates an expression to calculate the value and sets unit.
Sample configuration:
```json
{
"input:2": {
"id": 2,
"name": null,
"type": "count",
"enable": false,
"count_rep_thr": 100,
"freq_window": 1,
"freq_rep_thr": 10,
"xcounts": {
"expr": null,
"unit": null
},
"xfreq": {
"expr": null,
"unit": null
}
},
"input:100": {
"id": 100,
"name": "Volts",
"type": "analog",
"enable": true,
"invert": false,
"report_thr": 1,
"range_map": [
0.3,
100
],
"xpercent": {
"expr": "x*0.2995",
"unit": "V"
},
"range": 1
}
}
```
Documentation reference: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Input#configuration
_I don't have a Shelly Plus Uni so I can't test this change with a real device._
## Type of change
<!--
What type of change does your PR introduce to Home Assistant?
NOTE: Please, check only 1! box!
If your PR requires multiple boxes to be checked, you'll most likely need to
split it into multiple PRs. This makes things easier and faster to code review.
-->
- [ ] Dependency upgrade
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New integration (thank you!)
- [x] 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
<!--
Details are important, and help maintainers processing your PR.
Please be sure to fill out additional details, if applicable.
-->
- This PR fixes or closes issue: fixes #
- This PR is related to issue:
- Link to documentation pull request:
## Checklist
<!--
Put an `x` in the boxes that apply. You can also fill these out after
creating the PR. If you're unsure about any of them, don't hesitate to ask.
We're here to help! This is simply a reminder of what we are going to look
for before merging your code.
-->
- [ ] The code change is tested and works locally.
- [x] Local tests pass. **Your PR cannot be merged unless tests pass**
- [x] There is no commented out code in this PR.
- [x] I have followed the [development checklist][dev-checklist]
- [x] I have followed the [perfect PR recommendations][perfect-pr]
- [x] The code has been formatted using Ruff (`ruff format homeassistant tests`)
- [x] 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][docs-repository]
If the code communicates with devices, web services, or third-party tools:
- [ ] The [manifest file][manifest-docs] 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.
<!--
This project is very active and we have a high turnover of pull requests.
Unfortunately, the number of incoming pull requests is higher than what our
reviewers can review and merge so there is a long backlog of pull requests
waiting for review. You can help here!
By reviewing another pull request, you will help raise the code quality of
that pull request and the final review will be faster. This way the general
pace of pull request reviews will go up and your wait time will go down.
When picking a pull request to review, try to choose one that hasn't yet
been reviewed.
Thanks for helping out!
-->
To help with the load of incoming pull requests:
- [ ] I have reviewed two other [open pull requests][prs] in this repository.
[prs]: https://github.com/home-assistant/core/pulls?q=is%3Aopen+is%3Apr+-author%3A%40me+-draft%3Atrue+-label%3Awaiting-for-upstream+sort%3Acreated-desc+review%3Anone+-status%3Afailure
<!--
Thank you for contributing <3
Below, some useful links you could explore:
-->
[dev-checklist]: https://developers.home-assistant.io/docs/development_checklist/
[manifest-docs]: https://developers.home-assistant.io/docs/creating_integration_manifest/
[quality-scale]: https://developers.home-assistant.io/docs/integration_quality_scale_index/
[docs-repository]: https://github.com/home-assistant/home-assistant.io
[perfect-pr]: https://developers.home-assistant.io/docs/review-process/#creating-the-perfect-pr
Thanks for the info! I think this answers my question.
I’m using the standard Shelly integration, but I patched it with some code from the DEV branch, as the feature isn’t integrated yet, as far as I can see:
The setup works great with a Shelly Plus Uni, which has the advantage of using the ‘COUNT IN’ signal on Pin 8 to read impulses from an inductive sensor.
For my Sensus 620 water meter, I used a 3D-printed adapter (see here ) to install it.
[20241015_220938-COLLAGE]
(Not the cleanest, but a quick setup. I also added a temperature sensor!)
EDIT:
By the way, I just remembered that I had to patch the Shelly integration, since the COUNT IN feature is only supported in the dev version of the inte…