Add mode attribute to number entity by Shulyaka · Pull Request #43867 · home-assistant/core

Shulyaka · 2020-12-02T20:38:20Z

Proposed change

Since the basic support for the number entity is merged (#42735), it's time to add additional features to it.
The most important is the mode attribute like with input_number. It will be used to define the type of control that is more natural to the entity. The entities that are more analogue by nature could enjoy the nice slider in the frontend, while the ones that are more digital would provide input as text.

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)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

# Example configuration.yaml
demo:

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add mode attribute to number entity developers.home-assistant#743

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
The code has been formatted using Black (black --fast 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.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

To help with the load of incoming pull requests:

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

probot-home-assistant · 2020-12-02T20:38:28Z

Hey there @home-assistant/core, mind taking a look at this pull request as its been labeled with an integration (demo) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

probot-home-assistant · 2020-12-02T20:38:32Z

Hey there @home-assistant/core, mind taking a look at this pull request as its been labeled with an integration (number) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

github-actions · 2021-01-26T18:46:19Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

Shulyaka · 2021-01-26T21:01:52Z

Dear bot, please remove the stale label. Thank you.

github-actions · 2021-02-25T22:18:53Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

Shulyaka · 2021-02-25T23:12:52Z

May I ask someone to re-trigger the CI pipeline please?

frenck · 2021-03-01T16:38:17Z

This requires a frontend PR as well?

Shulyaka · 2021-03-02T09:03:35Z

Probably, yes (after home-assistant/frontend#8325).

homeassistant/components/number/const.py

JeffLIrion · 2021-03-06T16:14:35Z

Probably, yes (after home-assistant/frontend#8325).

Are the changes required as simple as reverting that pull request?

I want to use the number platform in a custom component of mine and I like the slider view much better than the box view, so I'm trying to push this through!👍

balloob · 2021-03-17T04:41:15Z

homeassistant/components/number/__init__.py

        return step

+    @property
+    def mode(self) -> str:


Isn't this competing with device class?

How is that?

It's an attribute that further classifies this entity which influences how it is represented.

That is true, so is the device class, icon, name, picture and such itself.
There must be a way for an integration to provide details on e.g., min/max, but also a representation. I could see the frontend being able to override that (e.g., in a Lovelace configuration).

Alternatively, we could indeed introduce device classes to the number integration, although, in general, the input is not always related to the unit shown.

E.g., Speed. Could be something between 0-100%/1-255, or something between 500-15000rpm. The first would be a nice slider, the second... probably not that much.

AAAAAAAAAAAAAAAAAH 😆

Correct me if I'm mistaken, but I assume that these changes are beyond the scope of this pull request.

Are there any changes necessary to get this merged in?

It would be an alternative that would render this PR not needed.

The advantage of the mode attribute is that it gives a platform more control over the representation, and the platform knows better whether the value it has is more discrete or monotonous. So, I would consider this PR as more about the nature of the data than just about a representation.
Also, it gives the control for the user to override it using the existing customize functionality.

As a compromise for the both, I can suggest to implement the same nice algorithm but as a default value for the attribute, e.g. instead of return MODE_SLIDER it would be more like return MODE_SLIDER if (max - min) / steps <= 255 else MODE_BOX.

Also, it gives the control for the user to override it using the existing customize functionality.

That is not something that should be used to adjust UI behavior, for these things we have the UI itself.

I agree with the suggestion given by balloob for that matter.

We should start with my suggestion and then we can see if this PR is still needed. Let's not apply multiple solutions at once.

github-actions · 2021-04-20T13:13:04Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

Add mode attribute to number entity

84c46c2

homeassistant added the cla-signed label Dec 2, 2020

probot-home-assistant bot added core has-tests integration: demo integration: number new-feature small-pr PRs with less than 30 lines. labels Dec 2, 2020

probot-home-assistant bot added the by-code-owner label Dec 2, 2020

Shulyaka mentioned this pull request Dec 2, 2020

Add mode attribute to number entity home-assistant/developers.home-assistant#743

Closed

5 tasks

Merge branch 'dev' into number_mode

024b478

github-actions bot added the stale label Jan 26, 2021

Merge branch 'dev' into number_mode

9582bdf

github-actions bot removed the stale label Jan 26, 2021

kukulich mentioned this pull request Feb 4, 2021

Fixed state card of number entity home-assistant/frontend#8325

Merged

9 tasks

github-actions bot added the stale label Feb 25, 2021

Merge branch 'dev' into number_mode

7c8413d

github-actions bot removed the stale label Feb 25, 2021

JeffLIrion reviewed Mar 6, 2021

View reviewed changes

homeassistant/components/number/const.py Show resolved Hide resolved

JeffLIrion approved these changes Mar 6, 2021

View reviewed changes

balloob reviewed Mar 17, 2021

View reviewed changes

github-actions bot added the stale label Apr 20, 2021

github-actions bot closed this Apr 27, 2021

github-actions bot locked and limited conversation to collaborators Apr 28, 2021

Uh oh!

Conversation

Shulyaka commented Dec 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

Uh oh!

probot-home-assistant bot commented Dec 2, 2020

Uh oh!

probot-home-assistant bot commented Dec 2, 2020

Uh oh!

github-actions bot commented Jan 26, 2021

Uh oh!

Shulyaka commented Jan 26, 2021

Uh oh!

github-actions bot commented Feb 25, 2021

Uh oh!

Shulyaka commented Feb 25, 2021

Uh oh!

frenck commented Mar 1, 2021

Uh oh!

Shulyaka commented Mar 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

JeffLIrion commented Mar 6, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

balloob Mar 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Shulyaka Mar 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

github-actions bot commented Apr 20, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Shulyaka commented Dec 2, 2020 •

edited

Loading

Example entry for `configuration.yaml`:

Shulyaka commented Mar 2, 2021 •

edited

Loading

balloob Mar 18, 2021 •

edited

Loading

Shulyaka Mar 21, 2021 •

edited

Loading