summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2022-06-21 15:24:16 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2022-06-22 12:35:14 +0300
commitbb84fc6a74fec9b51b6dc21507e65092c6fdbbac (patch)
treecd2787b266d74eade0c2cc8c5645f768e4b95e60 /README.rst
parente135db8cb4026fc710de63c669aa877bcbd94c06 (diff)
README: Add short testing instructions with cam
The README.rst file contains the getting started instructions, but lacks a simple way to test libcamera. Add a short section about basic cam usage. Suggested-by: Pavel Machek <pavel@ucw.cz> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index f81d6e2e..05ebcec4 100644
--- a/README.rst
+++ b/README.rst
@@ -101,6 +101,21 @@ for android: [optional]
for lc-compliance: [optional]
libevent-dev
+Basic testing with cam utility
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``cam`` utility can be used for basic testing. You can list the cameras
+detected on the system with ``cam -l``, and capture ten frames from the first
+camera and save them to disk with ``cam -c 1 --capture=10 --file``. See
+``cam -h`` for more information about the ``cam`` tool.
+
+In case of problems, a detailed debug log can be obtained from libcamera by
+setting the ``LIBCAMERA_LOG_LEVELS`` environment variable:
+
+.. code::
+
+ :~$ LIBCAMERA_LOG_LEVELS=*:DEBUG cam -l
+
Using GStreamer plugin
~~~~~~~~~~~~~~~~~~~~~~