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

Add actions to animation #4959

Merged
merged 1 commit into from Jun 19, 2023
Merged

Conversation

guillempages
Copy link
Contributor

@guillempages guillempages commented Jun 17, 2023

What does this implement/fix?

Add actions to be able to easily change the current frame to the animation component.
Instead of needing to use a lambda and c++ code, allow a simple yaml action to switch to the next or previous frame, or to set a specific frame.

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)
  • Other

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

Pull request in esphome-docs with documentation (if applicable): esphome/esphome-docs#3001

Test Environment

  • ESP32
  • ESP32 IDF
  • ESP8266
  • RP2040

Example entry for config.yaml:

animation:
  - id: fire
    file: fire.gif

interval:
  - interval: 200ms
    then:
       - animation.next_frame: fire
# Alternative 1:
#       - animation.prev_frame: fire
# Alternative 2:
#       - animation.set_frame:
#          - id: fire
#            frame: 5
       - component.update: disp

display:
  - platform: <xyz>
     id: disp
     lambda: |-
       it.image(0, 0, id(fire));

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:

@probot-esphome
Copy link

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

Add actions to be able to easily change the current frame to the animation
component.
@jesserockz jesserockz merged commit ee12c68 into esphome:dev Jun 19, 2023
25 checks passed
@guillempages guillempages deleted the animation_actions branch June 20, 2023 20:01
@github-actions github-actions bot locked and limited conversation to collaborators Jun 22, 2023
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.

None yet

2 participants