docs(ubtech): clarify parameters and add validation for video stream init#1405
Merged
openminddev merged 5 commits intoOpenMind:mainfrom Jan 14, 2026
Merged
Conversation
…psConversationProvider init
Cleaned up the ConversationMessage class docstring by removing parameter documentation. Removed parameter validation and related docstring sections from UbtechCameraVideoStream.__init__, streamlining the code and documentation.
Simplifies the YanAPI initialization by removing the try-except block and logging. YanAPI is now initialized directly with the provided robot_ip, which is no longer stripped of whitespace.
openminddev
approved these changes
Jan 14, 2026
aydnOktay
pushed a commit
to aydnOktay/OM1
that referenced
this pull request
Jan 19, 2026
…init (OpenMind#1405) * docs(teleops): added parameter docs for ConversationMessage and TeleopsConversationProvider init * docs(ubtech): added parameter docs and validation for UbtechCameraVideoStream init * Remove redundant docstrings and validation logic Cleaned up the ConversationMessage class docstring by removing parameter documentation. Removed parameter validation and related docstring sections from UbtechCameraVideoStream.__init__, streamlining the code and documentation. * Remove error handling from YanAPI initialization Simplifies the YanAPI initialization by removing the try-except block and logging. YanAPI is now initialized directly with the provided robot_ip, which is no longer stripped of whitespace. --------- Co-authored-by: xyiy001 <xyiy001@users.noreply.github.com> Co-authored-by: openmindev <boyuan.eth@gmail.com> Co-authored-by: openminddev <147775420+openminddev@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi! 👋 I noticed
UbtechCameraVideoStream.__init__was missing parameter documentation and input validation. I added complete parameter docs using NumPy style format and implemented robust validation logic to prevent potential runtime errors.Specifically:
robot_ip,frame_callback,frame_callbacks,fps,resolution, andjpeg_qualityinUbtechCameraVideoStream.__init__robot_ipnon-empty check (prevents empty strings)fpsboundary check (must be > 0)resolutionvalidity check (length and positive values)jpeg_qualityrange check (0-100)YanAPI.yan_api_initwith proper error loggingHope this helps make the code more robust! ✨