Skip to content

Commit 0b42f60

Browse files
author
Alasdair Allan
authored
Merge pull request #2678 from raspberrypi/develop
Push to production
2 parents 0587a68 + 2f359a0 commit 0b42f60

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+296
-323
lines changed
Lines changed: 1 addition & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,3 @@
1-
include::camera/camera_usage.adoc[]
2-
31
include::camera/camera_hardware.adoc[]
42

5-
include::camera/libcamera_apps_intro.adoc[]
6-
7-
include::camera/libcamera_apps_getting_started.adoc[]
8-
9-
include::camera/libcamera_hello.adoc[]
10-
11-
include::camera/libcamera_jpeg.adoc[]
12-
13-
include::camera/libcamera_still.adoc[]
14-
15-
include::camera/libcamera_vid.adoc[]
16-
17-
include::camera/libcamera_apps_libav.adoc[]
18-
19-
include::camera/libcamera_raw.adoc[]
20-
21-
include::camera/libcamera_detect.adoc[]
22-
23-
include::camera/libcamera_options_common.adoc[]
24-
25-
include::camera/libcamera_options_still.adoc[]
26-
27-
include::camera/libcamera_options_vid.adoc[]
28-
29-
include::camera/libcamera_differences.adoc[]
30-
31-
include::camera/libcamera_apps_post_processing.adoc[]
32-
33-
include::camera/libcamera_apps_post_processing_opencv.adoc[]
34-
35-
include::camera/libcamera_apps_post_processing_tflite.adoc[]
36-
37-
include::camera/libcamera_apps_post_processing_writing.adoc[]
38-
39-
include::camera/libcamera_apps_multicam.adoc[]
40-
41-
include::camera/libcamera_apps_packages.adoc[]
42-
43-
include::camera/libcamera_apps_building.adoc[]
44-
45-
include::camera/libcamera_apps_writing.adoc[]
46-
47-
include::camera/libcamera_python.adoc[]
48-
49-
include::camera/libcamera_3rd_party_tuning.adoc[]
50-
51-
include::camera/libcamera_known_issues.adoc[]
52-
53-
include::camera/libcamera_apps_getting_help.adoc[]
54-
55-
include::camera/raspicam.adoc[]
56-
57-
include::camera/timelapse.adoc[]
58-
59-
include::camera/gstreamer.adoc[]
60-
61-
include::camera/qt.adoc[]
62-
63-
include::camera/v4l2.adoc[]
64-
65-
include::camera/csi-2-usage.adoc[]
66-
3+
include::camera/hqcam_filter_removal.adoc[]

documentation/asciidoc/accessories/camera/camera_hardware.adoc

Lines changed: 8 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Depending on the model, the camera may come with a small piece of translucent bl
2020

2121
Before proceeding, we recommend ensuring that your kernel, GPU firmware and applications are all up to date. Please follow the instructions on xref:../computers/os.adoc#using-apt[keeping your operating system up to date].
2222

23-
Then, please follow the relevant setup instructions either for xref:camera.adoc#getting-started[`libcamera`] or for xref:camera.adoc#enabling-the-camera[_Raspicam_].
23+
Then, please follow the relevant setup instructions for the xref:../computers/camera_software.adoc#getting-started[libcamera] software stack.
2424

2525
=== Hardware Specification
2626

@@ -49,18 +49,8 @@ Then, please follow the relevant setup instructions either for xref:camera.adoc#
4949

5050
| Video modes
5151
| 1080p30, 720p60 and 640 × 480p60/90
52-
| 1080p30, 720p60 and 640 × 480p60/90
53-
| 1080p30, 720p60 and 640 × 480p60/90
54-
55-
| Linux integration
56-
| V4L2 driver available
57-
| V4L2 driver available
58-
| V4L2 driver available
59-
60-
| C programming API
61-
| OpenMAX IL and others available
62-
| OpenMAX IL and others available
63-
|
52+
| 1080p47, 1640 × 1232p41 and 640 × 480p206
53+
| 2028 × 1080p50, 2028 × 1520p40 and 1332 × 990p120
6454

6555
| Sensor
6656
| OmniVision OV5647
@@ -85,7 +75,7 @@ Then, please follow the relevant setup instructions either for xref:camera.adoc#
8575
| Optical size
8676
| 1/4"
8777
| 1/4"
88-
|
78+
| 1/2.3"
8979

9080
| Full-frame SLR lens equivalent
9181
| 35 mm
@@ -141,68 +131,12 @@ Then, please follow the relevant setup instructions either for xref:camera.adoc#
141131
| 2.9
142132
| 2.0
143133
| Depends on lens
144-
|===
145-
146-
=== Software Features
147-
148-
==== `libcamera` stack
149-
150-
[cols=2]
151-
|===
152-
153-
| Picture formats
154-
| JPEG, JPEG + DNG (raw), BMP, PNG, YUV420, RGB888
155-
156-
| Video formats
157-
| raw h.264 (accelerated), MJPEG
158-
159-
| Post-processing
160-
| User-definable image effects, customisable DRC and HDR, motion detection, OpenCV integration, TensorFlowLite integration
161-
162-
| Exposure modes
163-
| normal, short, long, fixed fps, customisable
164-
165-
| Metering modes
166-
| centre-weighted, average, spot, customisable
167-
168-
| Automatic white balance modes
169-
| off, auto, incandescent, tungsten, fluorescent, indoor, daylight, cloudy, customisable
170-
171-
| Triggers
172-
| Keypress, UNIX signal, timeout
173-
174-
| Extra modes
175-
| timelapse, circular buffer, motion detection, segmented video, many features through flexible post-processing
176-
|===
177134

178-
==== Legacy stack
179-
180-
[cols=2]
181-
|===
182-
183-
| Picture formats
184-
| JPEG (accelerated), JPEG + RAW, GIF, BMP, PNG, YUV420, RGB888
185-
186-
| Video formats
187-
| raw h.264 (accelerated)
188-
189-
| Effects
190-
| negative, solarise, posterize, whiteboard, blackboard, sketch, denoise, emboss, oilpaint, hatch, gpen, pastel, watercolour, film, blur, saturation
191-
192-
| Exposure modes
193-
| auto, night, nightpreview, backlight, spotlight, sports, snow, beach, verylong, fixedfps, antishake, fireworks
194-
195-
| Metering modes
196-
| average, spot, backlit, matrix
197-
198-
| Automatic white balance modes
199-
| off, auto, sun, cloud, shade, tungsten, fluorescent, incandescent, flash, horizon
200-
201-
| Triggers
202-
| Keypress, UNIX signal, timeout
135+
| Maximum exposure times (seconds)
136+
| 6
137+
| 11.76
138+
| 670.74
203139

204-
| Extra modes
205-
| demo, burst/timelapse, circular buffer, video with motion vectors, segmented video, live preview on 3D models
206140
|===
207141

208142
=== HQ Camera IR Filter Transmission
@@ -211,24 +145,6 @@ The HQ Camera uses a Hoya CM500 infrared filter. Its transmission characteristic
211145

212146
image::images/hoyacm500.png[CM500 Transmission Graph]
213147

214-
=== Maximum Exposure Times
215-
216-
The maximum exposure times of the three official Raspberry Pi cameras are given in the table below.
217-
218-
[cols=",^"]
219-
|===
220-
| Module | Max exposure (seconds)
221-
222-
| V1 (OMx5647)
223-
| 6
224-
225-
| V2 (IMX219)
226-
| 10
227-
228-
| HQ (IMX477)
229-
| 230
230-
|===
231-
232148
=== Mechanical Drawings
233149

234150
image:images/RPi-S5-conn.png[camera connector]
@@ -241,27 +157,3 @@ image:images/RPi-S5-conn.png[camera connector]
241157

242158
* Camera Module v2 https://datasheets.raspberrypi.com/camera/camera-v2-schematics.pdf[PDF]
243159
* HQ Camera Module https://datasheets.raspberrypi.com/hq-camera/hq-camera-schematics.pdf[PDF]
244-
245-
=== Raspberry Pi HQ Camera Filter Removal
246-
247-
The High Quality Camera contains an IR filter, which is used to reduce the camera's sensitivity to infrared light. This ensures that outdoor photos look more natural. However, some nature photography can be enhanced with the removal of this filter; the colours of sky, plants, and water can be affected by its removal. The camera can also be used without the filter for night vision in a location that is illuminated with infrared light.
248-
249-
WARNING: *This procedure cannot be reversed:* the adhesive that attaches the filter will not survive being lifted and replaced, and while the IR filter is about 1.1mm thick, it may crack when it is removed. *Removing it will void the warranty on the product*. Nevertheless, removing the filter will be desirable to some users.
250-
251-
To remove the filter:
252-
253-
. Work in a clean and dust-free environment, as the sensor will be exposed to the air.
254-
image:images/rpi_hq_cam_sensor.jpg[camera sensor]
255-
. Unscrew the two 1.5 mm hex lock keys on the underside of the main circuit board. Be careful not to let the washers roll away. There is a gasket of slightly sticky material between the housing and PCB which will require some force to separate.
256-
image:images/rpi_hq_cam_gasket.jpg[camera gasket]
257-
. Lift up the board and place it down on a very clean surface. Make sure the sensor does not touch the surface.
258-
. Before completing the next step, read through all of the steps and decide whether you are willing to void your warranty. *Do not proceed* unless you are sure that you are willing to void your warranty.
259-
. Turn the lens around so that it is "looking" upwards and place it on a table.
260-
You may try some ways to weaken the adhesive, such as a little isopropyl alcohol and/or heat (~20-30 C). Using a pen top or similar soft plastic item, push down on the filter only at the very edges where the glass attaches to the aluminium - to minimise the risk of breaking the filter. The glue will break and the filter will detach from the lens mount.
261-
image:images/rpi_hq_cam_ir_filter.jpg[camera ir filter]
262-
. Given that changing lenses will expose the sensor, at this point you could affix a clear filter (for example, OHP plastic) to minimize the chance of dust entering the sensor cavity.
263-
image:images/rpi_hq_cam_clear_filter.jpg[camera protective filter]
264-
. Replace the main housing over the circuit board. Be sure to realign the housing with the gasket, which remains on the circuit board.
265-
. The nylon washer prevents damage to the circuit board; apply this washer first. Next, fit the steel washer, which prevents damage to the nylon washer.
266-
. Screw down the two hex lock keys. As long as the washers have been fitted in the correct order, they do not need to be screwed very tightly.
267-
. Note that it is likely to be difficult or impossible to glue the filter back in place and return the device to functioning as a normal optical camera.

documentation/asciidoc/accessories/camera/camera_usage.adoc

Lines changed: 0 additions & 52 deletions
This file was deleted.

documentation/asciidoc/accessories/camera/hqcam_filter_removal.adoc

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,26 @@ WARNING: *This procedure cannot be reversed:* the adhesive that attaches the fil
66

77
To remove the filter:
88

