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.

Sign up for GitHub

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 documentation for image for fyta #36806

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Add documentation for image for fyta #36806

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions source/_integrations/fyta.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ The following binary sensors are currently available per plant:
- Repotted
- Sensor update available

### Image

The picture created or chosen in the FYTA app is also exposed to Home Assistant.
Comment on lines +60 to +62
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance the image documentation with implementation details

While the addition of image documentation is valuable, it would be more helpful to include:

  • How to access the image in Home Assistant (entity ID, domain, etc.)
  • Supported image formats and any size limitations
  • How often the image updates
  • Any prerequisites for the feature to work

Consider expanding the section like this:

 ### Image
 
-The picture created or chosen in the FYTA app is also exposed to Home Assistant.
+The picture created or chosen in the FYTA app is exposed to Home Assistant as a camera entity. Each plant configured in your FYTA account will have its own camera entity with the ID `camera.fyta_[plant_name]`.
+
+{% note %}
+The image is updated whenever you change it in the FYTA app. The integration checks for new images during its regular 4-minute update interval.
+{% endnote %}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Image
The picture created or chosen in the FYTA app is also exposed to Home Assistant.
### Image
The picture created or chosen in the FYTA app is exposed to Home Assistant as a camera entity. Each plant configured in your FYTA account will have its own camera entity with the ID `camera.fyta_[plant_name]`.
{% note %}
The image is updated whenever you change it in the FYTA app. The integration checks for new images during its regular 4-minute update interval.
{% endnote %}


### Sensors

The following sensors are currently available per plant:
Expand Down
Loading