Skip to content

Commit 8ac2cc3

Browse files
zhonghong322zhonghong322
committed
Update Document
1 parent 4de2bb7 commit 8ac2cc3

28 files changed

+256
-199
lines changed

‎docs/_sources/source/1_overview/Support_platform.md.txt

Lines changed: 46 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,59 @@
11
# Support Platforms
22

33
- Windows: Windows 10 (x64)
4-
- Linux: 18.04/20.04/22.04 (x64)
4+
- Linux: 18.04/20.04/22.04/24.04 (x64)
55
- Arm64: Ubuntu18.04/20.04/22.04
66

77
# Support Hardware Products
88

99
This document is based on the v2-main branch code, which is a Python wrapper built on Orbbec SDK v2. It supports the following devices.
1010
If your device is included in this supported list, we recommend using the v2-main branch. If not, you can use the main branch instead.
1111

12-
| **Products list** | **Firmware Version** |
13-
| ----------------------- | -------------------------- |
14-
| Gemini 335 | 1.2.20 |
15-
| Gemini 335L | 1.2.20 |
16-
| Gemini 336 | 1.2.20 |
17-
| Gemini 336L | 1.2.20 |
18-
| Femto Bolt | 1.0.6/1.0.9 |
19-
| Femto Mega | 1.1.7/1.2.7 |
20-
| Astra 2 | 2.8.20 |
21-
| Gemini 2 L | 1.4.32 |
22-
| Gemini 2 | 1.4.60 /1.4.76 |
12+
| **Products List** | **Minimal Firmware Version** |
13+
|-------------------|------------------------------|
14+
| Gemini 335Le | 1.5.31 |
15+
| Gemini 330 | 1.2.20 |
16+
| Gemini 330L | 1.2.20 |
17+
| Gemini 335 | 1.2.20 |
18+
| Gemini 335L | 1.2.20 |
19+
| Gemini 336 | 1.2.20 |
20+
| Gemini 336L | 1.2.20 |
21+
| Gemini 335Lg | 1.3.46 |
22+
| Femto Bolt | 1.1.2 |
23+
| Femto Mega | 1.3.0 |
24+
| Femto Mega I | 2.0.4 |
25+
| Astra 2 | 2.8.20 |
26+
| Gemini 2 L | 1.4.53 |
27+
| Gemini 2 | 1.4.92 |
28+
| Gemini 215 | 1.0.9 |
29+
| Gemini 210 | 1.0.9 |
2330

2431
the main branch supports the following devices:
2532

26-
| **Products list** | **Firmware Version** |
27-
| ----------------------- | --------------------------- |
28-
| Gemini 335 | 1.2.20 |
29-
| Gemini 335L | 1.2.20 |
30-
| Gemini 336 | 1.2.20 |
31-
| Gemini 336L | 1.2.20 |
32-
| Femto Bolt | 1.0.6/1.0.9 |
33-
| Femto Mega | 1.1.7/1.2.7 |
34-
| Gemini 2 XL | Obox: V1.2.5 VL:1.4.54 |
35-
| Astra 2 | 2.8.20 |
36-
| Gemini 2 L | 1.4.32 |
37-
| Gemini 2 | 1.4.60 /1.4.76 |
38-
| Astra+ | 1.0.22/1.0.21/1.0.20/1.0.19 |
39-
| Femto | 1.6.7 |
40-
| Femto W | 1.1.8 |
41-
| DaBai | 2436 |
42-
| DaBai DCW | 2460 |
43-
| DaBai DW | 2606 |
44-
| Astra Mini Pro | 1007 |
45-
| Gemini E | 3460 |
46-
| Gemini E Lite | 3606 |
47-
| Gemini | 3.0.18 |
48-
| Astra Mini S Pro | 1.0.05 |
33+
34+
| **Products List** | **Minimal Firmware Version** |
35+
|-------------------|-----------------------------|
36+
| Gemini 330 | 1.2.20 |
37+
| Gemini 330L | 1.2.20 |
38+
| Gemini 335 | 1.2.20 |
39+
| Gemini 335L | 1.2.20 |
40+
| Gemini 336 | 1.2.20 |
41+
| Gemini 336L | 1.2.20 |
42+
| Femto Bolt | 1.0.6 |
43+
| Femto Mega | 1.1.7 |
44+
| Femto Mega I | 2.0.2 |
45+
| Gemini 2 XL | Obox: V1.2.5 VL:1.4.54 |
46+
| Astra 2 | 2.8.20 |
47+
| Gemini 2 L | 1.4.32 |
48+
| Gemini 2 | 1.4.60 |
49+
| Astra+ | 1.0.19 |
50+
| Femto | 1.6.7 |
51+
| Femto W | 1.1.8 |
52+
| DaBai | 2436 |
53+
| DaBai DCW | 2460 |
54+
| DaBai DW | 2606 |
55+
| Astra Mini Pro | 1007 |
56+
| Gemini E | 3460 |
57+
| Gemini E Lite | 3606 |
58+
| Gemini | 3018 |
59+
| Astra Mini S Pro | 1005 |

‎docs/_sources/source/2_installation/build_the_package.md.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Clone the repository to get the latest version:
1717

1818
```bash
1919
git clone https://github.com/orbbec/pyorbbecsdk.git
20-
git checkout OrbbecSDK_V2.x
20+
git checkout v2-main
2121
```
2222

2323
## Install Dependencies (Ubuntu)

‎docs/_sources/source/3_QuickStarts/QuickStart.md.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The Python Wrapper primarily includes the following features:
1313
* Presets (supported by Gemini 330 series).
1414
* Update Firmware .
1515
* Network functionality (supported by the Femto Mega).
16+
* Record and playback.
1617

1718
# Build your First Camera Application
1819

@@ -65,6 +66,9 @@ pipeline.stop()
6566
| infrared.py | Displays the infrared stream from the camera. | | ⭐⭐ |
6667
| multi_device.py | Demonstrates how to use multiple devices. | | ⭐⭐ |
6768
| net_device.py | Demonstrates how to use network functions. | Supported by Femto Mega and Gemini 2 XL. | ⭐⭐ |
69+
|recorder.py |Demonstrates how to record the streams to a file. | | ⭐⭐ |
70+
|playback.py |Demonstrates how to play back recorded streams. | | ⭐⭐ |
71+
|device_optional_depth_presets_update.py| This sample shows how to read a BIN file to perform optional depth presets upgrades on the device. | Supported by Gemini 330 series | ⭐⭐ |
6872
| coordinate_transform.py | Use the SDK interface to transform different coordinate systems. | | ⭐⭐⭐ |
6973
| device_firmware_update.py | This sample demonstrates how to read a firmware file to perform firmware upgrades on the device. | | ⭐⭐⭐ |
7074
| depth_work_mode.py | Demonstrates how to set the depth work mode. | Supported by Gemini2、Gemini2L、Astra2、Gemini 2 XL | ⭐⭐⭐ |

‎docs/_static/basic.css

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
/*
2-
* basic.css
3-
* ~~~~~~~~~
4-
*
52
* Sphinx stylesheet -- basic theme.
6-
*
7-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8-
* :license: BSD, see LICENSE for details.
9-
*
103
*/
114

125
/* -- main layout ----------------------------------------------------------- */
@@ -115,15 +108,11 @@ img {
115108
/* -- search page ----------------------------------------------------------- */
116109

117110
ul.search {
118-
margin: 10px 0 0 20px;
119-
padding: 0;
111+
margin-top: 10px;
120112
}
121113

122114
ul.search li {
123-
padding: 5px 0 5px 20px;
124-
background-image: url(file.png);
125-
background-repeat: no-repeat;
126-
background-position: 0 7px;
115+
padding: 5px 0;
127116
}
128117

129118
ul.search li a {

‎docs/_static/doctools.js

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
/*
2-
* doctools.js
3-
* ~~~~~~~~~~~
4-
*
52
* Base JavaScript utilities for all Sphinx HTML documentation.
6-
*
7-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8-
* :license: BSD, see LICENSE for details.
9-
*
103
*/
114
"use strict";
125

‎docs/_static/js/versions.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
const themeFlyoutDisplay = "hidden";
2-
const themeVersionSelector = "True";
3-
const themeLanguageSelector = "True";
2+
const themeVersionSelector = true;
3+
const themeLanguageSelector = true;
44

55
if (themeFlyoutDisplay === "attached") {
66
function renderLanguages(config) {
77
if (!config.projects.translations.length) {
88
return "";
99
}
1010

11+
// Insert the current language to the options on the selector
12+
let languages = config.projects.translations.concat(config.projects.current);
13+
languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name));
14+
1115
const languagesHTML = `
1216
<dl>
1317
<dt>Languages</dt>
14-
${config.projects.translations
18+
${languages
1519
.map(
1620
(translation) => `
1721
<dd ${translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : ""}>

‎docs/_static/language_data.js

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
/*
2-
* language_data.js
3-
* ~~~~~~~~~~~~~~~~
4-
*
52
* This script contains the language-specific data used by searchtools.js,
63
* namely the list of stopwords, stemmer, scorer and splitter.
7-
*
8-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
9-
* :license: BSD, see LICENSE for details.
10-
*
114
*/
125

136
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];

‎docs/_static/pygments.css

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
66
.highlight .hll { background-color: #ffffcc }
77
.highlight { background: #f8f8f8; }
88
.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
9-
.highlight .err { border: 1px solid #FF0000 } /* Error */
9+
.highlight .err { border: 1px solid #F00 } /* Error */
1010
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
11-
.highlight .o { color: #666666 } /* Operator */
11+
.highlight .o { color: #666 } /* Operator */
1212
.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
1313
.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
1414
.highlight .cp { color: #9C6500 } /* Comment.Preproc */
@@ -25,34 +25,34 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
2525
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
2626
.highlight .gs { font-weight: bold } /* Generic.Strong */
2727
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
28-
.highlight .gt { color: #0044DD } /* Generic.Traceback */
28+
.highlight .gt { color: #04D } /* Generic.Traceback */
2929
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
3030
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
3131
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
3232
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
3333
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
3434
.highlight .kt { color: #B00040 } /* Keyword.Type */
35-
.highlight .m { color: #666666 } /* Literal.Number */
35+
.highlight .m { color: #666 } /* Literal.Number */
3636
.highlight .s { color: #BA2121 } /* Literal.String */
3737
.highlight .na { color: #687822 } /* Name.Attribute */
3838
.highlight .nb { color: #008000 } /* Name.Builtin */
39-
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
40-
.highlight .no { color: #880000 } /* Name.Constant */
41-
.highlight .nd { color: #AA22FF } /* Name.Decorator */
39+
.highlight .nc { color: #00F; font-weight: bold } /* Name.Class */
40+
.highlight .no { color: #800 } /* Name.Constant */
41+
.highlight .nd { color: #A2F } /* Name.Decorator */
4242
.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
4343
.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
44-
.highlight .nf { color: #0000FF } /* Name.Function */
44+
.highlight .nf { color: #00F } /* Name.Function */
4545
.highlight .nl { color: #767600 } /* Name.Label */
46-
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
46+
.highlight .nn { color: #00F; font-weight: bold } /* Name.Namespace */
4747
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
4848
.highlight .nv { color: #19177C } /* Name.Variable */
49-
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
50-
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
51-
.highlight .mb { color: #666666 } /* Literal.Number.Bin */
52-
.highlight .mf { color: #666666 } /* Literal.Number.Float */
53-
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
54-
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
55-
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
49+
.highlight .ow { color: #A2F; font-weight: bold } /* Operator.Word */
50+
.highlight .w { color: #BBB } /* Text.Whitespace */
51+
.highlight .mb { color: #666 } /* Literal.Number.Bin */
52+
.highlight .mf { color: #666 } /* Literal.Number.Float */
53+
.highlight .mh { color: #666 } /* Literal.Number.Hex */
54+
.highlight .mi { color: #666 } /* Literal.Number.Integer */
55+
.highlight .mo { color: #666 } /* Literal.Number.Oct */
5656
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
5757
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
5858
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
@@ -67,9 +67,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
6767
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
6868
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
6969
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
70-
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
70+
.highlight .fm { color: #00F } /* Name.Function.Magic */
7171
.highlight .vc { color: #19177C } /* Name.Variable.Class */
7272
.highlight .vg { color: #19177C } /* Name.Variable.Global */
7373
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
7474
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
75-
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
75+
.highlight .il { color: #666 } /* Literal.Number.Integer.Long */

0 commit comments

Comments
 (0)