Skip to content

Document new wrapper for overlay options to rpi_camera#13097

Merged
fabaff merged 4 commits into
home-assistant:nextfrom
alxrdn:next
May 5, 2020
Merged

Document new wrapper for overlay options to rpi_camera#13097
fabaff merged 4 commits into
home-assistant:nextfrom
alxrdn:next

Conversation

@alxrdn
Copy link
Copy Markdown
Contributor

@alxrdn alxrdn commented Apr 20, 2020 •
edited
Loading

Proposed change

Add documentation for two new configuration variables added to rpi_camera.

Add wrapper for overlay options, in order to be able to add date/time (for example) on the pictures.
Add two new configuration variables :

  • overlay_metadata
  • overlay_timestamp

Their formats are documented at --annotate, -a Enable/set annotate flags or text.

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).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

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.

@probot-home-assistant probot-home-assistant Bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 20, 2020
@probot-home-assistant
Copy link
Copy Markdown

probot-home-assistant Bot commented Apr 20, 2020

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@probot-home-assistant probot-home-assistant Bot added the next This PR goes into the next branch label Apr 20, 2020
@alxrdn alxrdn mentioned this pull request Apr 20, 2020
Merged
20 tasks
@probot-home-assistant probot-home-assistant Bot added the has-parent This PR has a parent PR in another repo label Apr 20, 2020
@alxrdn
Copy link
Copy Markdown
Contributor Author

alxrdn commented Apr 20, 2020

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

I probably should have done a draft PR so I could have submitted this PR from the beginning with the link to code matching PR.

Afaik, this PR is targeted to the correct branch next as it relates to a new feature I am adding in the related code PR.

@alxrdn alxrdn removed their assignment Apr 20, 2020
@klaasnicolaas klaasnicolaas added new-feature This PR adds documentation for a new Home Assistant feature to an existing integration and removed in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 20, 2020
@alxrdn alxrdn changed the title document new wrapper for overlay options to rpi_camera Document new wrapper for overlay options to rpi_camera Apr 25, 2020
@MartinHjelmare MartinHjelmare added the parent-merged The parent PR has been merged already label Apr 30, 2020
frenck
frenck previously requested changes May 1, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, for the PR @alxrdn!

Left a comment, could you please take a look?

Thanks! 👍

Comment thread source/_integrations/rpi_camera.markdown Outdated
@frenck frenck added the in-progress This PR/Issue is currently being worked on label May 1, 2020
@alxrdn alxrdn removed their assignment May 1, 2020
@klaasnicolaas klaasnicolaas removed the in-progress This PR/Issue is currently being worked on label May 2, 2020
@fabaff fabaff dismissed frenck’s stale review May 5, 2020 08:38

Comment addressed

@fabaff fabaff merged commit f485411 into home-assistant:next May 5, 2020
@probot-home-assistant probot-home-assistant Bot removed the parent-merged The parent PR has been merged already label May 5, 2020
shenxn pushed a commit to shenxn/home-assistant.io that referenced this pull request May 7, 2020
@alxrdn @fabaff @shenxn
Document new wrapper for overlay options to rpi_camera (home-assistan…
f4d3bd9 
…t#13097)

* document new wrapper for overlay options to rpi_camera

* Move yaml configuration to rpi_camera key

* Remove optional parameters from yaml config example

* Minor changes

Co-authored-by: Fabian Affolter <mail@fabian-affolter.ch>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fabaff fabaff fabaff approved these changes

@frenck frenck frenck left review comments

Assignees

No one assigned

Labels

has-parent This PR has a parent PR in another repo new-feature This PR adds documentation for a new Home Assistant feature to an existing integration next This PR goes into the next branch

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@alxrdn @fabaff @frenck @MartinHjelmare @klaasnicolaas