Add compensation integration

[Petro31]

Adds the compensation integration

Proposed change

Adds the compensation integration documentation

Type of change

• Spelling, grammar or other readability improvements (current branch).
• Adjusted missing or incorrect information in the current documentation (current branch).
• Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • I've opened up a PR to add logo's and icons in Brands repository.
• Added documentation for a new feature I'm adding to Home Assistant (next branch).
• Removed stale or deprecated documentation.

Additional information

• Link to parent pull request in the codebase: Add Compensation Integration core#41675
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue:

Checklist

• This PR uses the correct branch, based on one of the following:
  • I made a change to the existing documentation and used the current branch.
  • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
• The documentation follows the Home Assistant documentation standards.

[frenck]

Thanks for the PR @Petro31.

I've reviewed it, and left some comments. Could you please take a look?

Thanks 👍

[MatthewFlamm]

I think it is worth clearly stating that this integration does not interpolate. It fits a single line (or higher order polynomial) to all the data points. I think this will cause confusion as it does with the similar esphome usage. For example:

# Example configuration.yaml entry
compensation:
  media_player_db_volume:
    entity_id: media_player.yamaha_receiver
    data_points:
      - 0.2 -> -80.0
      - 0.5 -> -20.0
      - 1.0 -> -10.0

A value of 0.75 will not transform to -15.0. In fact a value of 0.5 won't transform to -20 in this case either!

[Petro31]

I think it is worth clearly stating that this integration does not interpolate. It fits a single line (or higher order polynomial) to all the data points. I think this will cause confusion as it does with the similar esphome usage. For example:

# Example configuration.yaml entry
compensation:
  media_player_db_volume:
    entity_id: media_player.yamaha_receiver
    data_points:
      - 0.2 -> -80.0
      - 0.5 -> -20.0
      - 1.0 -> -10.0

A value of 0.75 will not transform to -15.0. In fact a value of 0.5 won't transform to -20 in this case either!

@MatthewFlamm It's funny you should mention that. I was planning on adding non-linear interpolation at some point down the road. Does the ESPHome version do interpolation?

[MatthewFlamm]

I am only aware of the calibrate_linear (and calibrate_polynomial) filter in esphome that works like this integration. I think an interpolate integration would also be useful, but this seems off topic. My suggestion here is to add something like "A single polynomial, linear by default, is fit to all data points provided."

[Petro31]

I am only aware of the calibrate_linear (and calibrate_polynomial) filter in esphome that works like this integration. I think an interpolate integration would also be useful, but this seems off topic. My suggestion here is to add something like "A single polynomial, linear by default, is fit to all data points provided."

I'm not the greatest tech writer, mind if I use that line?

[MatthewFlamm]

I'm not the greatest tech writer, mind if I use that line?

You can use it.

[frenck]

✅ Approved. Can be merged as soon as the parent PR gets merged.

[frenck]

🎉 @Petro31 👍

Addressed