forked from platypush/platypush
[WIP] Updated documentation for camera.pi
.
This commit is contained in:
parent
e46704010b
commit
8999a226b1
7 changed files with 9 additions and 12 deletions
|
@ -7,7 +7,6 @@ Backends
|
||||||
:caption: Backends:
|
:caption: Backends:
|
||||||
|
|
||||||
platypush/backend/button.flic.rst
|
platypush/backend/button.flic.rst
|
||||||
platypush/backend/camera.pi.rst
|
|
||||||
platypush/backend/chat.telegram.rst
|
platypush/backend/chat.telegram.rst
|
||||||
platypush/backend/http.rst
|
platypush/backend/http.rst
|
||||||
platypush/backend/midi.rst
|
platypush/backend/midi.rst
|
||||||
|
|
|
@ -1,6 +0,0 @@
|
||||||
``camera.pi``
|
|
||||||
===============================
|
|
||||||
|
|
||||||
.. automodule:: platypush.backend.camera.pi
|
|
||||||
:members:
|
|
||||||
|
|
5
docs/source/platypush/plugins/camera.pi.legacy.rst
Normal file
5
docs/source/platypush/plugins/camera.pi.legacy.rst
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
``camera.pi.legacy``
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. automodule:: platypush.plugins.camera.pi.legacy
|
||||||
|
:members:
|
|
@ -21,6 +21,7 @@ Plugins
|
||||||
platypush/plugins/camera.gstreamer.rst
|
platypush/plugins/camera.gstreamer.rst
|
||||||
platypush/plugins/camera.ir.mlx90640.rst
|
platypush/plugins/camera.ir.mlx90640.rst
|
||||||
platypush/plugins/camera.pi.rst
|
platypush/plugins/camera.pi.rst
|
||||||
|
platypush/plugins/camera.pi.legacy.rst
|
||||||
platypush/plugins/chat.irc.rst
|
platypush/plugins/chat.irc.rst
|
||||||
platypush/plugins/chat.telegram.rst
|
platypush/plugins/chat.telegram.rst
|
||||||
platypush/plugins/clipboard.rst
|
platypush/plugins/clipboard.rst
|
||||||
|
|
|
@ -845,7 +845,7 @@ class CameraPlugin(RunnablePlugin, ABC):
|
||||||
**camera,
|
**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(
|
def _start_streaming(
|
||||||
self, camera: Camera, duration: Optional[float], stream_format: str
|
self, camera: Camera, duration: Optional[float], stream_format: str
|
||||||
|
|
|
@ -19,7 +19,7 @@ class CameraPiPlugin(CameraPlugin):
|
||||||
If you are running a very old OS that only provides the deprecated
|
If you are running a very old OS that only provides the deprecated
|
||||||
`picamera <https://github.com/waveform80/picamera>`_ module, or you rely on
|
`picamera <https://github.com/waveform80/picamera>`_ module, or you rely on
|
||||||
features that are currently only supported by the old module, you should
|
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.
|
instead.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
@ -63,8 +63,6 @@ class CameraPiPlugin(CameraPlugin):
|
||||||
1.0 is the default value, and higher values are mapped to higher
|
1.0 is the default value, and higher values are mapped to higher
|
||||||
contrast levels.
|
contrast levels.
|
||||||
:param brightness: Brightness level, as a float between -1.0 and 1.0.
|
: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 iso: ISO level (default: 0).
|
||||||
:param exposure_compensation: Exposure compensation level, as a float
|
:param exposure_compensation: Exposure compensation level, as a float
|
||||||
between -8.0 and 8.0.
|
between -8.0 and 8.0.
|
||||||
|
|
|
@ -21,5 +21,5 @@ manifest:
|
||||||
- picamera
|
- picamera
|
||||||
- numpy
|
- numpy
|
||||||
- Pillow
|
- Pillow
|
||||||
package: platypush.plugins.camera.pi
|
package: platypush.plugins.camera.pi.legacy
|
||||||
type: plugin
|
type: plugin
|
||||||
|
|
Loading…
Reference in a new issue