Difference between revisions of "Rpi Camera Module"

From eLinux.org
Jump to: navigation, search
m (Change date format - introduce stub sections)
(Improved layout)
Line 9: Line 9:
 
==Sample Programs==
 
==Sample Programs==
  
Sample programs using the camera for taking stills and video have been developed by the Foundation and the source for these is available on [https://github.com/raspberrypi/userland/tree/master/host_applications/linux/apps/raspicam github].
+
Sample programs using the camera for taking stills and video have been developed for the Foundation and the source for these is available on [https://github.com/raspberrypi/userland/tree/master/host_applications/linux/apps/raspicam github].
  
 
Forum user M1M1 published instructions on compiling the sample programs [http://www.raspberrypi.org/phpBB3/viewtopic.php?f=43&t=43990#p350970 here]
 
Forum user M1M1 published instructions on compiling the sample programs [http://www.raspberrypi.org/phpBB3/viewtopic.php?f=43&t=43990#p350970 here]
Line 15: Line 15:
 
The command line parameters for the programs are as follows:
 
The command line parameters for the programs are as follows:
 
<pre>
 
<pre>
RaspiVid   Camera App   
+
RaspiVid Camera App   
 
===================   
 
===================   
 
    
 
    
Display camera output to display, and optionally saves an H264 capture at requested bitrate   
+
Display camera output to display, and optionally saves an H264 capture at requested bitrate   
 
    
 
    
 
    
 
    
Line 25: Line 25:
 
Image  parameter commands   
 
Image  parameter commands   
 
    
 
    
‐?,  ‐‐ help       :  This  help  information   
+
‐?,  ‐‐ help     :  This  help  information   
 
‐w,  ‐‐ width    :  Set image  width <size>.  Default  1920   
 
‐w,  ‐‐ width    :  Set image  width <size>.  Default  1920   
‐h,  ‐‐ height     :  Set image  height  <size>.  Default  1080   
+
‐h,  ‐‐ height   :  Set image  height  <size>.  Default  1080   
‐b,  ‐‐ bitrate     :  Set bitrate. Use bits per second  (e.g.  10MBits/ s would be ‐ b 10000000)   
+
‐b,  ‐‐ bitrate   :  Set bitrate. Use bits per second  (e.g.  10MBits/ s would be ‐ b 10000000)   
‐o,  ‐‐ output     :  Output  filename  <filename>  (to write to  stdout,  use '‐o  ‐ ')   
+
‐o,  ‐‐ output   :  Output  filename  <filename>  (to write to  stdout,  use '‐o  ‐ ')   
‐v,  ‐‐ verbose   :  Output  verbose information  during  run   
+
‐v,  ‐‐ verbose   :  Output  verbose information  during  run   
‐t,  ‐‐ timeout   :  Time (in ms) before  takes picture  and  shuts down.  If  not specified,  set to  5s   
+
‐t,  ‐‐ timeout   :  Time (in ms) before  takes picture  and  shuts down.  If  not specified,  set to  5s   
‐d,  ‐‐ demo       :  Run  a  demo mode (cycl e  through range of  camera options, no capture)   
+
‐d,  ‐‐ demo     :  Run  a  demo mode (cycl e  through range of  camera options, no capture)   
 
‐fps,  ‐‐ framerate        :  Specify  the  frames  per second  to  record   
 
‐fps,  ‐‐ framerate        :  Specify  the  frames  per second  to  record   
‐e,  ‐‐ penc       :  Display  preview image  *after*  encoding  (shows  compression artifacts)   
+
‐e,  ‐‐ penc     :  Display  preview image  *after*  encoding  (shows  compression artifacts)   
 
    
 
    
 
Preview parameter commands   
 
Preview parameter commands   
 
    
 
    
‐p,  ‐‐ preview   :  Preview window settings <'x,y,w,h'>   
+
‐p,  ‐‐ preview   :  Preview window settings <'x,y,w,h'>   
‐f,  ‐‐ fullscreen         :  Fullscreen preview mode   
+
‐f,  ‐‐ fullscreen:  Fullscreen preview mode   
 
‐n,  ‐‐ nopreview :  Do not  display  a  preview window   
 
‐n,  ‐‐ nopreview :  Do not  display  a  preview window   
 
    
 
    
 
Image  parameter commands   
 
Image  parameter commands   
 
    
 
    
‐sh, ‐‐ sharpness         :  Set image  sharpness ( ‐100  to  100)   
+
‐sh, ‐‐ sharpness :  Set image  sharpness ( ‐100  to  100)   
‐co, ‐‐ contrast :  Set image  contrast ( ‐100  to  100)   
+
‐co, ‐‐ contrast :  Set image  contrast ( ‐100  to  100)   
‐br, ‐‐ brightness       :  Set image  brightness (0  to  100)   
+
‐br, ‐‐ brightness:  Set image  brightness (0  to  100)   
‐sa, ‐‐ saturation       :  Set image  saturation ( ‐100  to  100)   
+
‐sa, ‐‐ saturation:  Set image  saturation ( ‐100  to  100)   
‐ISO,  ‐‐ ISO     :  Set capture ISO   
+
‐ISO,  ‐‐ ISO     :  Set capture ISO   
 
‐vs, ‐‐ vstab    :  Turn  on  video stablisation   
 
‐vs, ‐‐ vstab    :  Turn  on  video stablisation   
‐ev, ‐‐ ev         :  Set EV com pensation   
+
‐ev, ‐‐ ev       :  Set EV com pensation   
 
‐ex, ‐‐ exposure  :  Set exposure  mode (see  Notes)   
 
‐ex, ‐‐ exposure  :  Set exposure  mode (see  Notes)   
‐awb,  ‐‐ awb     :  Set AWB mode (see  Notes)   
+
‐awb,  ‐‐ awb     :  Set AWB mode (see  Notes)   
 
‐ifx, ‐‐ imxfx    :  Set image  effect (see  Notes)   
 
‐ifx, ‐‐ imxfx    :  Set image  effect (see  Notes)   
‐cfx, ‐‐ colfx     :  Set colour  effect (U:V)   
+
‐cfx, ‐‐ colfx   :  Set colour  effect (U:V)   
 
‐mm,  ‐‐ metering :  Set metering  mode (see  Notes)   
 
‐mm,  ‐‐ metering :  Set metering  mode (see  Notes)   
‐rot,  ‐‐ rotation         :  Set image  rotation (0 ‐359)   
+
‐rot,  ‐‐ rotation:  Set image  rotation (0 ‐359)   
‐hf, ‐‐ hflip     :  Set horizontal flip   
+
‐hf, ‐‐ hflip     :  Set horizontal flip   
‐vf, ‐‐ vflip     :  Set vertical  flip   
+
‐vf, ‐‐ vflip     :  Set vertical  flip   
 
    
 
    
 
    
 
    
Line 70: Line 70:
 
    
 
    
 
Image  Effect mode options :   
 
Image  Effect mode options :   
none,negative,solarise,sketch,denoise,emboss,oilpaint,h atch,gpen,pastel,watercolour,film,blur,saturation,col
+
none,negative,solarise,sketch,denoise,emboss,oilpaint,h atch,gpen,pastel,watercolour,film,blur,saturation,colourswap,washedout,posterise,colourpoint,colourbalance,cartoon   
ourswap,washedout,posterise,colourpoint,colourbalance,cartoon   
 
 
    
 
    
 
Metering Mode options  :   
 
Metering Mode options  :   
Line 78: Line 77:
  
 
<pre> 
 
<pre> 
RaspiStill   Camera  App  
+
RaspiStill Camera App  
 
===================== 
 
===================== 
 
 
 
 
Runs  camera for specific time, and  take  JPG  capture at  end  if  requested 
+
Runs camera for specific time, and take JPG capture at end if requested 
 
 
 
 
 
usage:  RaspiStill  [options]  
 
usage:  RaspiStill  [options]  
Line 87: Line 86:
 
Image  parameter commands  
 
Image  parameter commands  
 
 
 
 
‐?,  ‐‐ help        :  This  help  information  
+
‐?,  ‐‐ help      :  This  help  information  
 
‐w,  ‐‐ width     :  Set image  width <size>  
 
‐w,  ‐‐ width     :  Set image  width <size>  
‐h,  ‐‐ height      :  Set image  height  <size>  
+
‐h,  ‐‐ height    :  Set image  height  <size>  
‐q,  ‐‐ quality     :  Set jpeg  quality  <0 to  100> 
+
‐q,  ‐‐ quality   :  Set jpeg  quality  <0 to  100> 
‐r,  ‐‐ raw         :  Add  raw  bayer data  to  jpeg  metadata 
+
‐r,  ‐‐ raw       :  Add  raw  bayer data  to  jpeg  metadata 
‐o,  ‐‐ output      :  Output  filename  <filename>  (to write to  stdout,  use '‐o  ‐ ').  If  not specified,  no file is  saved 
+
‐o,  ‐‐ output    :  Output  filename  <filename>  (to write to  stdout,  use '‐o  ‐ ').  If  not specified,  no file is  saved 
‐v,  ‐‐ verbose    :  Output   verbose information  during  run  
+
‐v,  ‐‐ verbose   :  Output   verbose information  during  run  
‐t,  ‐‐ timeout    :  Time (in ms) before  takes picture  and  shuts down (if  not specified,  set to  5s) 
+
‐t,  ‐‐ timeout   :  Time (in ms) before  takes picture  and  shuts down (if  not specified,  set to  5s) 
‐th, ‐‐ thumb      :  Set thumbnail parameters  (x:y:quality)  
+
‐th, ‐‐ thumb     :  Set thumbnail parameters  (x:y:quality)  
‐d,  ‐‐ demo       :  Run  a  demo mode (cycle  through range of  camera options, no capture)  
+
‐d,  ‐‐ demo      :  Run  a  demo mode (cycle  through range of  camera options, no capture)  
‐e,  ‐‐ encoding    :  Encoding  to  use for output  file (jpg,  bmp, gif, png)  
+
‐e,  ‐‐ encoding  :  Encoding  to  use for output  file (jpg,  bmp, gif, png)  
‐x,  ‐‐ exif       :  EXIF  tag to   apply to  captures  (forma t as  'key=value')  
+
‐x,  ‐‐ exif      :  EXIF  tag to   apply to  captures  (forma t as  'key=value')  
‐tl,  ‐‐ timelapse          :   Timelapse mode. Takes a  picture  every <t>ms  
+
‐tl,  ‐‐ timelapse:   Timelapse mode. Takes a  picture  every <t>ms  
 
 
 
 
 
Preview parameter commands  
 
Preview parameter commands  
 
 
 
 
‐p,  ‐‐ preview    :  Preview window settings <'x,y,w,h'> 
+
‐p,  ‐‐ preview   :  Preview window settings <'x,y,w,h'> 
‐f,  ‐‐ fullscreen          :  Fullscreen preview mode 
+
‐f,  ‐‐ fullscreen:  Fullscreen preview mode 
 
‐n,  ‐‐ nopreview :  Do not  display  a  preview window 
 
‐n,  ‐‐ nopreview :  Do not  display  a  preview window 
 
 
 
 
 
Image  parameter commands  
 
Image  parameter commands  
 
 
 
 
‐sh, ‐‐ sharpness         :  Set image  sharpness ( ‐100  to  100)  
+
‐sh, ‐‐ sharpness :  Set image  sharpness ( ‐100  to  100)  
‐co, ‐‐ contrast :  Set imag e  contrast ( ‐100  to  100)  
+
‐co, ‐‐ contrast  :  Set imag e  contrast ( ‐100  to  100)  
‐br, ‐‐ brightness        :  Set image  brightness (0  to   100)  
+
‐br, ‐‐ brightness:  Set image  brightness (0  to   100)  
‐sa, ‐‐ saturation        :  Set image  saturation ( ‐100  to  100)  
+
‐sa, ‐‐ saturation:  Set image  saturation ( ‐100  to  100)  
‐ISO,  ‐‐ ISO      :  Set capture ISO  
+
‐ISO,  ‐‐ ISO     :  Set capture ISO  
 
‐vs, ‐‐ vstab     :  Turn  on  video stablisation  
 
‐vs, ‐‐ vstab     :  Turn  on  video stablisation  
‐ev, ‐‐ ev         :  Set EV com pensation 
+
‐ev, ‐‐ ev        :  Set EV com pensation 
 
‐ex, ‐‐ exposure  :  Set exposure  mode (see  Notes)  
 
‐ex, ‐‐ exposure  :  Set exposure  mode (see  Notes)  
‐awb,  ‐‐ awb      :  Set AWB mode (see  Notes)  
+
‐awb,  ‐‐ awb     :  Set AWB mode (see  Notes)  
 
‐ifx, ‐‐ imxfx    :  Set image  effect (see  Notes)  
 
‐ifx, ‐‐ imxfx    :  Set image  effect (see  Notes)  
‐cfx, ‐‐ colfx     :  Set colour  effect (U:V) 
+
‐cfx, ‐‐ colfx    :  Set colour  effect (U:V) 
 
‐mm,  ‐‐ metering :  Set metering mode (see  Notes)  
 
‐mm,  ‐‐ metering :  Set metering mode (see  Notes)  
‐rot,  ‐‐ rotation         :  Set image  rotation (0 ‐359)  
+
‐rot,  ‐‐ rotation:  Set image  rotation (0 ‐359)  
‐hf, ‐‐ hflip      :  Set horizontal flip 
+
‐hf, ‐‐ hflip     :  Set horizontal flip 
‐vf, ‐‐ vflip      :  Set vertical  flip 
+
‐vf, ‐‐ vflip     :  Set vertical  flip 
 
 
 
 
 
 
 
 
Line 135: Line 134:
 
 
 
 
 
Image  Effect mode options :  
 
Image  Effect mode options :  
none,negative,solarise,sketch,denoise,emboss,oilpaint,h atch,gpen,pastel,watercolour,film,blur,saturation,col
+
none,negative,solarise,sketch,denoise,emboss,oilpaint,h atch,gpen,pastel,watercolour,film,blur,saturation,colourswap,washedout,posterise,colourpoint,colourbalance,cartoon 
ourswap,washedout,posterise,colourpoint,colourbalance,cartoon 
 
 
 
 
 
 
Metering Mode options  :  
 
Metering Mode options  :  
 
average,spot,backlit,matrix 
 
average,spot,backlit,matrix 
 
</pre>
 
</pre>
 +
 
==Known Issues==
 
==Known Issues==
  

Revision as of 04:37, 23 May 2013


RaspPi.png Back to the Hub


Hardware & Peripherals:

Hardware - detailed information about the Raspberry Pi boards.

Hardware History - guide to the Raspberry Pi models.

Low-level Peripherals - using the GPIO and other connectors.

Expansion Boards - GPIO plug-in boards providing additional functionality.

Screens - attaching a screen to the Raspberry Pi.

Cases - lots of nice cases to protect the Raspberry Pi.

Other Peripherals - all sorts of peripherals used with the Raspberry Pi.


Introduction

The Raspberry Pi Camera board was released for sale on 14th May 2013. It contains a 5MPixel sensor and connects via a ribbon cable to the CSI connector on the board.

Sample Programs

Sample programs using the camera for taking stills and video have been developed for the Foundation and the source for these is available on github.

Forum user M1M1 published instructions on compiling the sample programs here

The command line parameters for the programs are as follows:

RaspiVid Camera App   
===================  
  
Display camera output to display, and optionally saves an H264 capture at requested bitrate   
  
  
usage:  RaspiVid [options]   
  
Image  parameter commands   
  
‐?,  ‐‐ help      :  This  help  information   
‐w,  ‐‐ width     :  Set image  width <size>.  Default  1920  
‐h,  ‐‐ height    :  Set image  height  <size>.  Default  1080  
‐b,  ‐‐ bitrate   :  Set bitrate. Use bits per second  (e.g.   10MBits/ s would be ‐ b 10000000)  
‐o,  ‐‐ output    :  Output  filename  <filename>  (to write to  stdout,  use '‐o  ‐ ')   
‐v,  ‐‐ verbose   :  Output   verbose information  during  run   
‐t,  ‐‐ timeout   :  Time (in ms) before  takes picture  and  shuts down.   If  not specified,  set to  5s   
‐d,  ‐‐ demo      :  Run  a  demo mode (cycl e  through range of  camera options, no capture)   
‐fps,  ‐‐ framerate        :  Specify  the  frames  per second  to  record   
‐e,  ‐‐ penc      :  Display  preview image  *after*  encoding  (shows  compression artifacts)   
  
Preview parameter commands   
  
‐p,  ‐‐ preview   :  Preview window settings <'x,y,w,h'>  
‐f,  ‐‐ fullscreen:  Fullscreen preview mode  
‐n,  ‐‐ nopreview :  Do not  display  a  preview window  
  
Image  parameter commands   
  
‐sh, ‐‐ sharpness :  Set image  sharpness ( ‐100  to  100)   
‐co, ‐‐ contrast  :  Set image  contrast ( ‐100  to  100)   
‐br, ‐‐ brightness:  Set image  brightness (0  to   100)   
‐sa, ‐‐ saturation:  Set image  saturation ( ‐100  to  100)   
‐ISO,  ‐‐ ISO     :  Set capture ISO   
‐vs, ‐‐ vstab     :  Turn  on  video stablisation   
‐ev, ‐‐ ev        :  Set EV com pensation  
‐ex, ‐‐ exposure  :  Set exposure  mode (see  Notes)   
‐awb,  ‐‐ awb     :  Set AWB mode (see  Notes)   
‐ifx, ‐‐ imxfx    :  Set image  effect (see  Notes)   
‐cfx, ‐‐ colfx    :  Set colour  effect (U:V)  
‐mm,  ‐‐ metering :  Set metering  mode (see  Notes)   
‐rot,  ‐‐ rotation:  Set image  rotation (0 ‐359)   
‐hf, ‐‐ hflip     :  Set horizontal flip  
‐vf, ‐‐ vflip     :  Set vertical  flip  
  
  
Notes  
  
Exposure  mode options  :   
off,auto,night,nightpreview,backlight,spotlight,sports,snow,beach,verylong,fixedfps,antishake,fireworks   
  
AWB mode options :   
off,auto,sun,cloud,shade,tungsten,fluorescent,incandescent,flash,horizon   
  
Image  Effect mode options :   
none,negative,solarise,sketch,denoise,emboss,oilpaint,h atch,gpen,pastel,watercolour,film,blur,saturation,colourswap,washedout,posterise,colourpoint,colourbalance,cartoon  
  
Metering Mode options  :   
average,spot,backlit,matrix 
 
RaspiStill Camera App  
===================== 
 
Runs camera for specific time, and take JPG capture at end if requested 
 
usage:  RaspiStill  [options]  
 
Image  parameter commands  
 
‐?,  ‐‐ help      :  This  help  information  
‐w,  ‐‐ width     :  Set image  width <size>  
‐h,  ‐‐ height    :  Set image  height  <size>  
‐q,  ‐‐ quality   :  Set jpeg  quality  <0 to  100> 
‐r,  ‐‐ raw       :  Add  raw  bayer data  to  jpeg  metadata 
‐o,  ‐‐ output    :  Output  filename  <filename>  (to write to  stdout,  use '‐o  ‐ ').  If  not specified,  no file is  saved 
‐v,  ‐‐ verbose   :  Output   verbose information  during  run  
‐t,  ‐‐ timeout   :  Time (in ms) before  takes picture  and  shuts down (if  not specified,  set to  5s) 
‐th, ‐‐ thumb     :  Set thumbnail parameters  (x:y:quality)  
‐d,  ‐‐ demo      :  Run  a  demo mode (cycle  through range of  camera options, no capture)  
‐e,  ‐‐ encoding  :  Encoding  to  use for output  file (jpg,  bmp, gif, png)  
‐x,  ‐‐ exif      :  EXIF  tag to   apply to  captures  (forma t as  'key=value')  
‐tl,  ‐‐ timelapse:   Timelapse mode. Takes a  picture  every <t>ms  
 
Preview parameter commands  
 
‐p,  ‐‐ preview   :  Preview window settings <'x,y,w,h'> 
‐f,  ‐‐ fullscreen:  Fullscreen preview mode 
‐n,  ‐‐ nopreview :  Do not  display  a  preview window 
 
Image  parameter commands  
 
‐sh, ‐‐ sharpness :  Set image  sharpness ( ‐100  to  100)  
‐co, ‐‐ contrast  :  Set imag e  contrast ( ‐100  to  100)  
‐br, ‐‐ brightness:  Set image  brightness (0  to   100)  
‐sa, ‐‐ saturation:  Set image  saturation ( ‐100  to  100)  
‐ISO,  ‐‐ ISO     :  Set capture ISO  
‐vs, ‐‐ vstab     :  Turn  on  video stablisation  
‐ev, ‐‐ ev        :  Set EV com pensation 
‐ex, ‐‐ exposure  :  Set exposure  mode (see  Notes)  
‐awb,  ‐‐ awb     :  Set AWB mode (see  Notes)  
‐ifx, ‐‐ imxfx    :  Set image  effect (see  Notes)  
‐cfx, ‐‐ colfx    :  Set colour  effect (U:V) 
‐mm,  ‐‐ metering :  Set metering mode (see  Notes)  
‐rot,  ‐‐ rotation:  Set image  rotation (0 ‐359)  
‐hf, ‐‐ hflip     :  Set horizontal flip 
‐vf, ‐‐ vflip     :  Set vertical  flip 
 
 
Notes 
 
Exposure  mode options  :  
off,auto,night,nightpreview,backlight,spotlight,sports,snow,beach,verylong,fixedfps,antishake,fireworks  
 
AWB mode options :  
off,auto,sun,cloud,shade,tungsten,fluorescent,incandescent,flash,horizon  
 
Image  Effect mode options :  
none,negative,solarise,sketch,denoise,emboss,oilpaint,h atch,gpen,pastel,watercolour,film,blur,saturation,colourswap,washedout,posterise,colourpoint,colourbalance,cartoon 
 
Metering Mode options  :  
average,spot,backlit,matrix 

Known Issues

  • It is believed that still captures are not using the full sensor.
  • Some users have noted that images are 'flipped', this can be corrected by use of the -hf and -vf command line flags. This behaviour may be addressed in future foundation releases.
  • Correct EXIF data (including user supplied tags) are not being written to the output files.

Troubleshooting

Customizing

Changing the ribbon cable

Macro lenses