9-
. Work in a clean and dust-free environment, as the sensor will be exposed to the air.
10-
image:images/rpi_hq_cam_sensor.jpg[camera sensor]
11-
. Unscrew the two 1.5 mm hex lock keys on the underside of the main circuit board. Be careful not to let the washers roll away. There is a gasket of slightly sticky material between the housing and PCB which will require some force to separate.
12-
image:images/rpi_hq_cam_gasket.jpg[camera gasket]
13-
. Lift up the board and place it down on a very clean surface. Make sure the sensor does not touch the surface.
14-
. Before completing the next step, read through all of the steps and decide whether you are willing to void your warranty. *Do not proceed* unless you are sure that you are willing to void your warranty.
15-
. Turn the lens around so that it is "looking" upwards and place it on a table.
16-
You may try some ways to weaken the adhesive, such as a little isopropyl alcohol and/or heat (~20-30 C). Using a pen top or similar soft plastic item, push down on the filter only at the very edges where the glass attaches to the aluminium - to minimise the risk of breaking the filter. The glue will break and the filter will detach from the lens mount.
17-
image:images/rpi_hq_cam_ir_filter.jpg[camera ir filter]
18-
. Given that changing lenses will expose the sensor, at this point you could affix a clear filter (for example, OHP plastic) to minimize the chance of dust entering the sensor cavity.
19-
image:images/rpi_hq_cam_clear_filter.jpg[camera protective filter]
20-
. Replace the main housing over the circuit board. Be sure to realign the housing with the gasket, which remains on the circuit board.
21-
. The nylon washer prevents damage to the circuit board; apply this washer first. Next, fit the steel washer, which prevents damage to the nylon washer.
22-
. Screw down the two hex lock keys. As long as the washers have been fitted in the correct order, they do not need to be screwed very tightly.
23-
. Note that it is likely to be difficult or impossible to glue the filter back in place and return the device to functioning as a normal optical camera.
9+
* Work in a clean and dust-free environment, as the sensor will be exposed to the air.
10+
11+
image:images/rpi_hq_cam_sensor.jpg[camera sensor, width="70%"]
12+
13+
* Unscrew the two 1.5 mm hex lock keys on the underside of the main circuit board. Be careful not to let the washers roll away. There is a gasket of slightly sticky material between the housing and PCB which will require some force to separate.
14+
15+
image:images/rpi_hq_cam_gasket.jpg[camera gasket, width="70%"]
16+
17+
* Lift up the board and place it down on a very clean surface. Make sure the sensor does not touch the surface.
18+
* Before completing the next step, read through all of the steps and decide whether you are willing to void your warranty. *Do not proceed* unless you are sure that you are willing to void your warranty.
19+
* Turn the lens around so that it is "looking" upwards and place it on a table.
20+
* ou may try some ways to weaken the adhesive, such as a little isopropyl alcohol and/or heat (~20-30 C). Using a pen top or similar soft plastic item, push down on the filter only at the very edges where the glass attaches to the aluminium - to minimise the risk of breaking the filter. The glue will break and the filter will detach from the lens mount.
21+
22+
image:images/rpi_hq_cam_ir_filter.jpg[camera ir filter, width="70%"]
23+
24+
* Given that changing lenses will expose the sensor, at this point you could affix a clear filter (for example, OHP plastic) to minimize the chance of dust entering the sensor cavity.
25+
26+
image:images/rpi_hq_cam_clear_filter.jpg[camera protective filter, width="70%"]
27+
28+
* Replace the main housing over the circuit board. Be sure to realign the housing with the gasket, which remains on the circuit board.
29+
* The nylon washer prevents damage to the circuit board; apply this washer first. Next, fit the steel washer, which prevents damage to the nylon washer.
30+
* Screw down the two hex lock keys. As long as the washers have been fitted in the correct order, they do not need to be screwed very tightly.
31+
* Note that it is likely to be difficult or impossible to glue the filter back in place and return the device to functioning as a normal optical camera.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
== Introducing the Raspberry Pi Cameras
2+
3+
Raspberry Pi currently sell two types of camera board: an https://www.raspberrypi.com/products/camera-module-v2/[8MP device] and a https://www.raspberrypi.com/products/raspberry-pi-high-quality-camera/[12MP High Quality (HQ)] camera. The 8MP device is also available in https://www.raspberrypi.com/products/pi-noir-camera-v2/[NoIR form] without an IR filter. The original 5MP device is no longer available from Raspberry Pi. Further details on the camera modules can be found in the xref:../accessories/camera.adoc#camera-modules[camera hardware] page.
4+
5+
All Raspberry Pi cameras are capable of taking high-resolution photographs, along with full HD 1080p video, and can be fully controlled programmatically. This documentation describes how to use the camera in various scenarios, and how to use the various software tools.
6+
7+
Once you've xref:../accessories/camera.adoc#installing-a-raspberry-pi-camera[installed your camera module], there are various ways the cameras can be used. The simplest option is to use one of the provided camera applications, such as `libcamera-still` or `libcamera-vid`.

documentation/asciidoc/accessories/camera/libcamera_apps_building.adoc renamed to documentation/asciidoc/computers/camera/libcamera_apps_building.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,13 @@ If you want to use the Qt preview window, please also execute
3232
sudo apt install -y qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
3333
----
3434

35-
Now proceed directly to the instructions for xref:camera.adoc#building-libcamera-apps[building `libcamera-apps`]. Raspberry Pi OS Lite users should check that _git_ is installed first (`sudo apt install -y git`).
35+
If you want xref:camera_software.adoc#libav-integration-with-libcamera-vid[libav] support in `libcamera-vid`, additional libraries must be installed:
36+
37+
----
38+
sudo apt install libavcodec-dev libavdevice-dev libavformat-dev libswresample-dev
39+
----
40+
41+
Now proceed directly to the instructions for xref:camera_software.adoc#building-libcamera-apps[building `libcamera-apps`]. Raspberry Pi OS Lite users should check that _git_ is installed first (`sudo apt install -y git`).
3642

3743
==== Building `libcamera`
3844

@@ -174,4 +180,4 @@ sudo ldconfig # this is only necessary on the first build
174180

175181
NOTE: If you are using an image where `libcamera-apps` have been previously installed as an `apt` package, and you want to run the new `libcamera-apps` executables from the same terminal window where you have just built and installed them, you may need to run `hash -r` to be sure to pick up the new ones over the system supplied ones.
176182

177-
Finally, if you have not already done so, please be sure to follow the `dtoverlay` and display driver instructions in the xref:camera.adoc#getting-started[Getting Started section] (and rebooting if you changed anything there).
183+
Finally, if you have not already done so, please be sure to follow the `dtoverlay` and display driver instructions in the xref:camera_software.adoc#getting-started[Getting Started section] (and rebooting if you changed anything there).

0 commit comments

Comments
 (0)