VRmagic VrmUsbCam Version 3.13c for Linux ===================================================== (c) VRmagic GmbH, 2003-2010 1.Description: This package includes: 1. VRmagic VRmUsbCam API v2 2. VRmagic CamLab (Camera Application) 3. Demo applications for VrmUsbCam API 4. Hotplug helper binary and udev rules file 5. Install/Uninstall scripts 6. VRmagic CamServer 2.Release Date: 06/02/2010 3.Revision Numbers: VRmagic USB Camera Development Kit 3.13c includes: 1. VRmagic VRmUsbCam C API: 2.7.2.3 2. VRmagic CamLab: 2.7.2.3 3. VRmagic CamServer: 2.7.2.3 4.Hardware Requirements: System: PC with Intel Pentium or AMD Athlon, >500MHz USB Host Controller: VRmC-x family and VRmAVC-1 require USB 2.0 (EHCI) USB 1.0 (OHCI) and USB 1.1 (UHCI) Controllers are NOT supported! VRmDC-x family support streaming over ethernet using TCP and UDP. IMPORTANT: The support for Ethernet devices is disabled by default (in CamLab as well as in the library). To enable it you have to run the "vrm_ethernet_enable.sh" script. 5.Supported Operating Systems: x86 Linux with usbfs support and optionally udev for hotplug functionality 6.Development Platforms: GCC 4.x, libstdc++.so.6 SDL library including devel packets 7.Directory Layout & Contents: vrmusbcam-3.13c |-camlab |-vrmcamserver |-demos | |-deviceinfo | |-restorefactorydefaults | |-sdlviewer |-docs |-include |-lib |-setup.linux |-udev |-etc camlab: camlab application demos/sdl: demo application displaying the camera pictures in an SDL widget docs: pdf containing vrmusbcam API documentation include: include file for using the shared library lib: the shared library setup.linux: setup scripts, hotplug helper and ethernet enable/disalbe scripts udev: udev rules file which invokes the hotplug helper etc: potential contents of /etc/vrmagic 8.Installation: execute the following as root: > cd vrmusbcam-3.13c/setup.linux > ./vrmusbcam-install vrmusbcam-install does the following: - install udev.rule file - install shared library (libvrmusbcam.so.* in /usr/local/lib/) - install camlab & vrmhotplug (/usr/local/bin) - install FPGA progam files (/usr/local/share/VRmagic/fpgaprogramfiles/) You have to make sure that usbfs is mounted with appropriate permissions! Add the following line to /etc/fstab to enable usbfs for every user: usbfs /proc/bus/usb usbfs auto,devmode=0666 0 0 9.De-Installation: execute the following as root: > vrmusbcam-uninstall vrmusbcam-uninstall does the following - remove udev rules file - remove the shared lib - remove the binaries It is up to you, to unmount /proc/bus/usb if you desire. 10.CamLab Application: CamLab is a GUI Application to test and setup different camera settings, it can be found in the camlab directory of the setup package. After running the install script it will be also located in /usr/local/bin The load/save buttons access the user settings which can be stored on the device, the defaults button returns to their factory defaults. The application also writes a log file, which resides in /tmp. 11.Demo Application NOTE: packages sdl & sdl-devel are needed for building NOTE: vrmusbcamdemo can only be quit by ESC build demo application: > cd demos/sdl > make > ./vrmusbcamdemo 12.Known Limitations: - USB 1.0 (OHCI) and USB 1.1 (UHCI) Controllers are currently NOT supported! - images received from a VRmagic Ethernet camera show some fixed color marks - the frame counter is not working properly when receiving images from a VRmagic Ethernet camera 13.History: Version 3.13c (06/02/2010) added possiblity to redetect the video standard of VRmAVC-1(+S/+I) in CamLab improved deserializer of Multi-Sensor Camera Version 3.13b (05/11/2010) added support for VRmAVC-1+I added support for selection of TFF/ BFF formats to VRm(F)AVC-1 (might require a firmware update) Version 3.13a (04/16/2010) fixed minor documentation issues Version 3.13 (04/14/2010) added support for Multi-Sensor Camera (VRmMFC+VRmMSC-12) added support for ethernet receiving added support for VRmAVC-1+S added support for VRmSM-1 added possibility to lock mutiple images of host ring buffer increased usability of CamLab added CamServer application for ethernet transmission Version 3.12h (07/06/2009) built without GCC Stack Protector fixed timing changes in freerunning sequential mode fixed trigger timeout for VRmFC-x devices fixed maximal pixel clock for VRmFC-6 Version 3.12g (05/06/2009) added support for binning modes to VRm(F)C-12/BW added support for overclocking to VRmC-3+ and VRm(F)C-12 added support for external sensor models of VRmFC-12 added auto pixel clock for VRmFC-6 Version 3.12f (12/18/2008) added support for external sensor models of VRmC-12 added support for TTL trigger/strobe of VRmC-8+/VRmC-9+ Rev 1.1 added channel balance plugin to improve image quality of VRmC-9(+) fixed maximum value of trigger timeout property reduced jitter for VRmFC-x cameras Version 3.12e (11/12/2008) added property for roi of auto exposure, with default = center 1/9 of image Version 3.12d (10/21/2008) added support for VRmC-9+ fixed incompatibility of VRmUsbCamDS with Adobe Flash Media Encoder Version 3.12c (08/22/2008) added support for synchronized free-running grabbing mode (VRmC-12) (might require a firmware update) Version 3.12b (08/20/2008) fixed auto-white balance that was accidentally disabled Version 3.12a (07/30/2008) added support for VRmC-8+ added subsampling, auto-exposure and optimized 10bit evaluation for VRmFC-x cameras Version 3.12 (06/26/2008) added hotplug capability now using usbfs fixed problem of unlit images in free-running and soft/edge triggered modes added uninstall script Version 3.11 (08/01/2007) added support for VRmFC-4, VRmFC-8, VRmFC-9, VRmFC-12 added RLE compressed source format for VRmFC-x added device callback (C) and events (COM, .NET) fixed user roi of VRmC-3+ and VRmC-12 Version 3.10 (12/14/2006) added support for VRmFAVC-1 added support for VRmCI enhanced user configs to support 9 different ids added user preferences to CamLab Version 3.9a (09/18/2006) added VRmUsbCamIsFirmwareCompressionRequired added device info box to CamLab Version 3.9 (09/12/2006) added image analysis plugin (chessboard + concentric marker) added defective pixel management (DPM) added property for "images ready in host ringbuffer" Version 3.8 (07/20/2006) improved precision of strobe output and trigger timeout (might require a firmware update) added free-running sequential mode added support for VRmC-3+(/BW) added blacklevel property to filter adjustable pixel clock for VRmC-12 (5 to 26.6 MHz) fixed VRmUsbCamReloadUserSettings Version 3.7 (05/25/2006) added property based configuration interface addded support for VRmC-9/BW and VRmC-12(/BW) added properties for converter (flips, BayerHQ, prefer gray), multi channel filter settings (R/G/B), plugins for auto exposure, auto white balance and auto reset level calibration (for VRmC-3 and VRmC-4) added frame counter information to image fixed negative luminance values fixed detection of some VRmC-4pro(/BW) v1 cameras fixed user roi of VRmC-6pro and VRmC-8pro fixed gains in VRmUsbCamGetSettings8 completed support for VRmC-8pro added shutter config (might require a firmware update) added trigger timeout added user data storage (in eeprom) improved user roi handling added YUYV as target format to image converter added config gui to VRmUsbCamDS added frequency adjustment for VRmAVC-1 Version 3.5.1 (07/18/2005) fixed wrong MODVERSIONS in 2.4.26 driver Version 3.5.0 (05/30/2005) added optional High-Quality Bayer Filter added basic support for VRmC-8pro improved installation of linux driver module Version 3.4.0 (05/12/2005) fixed several linux driver bugs that occasionally lead to system freezes, added soft trigger (might require a firmware update), added source format to load/save settings fixed VRmUsbCamCopyImage() function of C API Version 3.3.0 (03/18/2005) added support for VRmC-4pro v2 and VRmC-6pro, added trigger control to C AND .NET API, enhanced C API implementation for thread safety, Version 3.2.0 (09/10/2004) Initial Public Release for Linux. Note: pre-release versions had the shared-lib version set to the distribution version (e.g. libvrmusbcam.so.3.2.0pre). This has now been changed to reflect the API version (i.e. libvrmusbcam.so.2.1.0 currently)