[WIP] Updated documentation for camera.pi.

This commit is contained in:
Fabio Manganiello 2024-02-24 21:16:43 +01:00
parent e46704010b
commit 8999a226b1
Signed by untrusted user: blacklight
GPG key ID: D90FBA7F76362774
7 changed files with 9 additions and 12 deletions

View file

@ -7,7 +7,6 @@ Backends
:caption: Backends:
platypush/backend/button.flic.rst
platypush/backend/camera.pi.rst
platypush/backend/chat.telegram.rst
platypush/backend/http.rst
platypush/backend/midi.rst

View file

@ -1,6 +0,0 @@
``camera.pi``
===============================
.. automodule:: platypush.backend.camera.pi
:members:

View file

@ -0,0 +1,5 @@
``camera.pi.legacy``
====================
.. automodule:: platypush.plugins.camera.pi.legacy
:members:

View file

@ -21,6 +21,7 @@ Plugins
platypush/plugins/camera.gstreamer.rst
platypush/plugins/camera.ir.mlx90640.rst
platypush/plugins/camera.pi.rst
platypush/plugins/camera.pi.legacy.rst
platypush/plugins/chat.irc.rst
platypush/plugins/chat.telegram.rst
platypush/plugins/clipboard.rst

View file

@ -845,7 +845,7 @@ class CameraPlugin(RunnablePlugin, ABC):
**camera,
)
return self._start_streaming(camera, duration, stream_format) # type: ignore
return self._start_streaming(camera, duration, camera.info.stream_format) # type: ignore
def _start_streaming(
self, camera: Camera, duration: Optional[float], stream_format: str

View file

@ -19,7 +19,7 @@ class CameraPiPlugin(CameraPlugin):
If you are running a very old OS that only provides the deprecated
`picamera <https://github.com/waveform80/picamera>`_ module, or you rely on
features that are currently only supported by the old module, you should
use :class:`platypush.plugins.camera.pi_legacy.CameraPiLegacyPlugin`
use :class:`platypush.plugins.camera.pi.legacy.CameraPiLegacyPlugin`
instead.
"""
@ -63,8 +63,6 @@ class CameraPiPlugin(CameraPlugin):
1.0 is the default value, and higher values are mapped to higher
contrast levels.
:param brightness: Brightness level, as a float between -1.0 and 1.0.
:param video_stabilization: Enable video stabilization (default: False).
Only available on the old picamera module for now.
:param iso: ISO level (default: 0).
:param exposure_compensation: Exposure compensation level, as a float
between -8.0 and 8.0.

View file

@ -21,5 +21,5 @@ manifest:
- picamera
- numpy
- Pillow
package: platypush.plugins.camera.pi
package: platypush.plugins.camera.pi.legacy
type: plugin