From bb84fc6a74fec9b51b6dc21507e65092c6fdbbac Mon Sep 17 00:00:00 2001
From: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Date: Tue, 21 Jun 2022 15:24:16 +0300
Subject: 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>
---
README.rst | 15 +++++++++++++++
1 file changed, 15 insertions(+)
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
~~~~~~~~~~~~~~~~~~~~~~
--
cgit v1.2.1