kinect_fetch_fw: declare FIRMWARE_PATH earlier and use it when installing
[kinect-audio-setup.git] / README
1 kinect-audio-setup makes audio input from the Microsoft Kinect Sensor
2 device work on GNU/Linux systems.
3
4 When the Kinect is first plugged in the USB port it shows up as
5 a generic USB device with a bulk endpoint; after uploading a certain
6 firmware a reenumeration takes place and a USB Audio Class (UAC) device
7 becomes available.
8
9 kinect-audio-setup provides tools to download the firmware off the net
10 at installation time â€”since the firmware is not redistributable—, and it
11 sets up udev rules to call the firmware loader when the device is
12 plugged in to finally get the USB Audio Class device.
13
14 Note that for all the magic to happen automatically pulseaudio >= 1.0 is
15 needed, as it contains the kinect-audio.conf profile which fixes audio
16 device detection:
17   https://bugs.freedesktop.org/show_bug.cgi?id=39664
18
19 kinect-audio-setup provides:
20   - kinect_fetch_fw which downloads and extracts the firmware from the
21     Microsoft Kinect SDK;
22   - kinect_upload_fw which loads the firmware to the generic USB device
23     in order to get the USB Audio Class device to show up;
24   - udev rules to call kinect_upload_fw when the device is plugged in.
25
26
27 To install kinect-audio-setup from the source distribution follow the
28 steps below with superuser rights:
29
30 Install kinect_upload_fw first:
31
32   # make install
33
34 it will be copied to /usr/local/sbin by default, assign the PREFIX
35 variable on the command line to install it to another location.
36
37 Then run the firmware fetcher script (remember this is only needed
38 once):
39
40   # ./kinect_fetch_fw /lib/firmware/kinect
41   # udevadm control --reload-rules
42
43
44 The UAC firmware is downloaded from the Microsoft Kinect SDK at
45 http://www.kinectforwindows.org, the license of the SDK can be found at
46 http://research.microsoft.com/en-us/um/legal/kinectsdk-tou_noncommercial.htm
47
48 === Acknowledgements
49
50 A special thanks goes to Steven Toth from http://kernellabs.com, who
51 kindly sponsored a Kinect to Antonio Ospite and made kinect-audio-setup
52 possible in its current form.