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.

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

[rtttl] Add get_gain() #7647

Merged
merged 3 commits into from
Oct 22, 2024
Merged

[rtttl] Add get_gain() #7647

merged 3 commits into from
Oct 22, 2024

Conversation

edwardtfn
Copy link
Contributor

@edwardtfn edwardtfn commented Oct 21, 2024

What does this implement/fix?

This adds the capability to get the selected gain value for the RTTTL component.
This is useful when creating a gain control in the UI, so one can show the current gain in a slider and allow users to adjust it.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code quality improvements to existing code or addition of tests
  • Other

Related issue or feature (if applicable): N/A

Pull request in esphome-docs with documentation (if applicable): N/A

Test Environment

  • ESP32
  • ESP32 IDF
  • ESP8266
  • RP2040
  • BK72xx
  • RTL87xx

Example entry for config.yaml:

output:
  # Buzzer output
  - id: buzzer_out
    platform: ledc
    pin:
      number: 21

rtttl:
  id: buzzer
  output: buzzer_out

esphome:
  on_boot:
    - priority: -100.44
      then:
        - lambda: |-
            id(buzzer).set_gain(id(buzzer_gain).state/100.0f);

number:
  - id: buzzer_gain
    name: Buzzer gain
    platform: template
    max_value: 100
    min_value: 0
    step: 1
    unit_of_measurement: "%"
    entity_category: config
    device_class: sound_pressure
    restore_value: true
    initial_value: 60
    optimistic: true
    set_action: 
      then:
        - lambda: |-
            id(buzzer).set_gain(x/100.0f);
            if (x > 0)
              id(buzzer).play("scale_up:d=32,o=5,b=100:c,c#,d#,e,f#,g#,a#,b");
            id(buzzer).dump_config();

sensor:
  - id: rtttl_gain
    name: Buzzer gain
    platform: template
    lambda: return id(buzzer).get_gain()*100;
    unit_of_measurement: "%"

Checklist:

  • The code change is tested and works locally.
  • Tests have been added to verify that the new code works (under tests/ folder).

If user exposed functionality or configuration variables are added/changed:

This is useful when creating a gain control in the UI, so one can show the current gain in a slider and allow users to adjust it.
@probot-esphome
Copy link

Hey there @glmnet, mind taking a look at this pull request as it has been labeled with an integration (rtttl) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@codecov-commenter
Copy link

codecov-commenter commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.02%. Comparing base (4d8b5ed) to head (e6a4250).
Report is 1483 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #7647      +/-   ##
==========================================
+ Coverage   53.70%   54.02%   +0.31%     
==========================================
  Files          50       50              
  Lines        9408     9717     +309     
  Branches     1654     1346     -308     
==========================================
+ Hits         5053     5250     +197     
- Misses       4056     4141      +85     
- Partials      299      326      +27     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@edwardtfn edwardtfn changed the title [rtttl} Add get_gain() [rtttl] Add get_gain() Oct 21, 2024
@jesserockz jesserockz merged commit 2597975 into esphome:dev Oct 22, 2024
24 checks passed
@jesserockz jesserockz changed the title [rtttl] Add get_gain() [rtttl] Add get_gain() Oct 22, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 24, 2024
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.

4 participants