forked from microsoft/Azure-Kinect-Sensor-SDK
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
125 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,88 +1,56 @@ | ||
| # Azure Kinect SDK (K4A) | ||
| # OrbbecSDK-K4A-Wrapper | ||
|  | ||
|
|
||
| Welcome to the Azure Kinect Sensor SDK! We hope you can use it to build many great applications and participate in the project. Don't be shy to ask questions, and provide feedback. See [Azure.com/Kinect](https://Azure.com/kinect) for device | ||
| info and available documentation. | ||
| This branch is contain the K4A wrapper for OrbbecSDK. It's mean that user can use this library to develop the application with K4A API, but use to control the Orbbec camera. | ||
| Also user can use this library to replace native K4A library in your application to control the Orbbec camera without any code change. | ||
|
|
||
| [?branchName=develop)](https://dev.azure.com/ms/Azure-Kinect-Sensor-SDK/_build/latest?definitionId=133&branchName=develop) | ||
| [](https://www.nuget.org/packages/Microsoft.Azure.Kinect.Sensor/) | ||
| *This repo is forked from [Azure Kinect Sensor SDK](https://github.com/microsoft/Azure-Kinect-Sensor-SDK)* | ||
|
|
||
| ## Introduction | ||
| *This branch is base on release/1.4.x, and use new impl code base on [OrbbecSDK](https://github.com/orbbec/OrbbecSDK) to replace the k4a implementation.* | ||
|
|
||
| **Azure Kinect SDK** is a cross platform (Linux and Windows) user mode SDK to read data from your Azure Kinect device. | ||
| *The usage of this library is same as [Native K4A](./README_K4A.md)* | ||
|
|
||
| ## Why use the Azure Kinect SDK | ||
| ## Supported camera and platform | ||
|
|
||
| The Azure Kinect SDK enables you to get the most out of your Azure Kinect camera. Features include: | ||
| Orbbec Femto Mega: Win10+、Ubuntu20.04+, x64 | ||
|
|
||
| * Depth camera access | ||
| * RGB camera access and control (e.g. exposure and white balance) | ||
| * Motion sensor (gyroscope and accelerometer) access | ||
| * Synchronized Depth-RGB camera streaming with configurable delay between cameras | ||
| * External device synchronization control with configurable delay offset between devices | ||
| * Camera frame meta-data access for image resolution, timestamp and temperature | ||
| * Device calibration data access | ||
| *Other Orbbec cameras and platforms without test, don't use it in production environment.* | ||
|
|
||
| ## Installation | ||
| ## How to build | ||
|
|
||
| To use the SDK, please refer to the installation instructions in [usage](docs/usage.md) | ||
| ### Get source code | ||
|
|
||
| ## Documentation | ||
| ```bash | ||
| git clone https://github.com/orbbec/OrbbecSDK-K4A-Wrapper.git | ||
| git submodule update --init --recursive | ||
| ``` | ||
|
|
||
| API documentation is avaliable [here](https://microsoft.github.io/Azure-Kinect-Sensor-SDK/). | ||
| ### Build && install | ||
|
|
||
| ## Building | ||
| * Windows: it's recommend to use the Ninja to build the project | ||
|
|
||
| Azure Kinect SDK uses CMake to build. For instructions on how to build this SDK please see | ||
| [building](docs/building.md). | ||
| ```powershell | ||
| cd OrbbecSDK-K4A-Wrapper | ||
| mkdir build && cd build | ||
| cmake .. -G Ninja | ||
| cmake --build . | ||
| cmake --install . | ||
| ``` | ||
|
|
||
| ## Versioning | ||
| * Linux | ||
|
|
||
| The Azure Kinect SDK uses semantic versioning, please see [versioning.md](docs/versioning.md) for more information. | ||
| ```bash | ||
| cd OrbbecSDK-K4A-Wrapper | ||
| mkdir build && cd build | ||
| cmake .. | ||
| cmake --build . | ||
| cmake --install | ||
| ``` | ||
|
|
||
| ## Testing | ||
| ### Enjoy it! | ||
|
|
||
| For information on writing or running tests, please see [testing.md](docs/testing.md) | ||
| Connect the Orbbec camera to your PC, and run the k4aviewer. | ||
|
|
||
| ## Contribute | ||
| ## Attention | ||
|
|
||
| We welcome your contributions! Please see the [contribution guidelines](CONTRIBUTING.md). | ||
|
|
||
| ## Feedback | ||
|
|
||
| For SDK feedback or to report a bug, please file a [GitHub Issue](https://github.com/Microsoft/Azure-Kinect-Sensor-SDK/issues). For general suggestions or ideas, visit our [feedback forum](https://aka.ms/azurekinectfeedback). | ||
|
|
||
| ## Sample Code | ||
|
|
||
| There are several places where the sample code can be found. | ||
|
|
||
| - In this repository: [Azure-Kinect-Sensor-SDK\examples](https://github.com/microsoft/Azure-Kinect-Sensor-SDK/tree/develop/examples)- each example has a readme page that describes it and the steps to set it up. | ||
| - [Azure-Kinect-Samples](https://github.com/microsoft/Azure-Kinect-Samples) repository. There are multiple examples of how to use both Sensor and Body tracking SDKs. | ||
|
|
||
| ## Q&A | ||
|
|
||
| Welcome to the [Q&A](kinect-qa.md) corner! | ||
|
|
||
| ## Join Our Developer Program | ||
|
|
||
| Complete your developer profile [here](https://aka.ms/iwantmr) to get connected with our Mixed Reality Developer Program. You will receive the latest on our developer tools, events, and early access offers. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
| or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| ## Reporting Security Issues | ||
| Security issues and bugs should be reported privately, via email, to the | ||
| Microsoft Security Response Center (MSRC) at <[[email protected]](mailto:[email protected])>. | ||
| You should receive a response within 24 hours. If for some reason you do not, please follow up via | ||
| email to ensure we received your original message. Further information, including the | ||
| [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the | ||
| [Security TechCenter](https://technet.microsoft.com/en-us/security/default). | ||
|
|
||
| ## License and Microsoft Support for Azure Kinect Sensor SDK | ||
|
|
||
| [MIT License](LICENSE) | ||
|
|
||
| [Microsoft Support for Azure Kinect Sensor SDK](microsoft-support.md) | ||
| 1. The library of this branch is not support the K4A device, please use the [Native K4A](https://github.com/microsoft/Azure-Kinect-Sensor-SDK) library to control the K4A device. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # Azure Kinect SDK (K4A) | ||
|
|
||
| Welcome to the Azure Kinect Sensor SDK! We hope you can use it to build many great applications and participate in the project. Don't be shy to ask questions, and provide feedback. See [Azure.com/Kinect](https://Azure.com/kinect) for device | ||
| info and available documentation. | ||
|
|
||
| [?branchName=develop)](https://dev.azure.com/ms/Azure-Kinect-Sensor-SDK/_build/latest?definitionId=133&branchName=develop) | ||
| [](https://www.nuget.org/packages/Microsoft.Azure.Kinect.Sensor/) | ||
|
|
||
| ## Introduction | ||
|
|
||
| **Azure Kinect SDK** is a cross platform (Linux and Windows) user mode SDK to read data from your Azure Kinect device. | ||
|
|
||
| ## Why use the Azure Kinect SDK | ||
|
|
||
| The Azure Kinect SDK enables you to get the most out of your Azure Kinect camera. Features include: | ||
|
|
||
| * Depth camera access | ||
| * RGB camera access and control (e.g. exposure and white balance) | ||
| * Motion sensor (gyroscope and accelerometer) access | ||
| * Synchronized Depth-RGB camera streaming with configurable delay between cameras | ||
| * External device synchronization control with configurable delay offset between devices | ||
| * Camera frame meta-data access for image resolution, timestamp and temperature | ||
| * Device calibration data access | ||
|
|
||
| ## Installation | ||
|
|
||
| To use the SDK, please refer to the installation instructions in [usage](docs/usage.md) | ||
|
|
||
| ## Documentation | ||
|
|
||
| API documentation is avaliable [here](https://microsoft.github.io/Azure-Kinect-Sensor-SDK/). | ||
|
|
||
| ## Building | ||
|
|
||
| Azure Kinect SDK uses CMake to build. For instructions on how to build this SDK please see | ||
| [building](docs/building.md). | ||
|
|
||
| ## Versioning | ||
|
|
||
| The Azure Kinect SDK uses semantic versioning, please see [versioning.md](docs/versioning.md) for more information. | ||
|
|
||
| ## Testing | ||
|
|
||
| For information on writing or running tests, please see [testing.md](docs/testing.md) | ||
|
|
||
| ## Contribute | ||
|
|
||
| We welcome your contributions! Please see the [contribution guidelines](CONTRIBUTING.md). | ||
|
|
||
| ## Feedback | ||
|
|
||
| For SDK feedback or to report a bug, please file a [GitHub Issue](https://github.com/Microsoft/Azure-Kinect-Sensor-SDK/issues). For general suggestions or ideas, visit our [feedback forum](https://aka.ms/azurekinectfeedback). | ||
|
|
||
| ## Sample Code | ||
|
|
||
| There are several places where the sample code can be found. | ||
|
|
||
| - In this repository: [Azure-Kinect-Sensor-SDK\examples](https://github.com/microsoft/Azure-Kinect-Sensor-SDK/tree/develop/examples)- each example has a readme page that describes it and the steps to set it up. | ||
| - [Azure-Kinect-Samples](https://github.com/microsoft/Azure-Kinect-Samples) repository. There are multiple examples of how to use both Sensor and Body tracking SDKs. | ||
|
|
||
| ## Q&A | ||
|
|
||
| Welcome to the [Q&A](kinect-qa.md) corner! | ||
|
|
||
| ## Join Our Developer Program | ||
|
|
||
| Complete your developer profile [here](https://aka.ms/iwantmr) to get connected with our Mixed Reality Developer Program. You will receive the latest on our developer tools, events, and early access offers. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
| or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| ## Reporting Security Issues | ||
| Security issues and bugs should be reported privately, via email, to the | ||
| Microsoft Security Response Center (MSRC) at <[[email protected]](mailto:[email protected])>. | ||
| You should receive a response within 24 hours. If for some reason you do not, please follow up via | ||
| email to ensure we received your original message. Further information, including the | ||
| [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the | ||
| [Security TechCenter](https://technet.microsoft.com/en-us/security/default). | ||
|
|
||
| ## License and Microsoft Support for Azure Kinect Sensor SDK | ||
|
|
||
| [MIT License](LICENSE) | ||
|
|
||
| [Microsoft Support for Azure Kinect Sensor SDK](microsoft-support.md) |