curious.bio/planktoscope
curious.bio/planktoscope
9
0
Fork 0
Code Issues 10 Pull requests Packages Projects 7 Releases Wiki Activity

Update quickstart.rst

Browse source
This commit is contained in:
tpollina 2019-12-01 19:27:12 -08:00 committed by GitHub
parent c23aca302e
commit 89f5f8c308
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
docs/quickstart.rst
View file

@ -1,48 +1,51 @@
.. _license: .. _quickstart:
======= ===============
License Getting Started
======= ===============
Copyright 2018-2019 `Thibaut Pollina`_ .. warning::
Redistribution and use in source and binary forms, with or without Make sure your Pi is off while installing the camera module. Although it is
modification, are permitted provided that the following conditions are met: possible to install the camera while the Pi is on, this isn't good practice
(if the camera is active when removed, it's possible to damage it).
* Redistributions of source code must retain the above copyright notice, this Connect your camera module to the CSI port on your Raspberry Pi; this is the
list of conditions and the following disclaimer. long thin port adjacent to the HDMI socket. Gently lift the collar on top of
the CSI port (if it comes off, don't worry, you can push it back in but try to
be more gentle in future!). Slide the ribbon cable of the camera module into
the port with the blue side facing the Ethernet port (or where the Ethernet
port would be if you've got a model A/A+).
* Redistributions in binary form must reproduce the above copyright notice, Once the cable is seated in the port, press the collar back down to lock the
this list of conditions and the following disclaimer in the documentation cable in place. If done properly you should be able to easily lift the Pi by
and/or other materials provided with the distribution. the camera's cable without it falling out. The following illustrations show
a well-seated camera cable with the correct orientation:
* Neither the name of the copyright holder nor the names of its contributors .. image:: good_connection.jpg
may be used to endorse or promote products derived from this software without :width: 640px
specific prior written permission. :align: center
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND Make sure the camera module isn't sat on anything conductive (e.g. the Pi's
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED USB ports or its GPIO pins). Now, apply power to your Pi. Once booted, start
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE the Raspberry Pi Configuration utility and enable the camera module:
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
---------- .. image:: enable_camera.png
:align: center
The :ref:`bayer pattern diagram <bayer_data>` in the documentation is derived You will need to reboot after doing this (but this is one-time setup so you
from `Bayer_pattern_on_sensor.svg`_ which is copyright (c) Colin Burnett won't need to do it again unless you re-install your operating system or switch
(User:Cburnett) on Wikipedia, modified under the terms of the GPL: SD cards). Once rebooted, start a terminal and try the following command::
This work is free software; you can redistribute it and/or modify it under the raspistill -o image.jpg
terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or any later version. This work If everything is working correctly, the camera should start, a preview from the
is distributed in the hope that it will be useful, but without any warranty; camera should appear on the display and, after a 5 second delay it should
without even the implied warranty of merchantability or fitness for a capture an image (storing it as ``image.jpg``) before shutting down the camera.
particular purpose. See version 2 and version 3 of the GNU General Public Proceed to the :ref:`recipes1`.
License for more details.
If something else happens, read any error message displayed and try any
recommendations suggested by such messages. If your Pi reboots as soon as you
run this command, your power supply is insufficient for running your Pi plus
the camera module (and whatever other peripherals you have attached).
----------