Skip to content

Clarify percentage_command_topic and percentage_state_topic for MQTT fan#157460

Merged
bdraco merged 3 commits into
home-assistant:devfrom
dwmw2:mqtt-fan
Nov 29, 2025
Merged

Clarify percentage_command_topic and percentage_state_topic for MQTT fan#157460
bdraco merged 3 commits into
home-assistant:devfrom
dwmw2:mqtt-fan

Conversation

@dwmw2
Copy link
Copy Markdown
Contributor

@dwmw2 dwmw2 commented Nov 27, 2025

Proposed change

The MQTT fan model is slightly confusing because the percentage_state_topic and percentage_command_topic values aren't actually percentages. This trivial documentation change just makes that a little bit clearer.

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

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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:

These aren't necessarily percentages; they're integers in the "speed range".
Copy link
Copy Markdown
Contributor

@home-assistant home-assistant Bot left a comment

Choose a reason for hiding this comment

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

Hi @dwmw2

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant Bot added integration: mqtt small-pr PRs with less than 30 lines. labels Nov 27, 2025
@home-assistant home-assistant Bot marked this pull request as draft November 27, 2025 23:13
@home-assistant
Copy link
Copy Markdown
Contributor

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.

@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @emontnemery, @jbouwh, @bdraco, mind taking a look at this pull request as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign mqtt Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Copy Markdown
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

As discussed with in #157429 the output is controlled by the percentage. The scaling and templates are optional. The examples and descriptions are clear IMO

@home-assistant home-assistant Bot marked this pull request as draft November 28, 2025 20:22
@jesserockz
Copy link
Copy Markdown
Member

I agree with the author that the documentation is not clear as it stands. It implies a percentage value will be received, but this is not the case. This is a small addition that will help clear this up for future users.

Copy link
Copy Markdown
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

We refer to the field names that are set via the UI.

Comment thread homeassistant/components/mqtt/strings.json Outdated
@jbouwh
Copy link
Copy Markdown
Contributor

jbouwh commented Nov 28, 2025

I agree with the author that the documentation is not clear as it stands. It implies a percentage value will be received, but this is not the case. This is a small addition that will help clear this up for future users.

Okay fair point.

Co-authored-by: Jan Bouwhuis <jbouwh@users.noreply.github.com>
@jbouwh
Copy link
Copy Markdown
Contributor

jbouwh commented Nov 28, 2025

I opened home-assistant/home-assistant.io#42019 to align the online documentaion with this PR.

Copy link
Copy Markdown
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

LGTM,

Thanks @dwmw2 and @jesserockz 👍

P.S. Mark the PR ready to allow it to be merged.

@dwmw2 dwmw2 marked this pull request as ready for review November 29, 2025 07:17
@home-assistant home-assistant Bot requested a review from jbouwh November 29, 2025 07:17
@bdraco bdraco merged commit 1472281 into home-assistant:dev Nov 29, 2025
66 checks passed
@bdraco bdraco added this to the 2025.12.0 milestone Nov 29, 2025
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MQTT fan sends level instead of percentage, to percentage_command_topic

6 participants