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

Axis - Improve naming of some events #39699

Merged
merged 3 commits into from
Sep 6, 2020

Conversation

Kane610
Copy link
Member

@Kane610 Kane610 commented Sep 5, 2020

Breaking change

Initial naming of events from VMD4 and Fence guard are now based on their configured name on the device; 'binary_sensor.m1065-lw_0_vmd4_camera1profile1' is now 'binary_sensor.m1065-lw_0_vmd4_profile_1' or 'profile_1' can be whatever the user chose to name the profile.

Proposed change

Library now calls APIs of applications and this data can be used to improve naming of entities.
Specifically for Fence guard, Loitering guard, Motion guard, VMD4
This also fixes a small issue with parsing users which could break during certain conditions

Library changes: Kane610/axis@v33...v34

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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
  • The code has been formatted using Black (black --fast 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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

and event_data
and self.event.id in event_data
):
return f"{self.device.name} {self.event.TYPE} {event_data[self.event.id].name}"
Copy link
Member

Choose a reason for hiding this comment

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

Should we mark this a breaking change in case anyone was matching for specific text?

Copy link
Member Author

Choose a reason for hiding this comment

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

True, Will do!

@Kane610
Copy link
Member Author

Kane610 commented Sep 6, 2020

Thanks for the review @bdraco

@Kane610 Kane610 merged commit 41abc08 into home-assistant:dev Sep 6, 2020
@Kane610 Kane610 deleted the axis-better_event_names branch September 6, 2020 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants