Skip to content

Commit 3dce015

Browse files
zhonghong322zhonghong322
committed
Update README.md
1 parent b27aab4 commit 3dce015

File tree

1 file changed

+130
-34
lines changed

1 file changed

+130
-34
lines changed

‎README.md‎

Lines changed: 130 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,134 @@
1+
# Introduction
2+
The v2-main branch provides an Android wrapper based on the [Orbbec SDK v2.x](https://github.com/orbbec/OrbbecSDK_v2). Orbbec SDK v2.x is an open-source, cross-platform SDK for interfacing with Orbbec RGB-D cameras. For a comparison between SDK v2.x and [Orbbec SDK v1.x](https://github.com/orbbec/OrbbecSDK), see the [README](https://github.com/orbbec/OrbbecSDK_v2).
3+
4+
> [!IMPORTANT]
5+
>
6+
> Welcome to the Android wrapper . Before you begin using this version of Android wrapper , it's crucial to check the following device support list to verify the compatibility.
7+
8+
Here is the device support list of main branch (v1.x) and v2-main branch (v2.x):
9+
10+
<table border="1" style="border-collapse: collapse; text-align: left; width: 100%;">
11+
<thead>
12+
<tr style="background-color: #1f4e78; color: white; text-align: center;">
13+
<th>Product Series</th>
14+
<th>Product</th>
15+
<th><a href="https://github.com/orbbec/OrbbecSDK-Android-Wrapper/tree/main" style="color: black; text-decoration: none;">Branch main</a></th>
16+
<th><a href="https://github.com/orbbec/OrbbecSDK-Android-Wrapper/tree/v2-main" style="color: black; text-decoration: none;">Branch v2-main</a></th>
17+
</tr>
18+
</thead>
19+
<tbody>
20+
<tr>
21+
<td rowspan="6" style="text-align: center; font-weight: bold;">Gemini 330</td>
22+
<td>Gemini 335</td>
23+
<td>full maintenance</td>
24+
<td>recommended for new designs</td>
25+
</tr>
26+
<tr>
27+
<td>Gemini 336</td>
28+
<td>full maintenance</td>
29+
<td>recommended for new designs</td>
30+
</tr>
31+
<tr>
32+
<td>Gemini 330</td>
33+
<td>full maintenance</td>
34+
<td>recommended for new designs</td>
35+
</tr>
36+
<tr>
37+
<td>Gemini 335L</td>
38+
<td>full maintenance</td>
39+
<td>recommended for new designs</td>
40+
</tr>
41+
<tr>
42+
<td>Gemini 336L</td>
43+
<td>full maintenance</td>
44+
<td>recommended for new designs</td>
45+
</tr>
46+
<tr>
47+
<td>Gemini 330L</td>
48+
<td>full maintenance</td>
49+
<td>recommended for new designs</td>
50+
</tr>
51+
<tr>
52+
<td rowspan="3" style="text-align: center; font-weight: bold;">Gemini 2</td>
53+
<td>Gemini 2</td>
54+
<td>full maintenance</td>
55+
<td>recommended for new designs</td>
56+
</tr>
57+
<tr>
58+
<td>Gemini 2 L</td>
59+
<td>full maintenance</td>
60+
<td>recommended for new designs</td>
61+
</tr>
62+
<tr>
63+
<td>Gemini 2 XL</td>
64+
<td>recommended for new designs</td>
65+
<td>to be supported</td>
66+
</tr>
67+
<tr>
68+
<td rowspan="3" style="text-align: center; font-weight: bold;">Femto</td>
69+
<tr>
70+
<td>Femto Mega</td>
71+
<td>full maintenance</td>
72+
<td>recommended for new designs</td>
73+
</tr>
74+
<tr>
75+
<td>Femto Mega I</td>
76+
<td>full maintenance</td>
77+
<td>to be supported</td>
78+
</tr>
79+
<tr>
80+
<td rowspan="3" style="text-align: center; font-weight: bold;">Astra</td>
81+
<td>Astra 2</td>
82+
<td>full maintenance</td>
83+
<td>recommended for new designs</td>
84+
</tr>
85+
<tr>
86+
<td>Astra+</td>
87+
<td>limited maintenance</td>
88+
<td>not supported</td>
89+
</tr>
90+
<tr>
91+
<td>Astra Pro Plus</td>
92+
<td>limited maintenance</td>
93+
<td>not supported</td>
94+
</tr>
95+
<tr>
96+
<td style="text-align: center; font-weight: bold;">Astra Mini</td>
97+
<td>Astra Mini Pro</td>
98+
<td>full maintenance</td>
99+
<td>not supported</td>
100+
</tr>
101+
</tbody>
102+
</table>
103+
104+
**Note**: If you do not find your device, please contact our FAE or sales representative for help.
105+
106+
**Definition**:
107+
108+
1. recommended for new designs: we will provide full supports with new features, bug fix and performance optimization;
109+
2. full maintenance: we will provide bug fix support;
110+
3. limited maintenance: we will provide critical bug fix support;
111+
4. not supported: we will not support specific device in this version;
112+
5. to be supported: we will add support in the near future.
113+
114+
115+
## Hardware Products Supported by Android SDK
116+
117+
| **Products List** | **Minimal Firmware Version** |
118+
|-------------------|------------------------------|
119+
| Gemini 330 | 1.2.20 |
120+
| Gemini 330L | 1.2.20 |
121+
| Gemini 335 | 1.2.20 |
122+
| Gemini 335L | 1.2.20 |
123+
| Gemini 336 | 1.2.20 |
124+
| Gemini 336L | 1.2.20 |
125+
| Femto Mega | 1.3.0 |
126+
| Astra 2 | 2.8.20 |
127+
| Gemini 2 L | 1.4.53 |
128+
| Gemini 2 | 1.4.92 |
129+
| Gemini 215 | 1.0.9 |
130+
| Gemini 210 | 1.0.9 |
1131

2-
# Quick start
3-
## download source
4-
```
5-
git clone https://github.com/orbbec/OrbbecSDK-Android-Wrapper.git
6-
```
7132

8133
## import project
9134
1. Open Android studio
@@ -81,35 +206,6 @@ targetSdk 27
81206

82207
\[reference 02] [Android 10 Devices Do NOT Support USB Camera Connection.](https://www.camerafi.com/notice-android-10-devices-do-not-support-usb-camera-connection/)
83208

84-
## example
85-
Example of sensorsdk android wrapper
86-
87-
88-
# Support orbbec device
89-
OrbbecSDK：v1.10.3
90-
Support device list (firmware version):
91-
| SDK version | Product | Minimal Firmware version |
92-
| --- | --- | --- |
93-
| v1.10.3 | Gemini 335 | 1.2.20 |
94-
| | Gemini 335L | 1.2.20 |
95-
| | Gemini 336 | 1.2.20 |
96-
| | Gemini 336L | 1.2.20 |
97-
| | Gemini 2 XL | Obox: V1.2.5 VL:1.4.54 |
98-
| | Astra 2 | 2.8.20 |
99-
| | Gemini 2 L | 1.4.32 |
100-
| | Gemini 2 | 1.4.60 |
101-
| | Astra+ | 1.0.19 |
102-
| | Femto | 1.6.7 |
103-
| | Femto W | 1.1.8 |
104-
| | DaBai | 2436 |
105-
| | DaBai DCW | 2460 |
106-
| | DaBai DW | 2606 |
107-
| | Astra Mini Pro | 1007 |
108-
| | Gemini E | 3460 |
109-
| | Gemini E Lite | 3606 |
110-
| | Gemini | 3018 |
111-
| | Astra Mini S Pro | 1005 |
112-
113209
# Simple code of open depth stream
114210
Create OBContext global member to manager attach devices
115211
```java

0 commit comments

Comments
 (0)