diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55cc13bb9..cbf132cdf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Before starting writing your contribution to the documentation, you should take ## Type of Content -We welcome contributions from the community, ranging from correcting small typos all the way through to adding entire new sections to the documentation. However, going forward we're going to be fairly targetted about what sort of content we add to the documentation. We are looking to keep the repository, and the documentation, focussed on Raspberry Pi-specific things, rather than having generic Linux or computing content. +We welcome contributions from the community, ranging from correcting small typos all the way through to adding entire new sections to the documentation. However, going forward we're going to be fairly targeted about what sort of content we add to the documentation. We are looking to keep the repository, and the documentation, focused on Raspberry Pi-specific things, rather than having generic Linux or computing content. We are therefore deprecating the more generic documentation around using the Linux operating system, ahead of removing these sections entirely at some point in the future as part of a larger update to the documentation site. This move is happening as we feel these sort of more general topics are, ten years on from when the documentation was initially written, now much better covered elsewhere on the web. diff --git a/documentation/asciidoc/accessories/build-hat/net-brick.adoc b/documentation/asciidoc/accessories/build-hat/net-brick.adoc index 54cc2a8f8..f65318a92 100644 --- a/documentation/asciidoc/accessories/build-hat/net-brick.adoc +++ b/documentation/asciidoc/accessories/build-hat/net-brick.adoc @@ -1,6 +1,6 @@ === Using the Build HAT from .NET -The Raspberry Pi Built HAT is refered to "Brick" in LEGO® parlance and you can talk directly to it from .NET using the https://datasheets.raspberrypi.com/build-hat/build-hat-serial-protocol.pdf[Build HAT Serial Protocol]. +The Raspberry Pi Built HAT is referred to "Brick" in LEGO® parlance and you can talk directly to it from .NET using the https://datasheets.raspberrypi.com/build-hat/build-hat-serial-protocol.pdf[Build HAT Serial Protocol]. You can create a `brick` object as below, diff --git a/documentation/asciidoc/accessories/build-hat/net-sensors.adoc b/documentation/asciidoc/accessories/build-hat/net-sensors.adoc index 1ecf0c954..c8d6d72e8 100644 --- a/documentation/asciidoc/accessories/build-hat/net-sensors.adoc +++ b/documentation/asciidoc/accessories/build-hat/net-sensors.adoc @@ -179,8 +179,8 @@ while (!Console.KeyAvailable) { var colorRead = colorSensor.GetColor(); Console.WriteLine($"Color: {colorRead}"); - var relected = colorSensor.GetReflectedLight(); - Console.WriteLine($"Reflected: {relected}"); + var reflected = colorSensor.GetReflectedLight(); + Console.WriteLine($"Reflected: {reflected}"); var ambiant = colorSensor.GetAmbiantLight(); Console.WriteLine($"Ambiant: {ambiant}"); var distance = colorSensor.GetDistance(); @@ -210,4 +210,4 @@ while(!console.KeyAvailable) console.WriteLine($"Distance: {distance.Distance} mm"); Thread.Sleep(200); } ----- \ No newline at end of file +---- diff --git a/documentation/asciidoc/accessories/camera/libcamera_3rd_party_tuning.adoc b/documentation/asciidoc/accessories/camera/libcamera_3rd_party_tuning.adoc index 0a4af9ec0..a20bd82bd 100644 --- a/documentation/asciidoc/accessories/camera/libcamera_3rd_party_tuning.adoc +++ b/documentation/asciidoc/accessories/camera/libcamera_3rd_party_tuning.adoc @@ -2,7 +2,7 @@ ==== The Camera Tuning File -Most of the image procesing applied to frames from the sensor is done by the hardware ISP (Image Signal Procesor). This processing is governed by a set of _control algorithms_ and these in turn must have a wide range of parameters supplied to them. These parameters are tuned specifically for each sensor and are collected together in a JSON file known as the _camera tuning file_. +Most of the image processing applied to frames from the sensor is done by the hardware ISP (Image Signal Processor). This processing is governed by a set of _control algorithms_ and these in turn must have a wide range of parameters supplied to them. These parameters are tuned specifically for each sensor and are collected together in a JSON file known as the _camera tuning file_. This _tuning file_ can be inspected and edited by users. Using the `--tuning-file` command line option, users can point the system at completely custom camera tuning files. diff --git a/documentation/asciidoc/accessories/camera/libcamera_apps_intro.adoc b/documentation/asciidoc/accessories/camera/libcamera_apps_intro.adoc index 5f0ad4130..2321035d0 100644 --- a/documentation/asciidoc/accessories/camera/libcamera_apps_intro.adoc +++ b/documentation/asciidoc/accessories/camera/libcamera_apps_intro.adoc @@ -4,7 +4,7 @@ `libcamera` is a new software library aimed at supporting complex camera systems directly from the Linux operating system. In the case of the Raspberry Pi it enables us to drive the camera system directly from open source code running on ARM processors. The proprietary code running on the Broadcom GPU, and to which users have no access at all, is almost completely by-passed. -`libcamera` presents a C++ API to applications and works at the level of configuring the camera and then allowing an application to request image frames. These image buffers reside in system memory and can be passed directly to still image encoders (such as JPEG) or to video encoders (such as h.264), though such ancilliary functions as encoding images or displaying them are strictly beyond the purview of `libcamera` itself. +`libcamera` presents a C++ API to applications and works at the level of configuring the camera and then allowing an application to request image frames. These image buffers reside in system memory and can be passed directly to still image encoders (such as JPEG) or to video encoders (such as h.264), though such ancillary functions as encoding images or displaying them are strictly beyond the purview of `libcamera` itself. For this reason Raspberry Pi supplies a small set of example `libcamera-apps`. These are simple applications, built on top of `libcamera`, and are designed largely to emulate the function of the legacy stack built on Broadcom's propretary GPU code (some users will recognise these legacy applications as `raspstill` and `raspivid`). The applications we provide are: diff --git a/documentation/asciidoc/accessories/camera/libcamera_options_vid.adoc b/documentation/asciidoc/accessories/camera/libcamera_options_vid.adoc index 9a12d0303..b4925a566 100644 --- a/documentation/asciidoc/accessories/camera/libcamera_options_vid.adoc +++ b/documentation/asciidoc/accessories/camera/libcamera_options_vid.adoc @@ -90,7 +90,7 @@ Example: `libcamera-vid -t 0 -o test.h264 -k --initial pause` --split Split multiple recordings into separate files ---- -This option should be used in conjunction with `--keypress` or `--signal` and causes each recording session (inbetween the pauses) to be written to a separate file. +This option should be used in conjunction with `--keypress` or `--signal` and causes each recording session (in between the pauses) to be written to a separate file. Example: `libcamera-vid -t 0 --keypress --split --initial pause -o test%04d.h264` @@ -98,7 +98,7 @@ Example: `libcamera-vid -t 0 --keypress --split --initial pause -o test%04d.h264 --segment Write the video recording into multiple segments ---- -This option causes the video recording to be split accross multiple files where the parameter gives the approximate duration of each file in milliseconds. +This option causes the video recording to be split across multiple files where the parameter gives the approximate duration of each file in milliseconds. One convenient little trick is to pass a very small duration parameter (namely, `--segment 1`) which will result in each frame being written to a separate output file. This makes it easy to do "burst" JPEG capture (using the MJPEG codec), or "burst" raw frame capture (using `libcamera-raw`). diff --git a/documentation/asciidoc/accessories/camera/libcamera_vid.adoc b/documentation/asciidoc/accessories/camera/libcamera_vid.adoc index 637a8d9f4..1418cc29f 100644 --- a/documentation/asciidoc/accessories/camera/libcamera_vid.adoc +++ b/documentation/asciidoc/accessories/camera/libcamera_vid.adoc @@ -11,7 +11,7 @@ The resulting file can be played with `vlc` (among other applications) ---- vlc test.h264 ---- -Note that this is an unpackaged video bistream, it is not wrapped in any kind of container format (such as an mp4 file). The `--save-pts` option can be used to output frame timestamps so that the bitstream can subsequently be converted into an appropriate format using a tool like `mkvmerge`. +Note that this is an unpackaged video bitstream, it is not wrapped in any kind of container format (such as an mp4 file). The `--save-pts` option can be used to output frame timestamps so that the bitstream can subsequently be converted into an appropriate format using a tool like `mkvmerge`. `libcamera-vid -o test.h264 --save-pts timestamps.txt` diff --git a/documentation/asciidoc/accessories/display/display_intro.adoc b/documentation/asciidoc/accessories/display/display_intro.adoc index 98c3197db..7d186335c 100644 --- a/documentation/asciidoc/accessories/display/display_intro.adoc +++ b/documentation/asciidoc/accessories/display/display_intro.adoc @@ -103,7 +103,7 @@ The options for the touchscreen are: | Invert Y coordinates | touchscreen-swapped-x-y -| Swap X and Y cordinates +| Swap X and Y coordinates |=== === Troubleshooting diff --git a/documentation/asciidoc/computers/config_txt/video.adoc b/documentation/asciidoc/computers/config_txt/video.adoc index c39979c45..fe877fd70 100644 --- a/documentation/asciidoc/computers/config_txt/video.adoc +++ b/documentation/asciidoc/computers/config_txt/video.adoc @@ -1405,7 +1405,7 @@ hdmi_timings= ---- = horizontal pixels (width) = invert hsync polarity - = horizontal forward padding from DE acitve edge + = horizontal forward padding from DE active edge = hsync pulse width in pixel clocks = vertical back padding from DE active edge = vertical pixels height (lines) @@ -1568,7 +1568,7 @@ dpi_timings= < ---- = horizontal pixels (width) = invert hsync polarity - = horizontal forward padding from DE acitve edge + = horizontal forward padding from DE active edge = hsync pulse width in pixel clocks = vertical back padding from DE active edge = vertical pixels height (lines) diff --git a/documentation/asciidoc/computers/configuration/access-point-routed.adoc b/documentation/asciidoc/computers/configuration/access-point-routed.adoc index ea9148aa5..473613766 100644 --- a/documentation/asciidoc/computers/configuration/access-point-routed.adoc +++ b/documentation/asciidoc/computers/configuration/access-point-routed.adoc @@ -58,7 +58,7 @@ In order to provide network management services (DNS, DHCP) to wireless clients, sudo apt install dnsmasq ---- -Finally, install `netfilter-persistent` and its plugin `iptables-persistent`. This utilty helps by saving firewall rules and restoring them when the Raspberry Pi boots: +Finally, install `netfilter-persistent` and its plugin `iptables-persistent`. This utility helps by saving firewall rules and restoring them when the Raspberry Pi boots: ---- sudo DEBIAN_FRONTEND=noninteractive apt install -y netfilter-persistent iptables-persistent diff --git a/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc b/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc index fdd8b6573..bf2377545 100644 --- a/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc @@ -102,7 +102,7 @@ dpi_timings= < = horizontal pixels (width) = invert hsync polarity - = horizontal forward padding from DE acitve edge + = horizontal forward padding from DE active edge = hsync pulse width in pixel clocks = vertical back padding from DE active edge = vertical pixels height (lines) diff --git a/documentation/asciidoc/computers/raspberry-pi/usb-bus-on-raspberry-pi.adoc b/documentation/asciidoc/computers/raspberry-pi/usb-bus-on-raspberry-pi.adoc index 6ccad69fe..f98050b42 100644 --- a/documentation/asciidoc/computers/raspberry-pi/usb-bus-on-raspberry-pi.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/usb-bus-on-raspberry-pi.adoc @@ -1,4 +1,4 @@ -== Universial Serial Bus (USB) +== Universal Serial Bus (USB) In general, every device supported by Linux can be used with a Raspberry Pi, although there are some limitations for models prior to Pi 4. diff --git a/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc b/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc index 4d97ae19d..846455243 100644 --- a/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc +++ b/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc @@ -28,5 +28,5 @@ The API level Doxygen documentation for the Raspberry Pi Pico C/{cpp} SDK is als [NOTE] ==== -If you are building applications with the C/C++ SDK and targetting boards other than the Raspberry Pi Pico, you will need to pass `-DPICO_BOARD=boardname` to CMake. Here `boardname` is the name of your board, e.g. for the Adafruit Feather RP2040 you should pass `-DPICO_BOARD=adafruit_feather_rp2040`. See the https://github.com/raspberrypi/pico-sdk/tree/master/src/boards[`boards/` directory] in the Pico SDK, and the https://forums.raspberrypi.com/viewtopic.php?f=147&t=304393[forums], for more information. +If you are building applications with the C/C++ SDK and targeting boards other than the Raspberry Pi Pico, you will need to pass `-DPICO_BOARD=boardname` to CMake. Here `boardname` is the name of your board, e.g. for the Adafruit Feather RP2040 you should pass `-DPICO_BOARD=adafruit_feather_rp2040`. See the https://github.com/raspberrypi/pico-sdk/tree/master/src/boards[`boards/` directory] in the Pico SDK, and the https://forums.raspberrypi.com/viewtopic.php?f=147&t=304393[forums], for more information. ====