Notice: MediaWiki has been updated. Report any rough edges to marcan@marcan.st

Difference between revisions of "Main Page"

From OpenKinect
Jump to: navigation, search
 
(13 intermediate revisions by 6 users not shown)
Line 3: Line 3:
  
 
'''Welcome to the OpenKinect project'''
 
'''Welcome to the OpenKinect project'''
 
+
{{Languages}}
 
== About ==
 
== About ==
  
Line 22: Line 22:
 
*You can follow us on ''Twitter'' [http://twitter.com/openkinect @openkinect]. Please use the #tag #openkinect when tweeting your work.
 
*You can follow us on ''Twitter'' [http://twitter.com/openkinect @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 meet people in your area working on OpenKinect through [[Meetup_Groups|''Meetup Groups'']]:
 
** [http://meetup.com/OpenKinect NYC]  
 
** [http://meetup.com/OpenKinect NYC]  
 
** [http://qccolab.com QC-Colab Davenport, IA]  
 
** [http://qccolab.com QC-Colab Davenport, IA]  
Line 34: Line 34:
 
* '''[[Roadmap|Project Roadmap]]''' - The current roadmap for the project (libfreenect, analysis library, and applications)
 
* '''[[Roadmap|Project Roadmap]]''' - The current roadmap for the project (libfreenect, analysis library, and applications)
 
* '''[[People]]''' - Who is doing what: project leader, maintainers, contributors etc.
 
* '''[[People]]''' - Who is doing what: project leader, maintainers, contributors etc.
* '''[[History|Project History]]''' - A few key dates and milestones
+
* '''[[History|Project History]]''' - The bounty, key dates and milestones
 
* '''[[Policies|Project Policies]]''' -  The official name of the project, license, contribution policy, developers coordination and decision making
 
* '''[[Policies|Project Policies]]''' -  The official name of the project, license, contribution policy, developers coordination and decision making
 
* '''[[Getting Started|Installation]]''' - How to download, build and install on Linux, OS X and Windows
 
* '''[[Getting Started|Installation]]''' - How to download, build and install on Linux, OS X and Windows
Line 41: Line 41:
 
* '''[[Contributing]]''' - There are many ways to contribute: testing, administrative tasks, support related, documentation, collaboration etc.
 
* '''[[Contributing]]''' - There are many ways to contribute: testing, administrative tasks, support related, documentation, collaboration etc.
 
* '''[[FAQ]]''' - Frequently asked questions
 
* '''[[FAQ]]''' - Frequently asked questions
 +
* '''[[Documentation]]''' - Documenation
 
* '''[[Project_ideas|Project Ideas]]''' - Ideas and concepts to explore using OpenKinect
 
* '''[[Project_ideas|Project Ideas]]''' - Ideas and concepts to explore using OpenKinect
* '''[[Gallery]]''' - Videos and links to things people are doing with OpenKinect
+
* '''[[Gallery|Gallery and websites]]''' - Videos and links to things people are doing with OpenKinect
* '''[[Logo_Proposals|Project Logo]]''' - Logo specifications
+
* '''[[Official_Logos|Official Logos]]''' - Official OpenKinect logos for use in your projects
  
 
== API Documentation ==
 
== API Documentation ==
  
 
* [[High Level]] - High-level API documentation
 
* [[High Level]] - High-level API documentation
 +
* [[Low Level]] - Low-level API documentation
  
 
== Wrappers ==
 
== Wrappers ==
Line 60: Line 62:
 
* [[Javascript_Wrapper|Javascript]]
 
* [[Javascript_Wrapper|Javascript]]
 
* [[Getting_Started_With_Common_Lisp|Common Lisp]] - Getting started with libfreenect on Common Lisp
 
* [[Getting_Started_With_Common_Lisp|Common Lisp]] - Getting started with libfreenect on Common Lisp
 +
* [[GLib_Wrapper|GFreenect (GLib)]] - Use Freenect from GLib. Also provides GObject Introspection which means automatic bindings for many other languages (Python, Javascript, Vala)
  
 
== Utilities ==
 
== Utilities ==
Line 68: Line 71:
 
== Knowledge base ==
 
== Knowledge base ==
  
 +
* '''[[Protocol Documentation]]''' - Kinect USB procotol, structures and hardware control commands for the cameras, motor, LED and audio
 
* [http://www.freepatentsonline.com/20100118123.pdf Reference design] - US Patent Application "Depth mapping using projected patterns"
 
* [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
 
* [[Camera_DSP|NUI Camera DSP]] - Camera DSP, architecture, instruction set, firmware, and capabilities
 
* [[lsusb output]] - Device identifier output
 
* [[lsusb output]] - Device identifier output
 
* [[USB Devices]] - Overview of the hardware devices
 
* [[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
 
* [[USB Protocol Information]] - Other information about the Kinect USB protocol
 
* [[Init Analysis]] - Messing with various init sequences
 
* [[Init Analysis]] - Messing with various init sequences
Line 83: Line 86:
  
 
'''OpenNI'''
 
'''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://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/openni - Open source framework for natural interaction devices
 
* http://github.com/PrimeSense/Sensor - Open source driver for the PrimeSensor Development Kit
 
* 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 '''
 
''' Tech '''
Line 98: Line 96:
 
* http://www.primesense.com/?p=535 - Primesense reference implementation (via adafruit thread)
 
* 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://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.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.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.
 
* 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.
 
+
* http://nvie.com/posts/a-successful-git-branching-model/ - Model for branching within Git
''' Kinect Themed sites '''
+
* http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob;f=Documentation/SubmittingPatches - Linux contribution procedure
* http://www.reddit.com/r/openkinect/ OpenKinect news and discussion community
+
* http://git.kernel.org/?p=git/git.git;a=blob_plain;f=Documentation/SubmittingPatches;hb=HEAD - Git project contribution procedure
* [http://www.kinect-hacks.net Kinect hacks] - Kinect Hacks, news, gossip and videos
 
* 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.
 
* http://www.kinectHacks.nl - Dutch Kinect hacking blog and forum
 
 
 
''' 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
 

Latest revision as of 12:38, 7 March 2012

Logo openkinect shaded.svg

Welcome to the OpenKinect project

Language: English  • español • suomi • français • italiano • português do Brasil • 中文(简体)‎

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.

The OpenKinect community consists of over 2000 members contributing their time and code to the Project. Our members have joined this Project with the mission of creating the best possible suite of applications for the Kinect. OpenKinect is a true "open source" community!

Our primary focus is currently the libfreenect software. Code contributed to OpenKinect where possible is made available under an Apache20 or optional GPL2 license.

  • 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 the low-traffic announcement-only mailing list.

  • You can follow us on Twitter @openkinect. Please use the #tag #openkinect when tweeting your work.
  • 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, analysis library, and applications)
  • People - Who is doing what: project leader, maintainers, contributors etc.
  • Project History - The bounty, key dates and milestones
  • Project Policies - The official name of the project, license, contribution policy, developers coordination and decision making
  • Installation - How to download, build and install on Linux, OS X and Windows
  • Contributing Code - Official repositories, use of a fork and source header, signing off, submissions and evaluation etc.
  • Code Integration - How to deal with how we use git: repository policy, git usage, workflow, starting development, integration process etc.
  • Contributing - There are many ways to contribute: testing, administrative tasks, support related, documentation, collaboration etc.
  • FAQ - Frequently asked questions
  • Documentation - Documenation
  • Project Ideas - Ideas and concepts to explore using OpenKinect
  • Gallery and websites - Videos and links to things people are doing with OpenKinect
  • Official Logos - Official OpenKinect logos for use in your projects

API Documentation

Wrappers

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

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

Tech