Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Modernize Fitbit entity names #130828

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from
Open

Modernize Fitbit entity names #130828

wants to merge 5 commits into from
+315 −174

Conversation

allenporter
Copy link
Contributor

Proposed change

Modernize Fitbit entity names by using entity names and translations. This fixes an issue where adding multiple instance of the integration does not create unique names.

The Fitbit API has three types of sensors to be aware of:

  • Device specific entities, such as battery level. These are already using the modern format and not changed
  • Account level data, recorded either manually or using trackers e.g. Steps. These use the account display name for the device/service.
  • Tracker specific data, recorded using a trackers only. These additionally have "Tracker" in the device/service name.

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

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:

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:

balloob
balloob requested changes Nov 18, 2024
View reviewed changes
Copy link
Member

@balloob balloob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Name + test snapshots will need to be updated.

@home-assistant home-assistant bot marked this pull request as draft November 18, 2024 02:06
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@allenporter allenporter marked this pull request as ready for review November 18, 2024 05:06
allenporter
allenporter commented Nov 18, 2024
View reviewed changes
Copy link
Contributor Author

@allenporter allenporter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated names to be sentence case and updated snapshots, thanks.

joostlek
joostlek requested changes Nov 18, 2024
View reviewed changes
homeassistant/components/fitbit/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/fitbit/sensor.py
@@ -135,15 +161,15 @@ class FitbitSensorEntityDescription(SensorEntityDescription):
),
FitbitSensorEntityDescription(
key="activities/calories",
name="Calories",
translation_key="calories",
native_unit_of_measurement="cal",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, I think we now also merged allowing calories to be unit of energy

homeassistant/components/fitbit/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/fitbit/sensor.py Outdated
@@ -368,7 +394,7 @@ class FitbitSensorEntityDescription(SensorEntityDescription):
),
FitbitSensorEntityDescription(
key="body/weight",
name="Weight",
translation_key="weight",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Device class translation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.

homeassistant/components/fitbit/strings.json Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft November 18, 2024 07:36
@allenporter allenporter marked this pull request as ready for review November 18, 2024 15:42
joostlek
joostlek reviewed Nov 18, 2024
View reviewed changes
homeassistant/components/fitbit/sensor.py
@@ -259,7 +283,7 @@ class FitbitSensorEntityDescription(SensorEntityDescription):
),
FitbitSensorEntityDescription(
key="activities/tracker/distance",
name="Tracker Distance",
translation_key="distance",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
translation_key="distance",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joostlek joostlek joostlek requested changes

@balloob balloob Awaiting requested review from balloob

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
by-code-owner cla-signed has-tests integration: fitbit new-feature Quality Scale: No score
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fitbit integration and multiple accounts: devices and entities have no account identifier in names
3 participants
@allenporter @balloob @joostlek