Skip to content

dewminawijekoon/freenect-python

Repository files navigation

libfreenect Python Wrapper

A modern Python 3-compatible wrapper for libfreenect, providing access to Microsoft Kinect v1 functionality.

⚠️ This project builds upon the original Python wrapper by Brandyn White(https://github.com/bwhite). I have ported and updated it for Python 3 compatibility and ongoing maintenance.


🚀 Installation

📦 From PyPI (Recommended)

You can now install the package directly from PyPI:

pip install freenect

🔧 From Source

Clone the repository and install manually:

git clone https://github.com/dewminawijekoon/freenect-python.git
cd freenect-python
pip install .

🧪 For Development

To install in editable mode with development dependencies:

git clone https://github.com/dewminawijekoon/freenect-python.git
cd freenect-python
pip install -e ".[dev]"

📦 Prerequisites

Make sure libfreenect is installed on your system before using this wrapper.

Follow the official instructions: 👉 https://github.com/OpenKinect/libfreenect


⚡ Quick Start

import freenect
import numpy as np

# Capture a depth image
depth, timestamp = freenect.sync_get_depth()
print(f"Depth shape: {depth.shape}")

# Capture an RGB image
rgb, timestamp = freenect.sync_get_video()
print(f"RGB shape: {rgb.shape}")

✨ Features

  • Access Kinect depth and RGB video streams
  • Synchronous & asynchronous capture modes
  • Seamless integration with NumPy
  • Cross-platform support (Linux, macOS, Windows)

📋 Requirements

  • Python 3.8+
  • NumPy
  • libfreenect (installed system-wide)

📄 License

Licensed under the Apache License 2.0.


🤝 Contributing

Contributions are welcome! Feel free to open issues, fork the repo, or submit pull requests.


🐛 Issues

Encounter a problem? Open an issue and include a detailed description to help us assist you better.

About

Python wrapper for libfreenect – Microsoft Kinect library. Now available on PyPI: pip install freenect

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors