Difference between revisions of "Main Page"

Revision as of 07:52, 8 January 2011

Welcome to the OpenKinect project

About

OpenKinect is an open community of people interested in making use of the amazing Xbox Kinect hardware with our PCs and other devices. We are working on free, open source libraries that will enable the Kinect to be used with Windows, Linux, and Mac.

Currently, our primary focus is the libfreenect software.

Source code is available here: https://github.com/OpenKinect/libfreenect

Get started right away by installing the software to your platform.

Communications

If you want to participate or just watch the progress of the OpenKinect effort, subscribe to the OpenKinect mailing list. In the application form, please tell us something about yourself and you'll be approved automatically. You could also subscribe to a low-traffic announcement-only mailing list.

You can follow us on Twitter @openkinect.Please use the #tag #openkinect when tweeting your work.

You can meet people in your area working on OpenKinect through Meetup Groups:

You can also chat with people developing on OpenKinect software on IRC: #OpenKinect on irc.freenode.net or using this web based chat. Channel logs (daily rotation) can be found here.

Project information

Project Roadmap

The current roadmap for the project (libfreenect, OpenKinect Processing library, and Openkinect apps)...

Project Policies

The official name of the project, license, contribution policy, coordination between developers, and decision making...

Project History

A few key dates and milestones...

Contributing Code - How to contribute code

Official repositories, use of a fork and Openkinect source header, signing off, submissions and evaluation...

Contributing - There many ways to contribute besides coding

Testing, administrative tasks, support related tasks, documentation, collaboration etc.

Code Integration - How to deal with how we use git

Repository policy, git usage, workflows, how to start development and keep up to date, and the integration process...

Installation - How to download, build and install OpenKinect

Requirements and steps to install on Linux, OS X and Windows, user contributed guides...

People - Who is doing what

Project leader, maintainers, and who is doing what in the OpenKinect project...

Gallery - Videos and links to things people are doing with OpenKinect

Demos and solutions using OpenKinect...

FAQ

Frequently asked questions...

Project Logo

Logo specifications...

Project Ideas

Ideas and concepts to explore using OpenKinect...

API Documentation

High Level - High-level API documentation

Wrappers

Python
C Synchronous - Provides functions to get data instead of callbacks
Actionscript
C++
C#
Java JNI
Java JNA
Javascript
Common Lisp - Getting started with libfreenect on Common Lisp

Utilities

Record - Dumps Kinect data to PPM, PGM, and a bin dump for RGB, Depth, and Accel respectively.
Fakenect - libfreenect simulator/mock interface that lets you use the kinect demos without having a kinect (plays back data from Record)

Knowledge base

Reference design - US Patent Application "Depth mapping using projected patterns"
NUI Camera DSP - Camera DSP, architecture, instruction set, firmware, and capabilities
lsusb output - Device identifier output
USB Devices - Overview of the hardware devices
Protocol Documentation - General information about the Kinect USB procotol
USB Protocol Information - Other information about the Kinect USB protocol
Init Analysis - Messing with various init sequences
Imaging Information - Information about the imaging data returned by the Kinect
Research Material - Research material for software layer implementation
Hardware_info - Hardware information
Calibration - Gathering information for including calibration facilities

Links

OpenNI

http://openni.org - Open Natural Interaction, an industry-led, not-for-profit organization formed to certify and promote the compatibility and interoperability of Natural Interaction (NI) devices, applications and middleware.
http://github.com/openni - Open source framework for natural interaction devices
http://github.com/PrimeSense/Sensor - Open source driver for the PrimeSensor Development Kit

Comment Threads

http://ladyada.net/learn/diykinect/ - How the Kinect was hacked very detailed overview of what was involved
http://www.adafruit.com/blog/2010/11/04/the-open-kinect-project-the-ok-prize-get-1000-bounty-for-kinect-for-xbox-360-open-source-drivers/ - Adafruit's competition. Comment thread contains list of some of the people working on this.
http://hackaday.com/2010/11/04/kilobuck-open-kinect-project-prize/ - Hackaday's coverage of the bounty. Again, interesting comment thread.

Tech

http://www.ifixit.com/Teardown/Microsoft-Kinect-Teardown/4066/ - Hardware teardown. Chip info is here. (via adafruit)
http://kinecthacks.net/kinect-pinout/ - Pinout info of the Kinect Sensor
http://www.primesense.com/?p=535 - Primesense reference implementation (via adafruit thread)
http://www.sensorland.com/HowPage090.html - How sensors work and the bayer filter
http://nvie.com/posts/a-successful-git-branching-model/ - Model for branching within Git
http://www.numenta.com/htm-overview/education/HTM_CorticalLearningAlgorithms.pdf - Suggestions to implement pseudocode near the end
http://www.dwheeler.com/essays/floss-license-slide.html Which licenses are compatible with which
http://www.eetimes.com/design/signal-processing-dsp/4211071/Inside-Xbox-360-s-Kinect-controller - Another Hardware Teardown. Note this article incorrectly states that the PS1080 talks to the Marvell chip.

Kinect Themed sites

http://www.reddit.com/r/openkinect/ OpenKinect news and discussion community
http://www.kinectHacks.net - Kinect hacking blog and forum
http://www.freenect.com/ - Kinect hacking news
http://www.modmykinect.com - The innovation begins.
http://www.Bodensee-Deal.de/ - Kinect hacking news in German
http://www.kinectxbox360.es/ - Novedades, hacks y juegos de kinect en español.

Random

Linux contribution procedure http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob;f=Documentation/SubmittingPatches
Git project contribution procedure http://git.kernel.org/?p=git/git.git;a=blob_plain;f=Documentation/SubmittingPatches;hb=HEAD

@@ Line 6: / Line 6: @@
 == About ==
-OpenKinect is an open community of people interested in making use of the amazing Xbox Kinect hardware with our PCs and other devices. We are working on free, open source libraries that will enable the Kinect to be used with Windows, Linux, and Mac.
+'''OpenKinect''' is an open community of people interested in making use of the amazing Xbox Kinect hardware with our PCs and other devices. We are working on free, open source libraries that will enable the Kinect to be used with Windows, Linux, and Mac.
-Some general information about how Kinect works can be found in [http://www.freepatentsonline.com/20100118123.pdf this document].
+Currently, our primary focus is the '''libfreenect''' software.
-Source code is available here: https://github.com/OpenKinect/libfreenect
+* Source code is available here: https://github.com/OpenKinect/libfreenect
-Get started right away by [[Getting Started|installing]] the software to your platform.
+* Get started right away by [[Getting Started|installing]] the software to your platform.
 == Communications ==
@@ Line 77: / Line 77: @@
 == Knowledge base ==
+* [http://www.freepatentsonline.com/20100118123.pdf Reference design] - US Patent Application "Depth mapping using projected patterns"
 * [[Camera_DSP|NUI Camera DSP]] - Camera DSP, architecture, instruction set, firmware, and capabilities
 * [[lsusb output]] - Device identifier output
@@ Line 87: / Line 88: @@
 * [[Hardware_info]] - Hardware information
 * [[Calibration]] - Gathering information for including calibration facilities
 == Links ==