rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify docstring for Simulation start_streaming

Browse source
This commit is contained in:
Julian Stirling 2025-08-06 11:48:06 +00:00
parent ad739e4830
commit b672c3c2a7
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/openflexure_microscope_server/things/camera/simulation.py
View file

@ -224,8 +224,13 @@ class SimulatedCamera(BaseCamera):
) -> None: ) -> None:
"""Start the live stream. """Start the live stream.
This should be used to adjust the resolution the simulation doesn't yet do The start_streaming method is used a camera ``Thing`` to begin streaming
this. images or to adjust the stream resolution if streaming is already active.
The simulation camera does not currently support the resolution argument.
It will always issue a warning that the resolution is not respected.
If called while already streaming, the warning will be emitted and no other
action will be taken.
""" """
logging.warning( logging.warning(
f"Simulation camera doesn't respect {main_resolution=} or {buffer_count=} " f"Simulation camera doesn't respect {main_resolution=} or {buffer_count=} "