MYNT-EYE-S-SDK/README.md

70 lines
3.6 KiB
Markdown
Raw Normal View History

2018-03-08 09:54:14 +02:00
# MYNT® EYE SDK
2018-08-14 06:13:21 +03:00
[![](https://img.shields.io/badge/MYNT%20EYE%20SDK-2.0.1--rc1-brightgreen.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2)
2018-06-10 17:21:08 +03:00
2018-03-08 09:54:14 +02:00
## Overview
MYNT® EYE SDK 2.0 is a cross-platform library for MYNT® EYE cameras.
2018-06-04 19:30:44 +03:00
The following platforms have been tested:
* Windows 10
* Ubuntu 16.04 / 14.04
* Jetson TX2
Please follow the guide doc to install the SDK on different platforms.
## Documentations
* [API Doc](https://github.com/slightech/MYNT-EYE-SDK-2/releases): API reference, some guides and data spec.
2018-08-14 06:13:21 +03:00
* en: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2/files/2285351/mynt-eye-sdk-apidoc-2.0.1-rc1-en.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2/files/2285352/mynt-eye-sdk-apidoc-2.0.1-rc1-html-en.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](https://slightech.github.io/MYNT-EYE-SDK-2/)
* zh-Hans: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2/files/2285353/mynt-eye-sdk-apidoc-2.0.1-rc1-zh-Hans.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2/files/2285354/mynt-eye-sdk-apidoc-2.0.1-rc1-html-zh-Hans.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](http://doc.myntai.com/resource/api/mynt-eye-sdk-apidoc-2.0.1-rc1-html-zh-Hans/mynt-eye-sdk-apidoc-2.0.1-rc1-html-zh-Hans/index.html)
2018-06-04 19:30:44 +03:00
* [Guide Doc](https://github.com/slightech/MYNT-EYE-SDK-2-Guide/releases): How to install and start using the SDK.
2018-08-14 06:13:21 +03:00
* en: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2-Guide/files/2281782/mynt-eye-sdk-guide-2.0.1-rc1-en.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2-Guide/files/2281783/mynt-eye-sdk-guide-2.0.1-rc1-html-en.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](https://slightech.github.io/MYNT-EYE-SDK-2-Guide/)
* zh-Hans: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2-Guide/files/2281785/mynt-eye-sdk-guide-2.0.1-rc1-zh-Hans.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2-Guide/files/2281786/mynt-eye-sdk-guide-2.0.1-rc1-html-zh-Hans.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](http://doc.myntai.com/resource/sdk/mynt-eye-sdk-guide-2.0.1-rc1-html-zh-Hans/mynt-eye-sdk-guide-2.0.1-rc1-html-zh-Hans/index.html)
2018-06-04 19:30:44 +03:00
2018-07-18 04:23:51 +03:00
> Supported languages: `en`, `zh-Hans`.
2018-06-04 19:30:44 +03:00
## Firmwares
2018-08-13 04:12:34 +03:00
[MYNTEYE_BOX]: http://doc.myntai.com/mynteye/s/download
2018-06-04 19:30:44 +03:00
2018-08-13 04:12:34 +03:00
Get firmwares from our online disks: [MYNTEYE_BOX][]. The latest version is `2.0.1`.
2018-06-04 19:30:44 +03:00
2018-04-14 09:56:26 +03:00
## Usage
2018-06-04 19:30:44 +03:00
In short,
2018-04-14 09:56:26 +03:00
```bash
$ make
Usage:
make help show help message
make apidoc make api doc
make opendoc open api doc (html)
make init init project
make build build project
make test build test and run
make install install project
make samples build samples
2018-04-15 09:59:51 +03:00
make tools build tools
2018-04-14 09:56:26 +03:00
make ros build ros wrapper
make clean|cleanall clean generated or useless things
```
Init project, build samples and run someone.
```bash
make init
make samples
2018-04-15 18:29:06 +03:00
./samples/_output/bin/device/camera_d
2018-04-14 09:56:26 +03:00
```
2018-05-16 06:43:46 +03:00
## Mirrors
国内镜像:[码云](https://gitee.com/mynt/MYNT-EYE-SDK-2)。
2018-03-08 09:54:14 +02:00
## License
This project is licensed under the Apache License, Version 2.0. Copyright 2018 Slightech Co., Ltd.