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

docs(board): stream_ticks method should be awaited to return TickStream iterator #708

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

HipsterBrown
Copy link
Contributor

The current example usage doc comment for the stream_ticks method demonstrates using an async for loop to process the stream of digital interrupt ticks without awaiting the method call, which is required to fulfill the coroutine and access the TickStream response.

Copy link
Contributor

Warning your change may break code samples. If your change modifies any of the following functions please contact @viamrobotics/fleet-management. Thanks!

component function
base is_moving
board gpio_pin_by_name
camera get_image
encoder get_position
motor is_moving
sensor get_readings
servo get_position
arm get_end_position
gantry get_lengths
gripper is_moving
movement_sensor get_linear_acceleration
input_controller get_controls
audio get_properties
pose_tracker get_poses
power_sensor get_power
motion get_pose
vision get_properties
mlmodel metadata
slam get_point_cloud_map

@HipsterBrown HipsterBrown merged commit 7192e81 into main Aug 15, 2024
13 checks passed
@HipsterBrown HipsterBrown deleted the nhehr/fix-stream-ticks-docs branch August 15, 2024 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants