Onvif: Clarified the need to have at least one H.264 video stream present#41570
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
c0ffeeca7
changed the title
c0ffeeca7
left a comment
c0ffeeca7
left a comment
There was a problem hiding this comment.
Tiny structure tweak. Let me know what you think.
c0ffeeca7
left a comment
c0ffeeca7
left a comment
There was a problem hiding this comment.
Thank you, @fencepost-error 👍
There was a problem hiding this comment.
Pull request overview
This PR adds a troubleshooting section to the ONVIF integration documentation to clarify that cameras must have at least one H.264 video stream configured. The documentation explains a common setup issue where newer cameras default to H.265 encoding, which causes the "No usable cameras were found" error message.
Key Changes
- Adds a new "Troubleshooting" section to the ONVIF integration documentation
- Documents the H.264 requirement and provides resolution steps for H.265 compatibility issues
Comments suppressed due to low confidence (3)
source/_integrations/onvif.markdown:1
- The troubleshooting section structure doesn't follow the Home Assistant documentation standard. According to the template, troubleshooting issues should have a descriptive heading (e.g., "Can't set up the device"), followed by subsections for "Symptom", "Description" (optional), and "Resolution". The heading should describe the problem, not be labeled "Symptom: Error message:". Consider restructuring this as:
### Camera not detected during setup
#### Symptom
The ONVIF integration shows an error message "No usable cameras were found".---
source/_integrations/onvif.markdown:125
- The subsection "Cause" is not part of the standard troubleshooting structure in Home Assistant documentation. According to the template and observed patterns, troubleshooting sections should follow the structure: issue heading, "Symptom" (optional), "Description" (optional), and "Resolution". The cause information should be integrated into the "Description" subsection or the resolution text. Consider removing this subsection and incorporating the explanation into the resolution or adding a "Description" subsection before "Resolution".
source/_integrations/onvif.markdown:127 - [nitpick] Corrected spelling of 'video coding' to 'video compression'. H.265 provides improved video compression efficiency, not 'video coding' (which is a more general term). While 'video coding' is technically correct in a broad sense, 'compression' is more precise and commonly used when comparing H.264 and H.265.
|
|
||
| ### Symptom: Error message: "No usable cameras were found" | ||
|
|
||
| The ONVIF integration shows an error message "No usable cameras were found". |
There was a problem hiding this comment.
This line duplicates content from the heading. According to the documentation template, the symptom subsection should expand on or clarify the error, not simply repeat the heading. Either remove this redundant line or provide additional context, such as "When trying to set up the integration, you see the error message 'No usable cameras were found'."
| The ONVIF integration shows an error message "No usable cameras were found". | |
| When you try to set up the ONVIF integration in Home Assistant, you may see the error message "No usable cameras were found" if the integration cannot detect any compatible video streams from your camera. |
| Update the camera configuration to output at least one video stream in H.264 format rather than H.265. One option for doing this is to set a secondary stream to H.264 while leaving the primary stream at the default H.265. | ||
|
|
There was a problem hiding this comment.
The resolution lacks specific guidance on how to update the camera configuration. Consider adding more detailed steps or referencing the camera's documentation, such as: "Update the camera configuration to output at least one video stream in H.264 format. You can usually configure this in the camera's web interface or app under video stream settings. One option is to set a secondary stream to H.264 while leaving the primary stream at H.265. Refer to your camera's documentation for specific instructions on changing encoder settings."
| Update the camera configuration to output at least one video stream in H.264 format rather than H.265. One option for doing this is to set a secondary stream to H.264 while leaving the primary stream at the default H.265. | |
| To resolve this issue, you need to update your camera's configuration so that it outputs at least one video stream in H.264 format. Most cameras allow you to do this in their web interface or mobile app, typically under **Video**, **Stream**, or **Encoding** settings. | |
| 1. Open your camera's web interface or app. | |
| 2. Navigate to the **Video** or **Stream** settings section. | |
| 3. Look for options to set the video encoding format for each stream. | |
| 4. Change the encoding for at least one stream (often called the secondary or sub stream) to **H.264**. You can leave the primary stream set to **H.265** if you prefer. | |
| 5. Save your changes. | |
| If you are unsure how to access these settings or change the encoding format, refer to your camera's user manual or manufacturer's support website for specific instructions. |
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.