orbbec-sdk-sys 0.1.2+2.5.5

Low-level Rust bindings for https://github.com/orbbec/OrbbecSDK_v2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

# OrbbecSDK Docker Environment Setup

## Installing Docker

### For Overseas Users:

Refer to the [official Docker documentation](https://docs.docker.com/engine/install/ubuntu/).

### For Users in China:

Refer to the [Tsinghua University Open Source Software Mirror](https://mirrors.tuna.tsinghua.edu.cn/help/docker-ce/).

### Uninstall Previous Docker Installations:

If you have previously installed Docker, remove it first:

```bash
sudo apt-get remove docker docker-engine docker.io containerd runc
```

### Install Dependencies:

```bash
sudo apt-get install apt-transport-https ca-certificates curl gnupg2 software-properties-common
```

### Trust Docker’s GPG Key:

```bash
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
```

### Add Docker Repository:

```bash
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://mirrors.tuna.tsinghua.edu.cn/docker-ce/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
```

### Install Docker:

```bash
sudo apt-get update
sudo apt-get install docker-ce
```

### Add Current User to Docker Group:

To avoid using `sudo` for Docker commands, add your user to the Docker group:

```bash
sudo groupadd docker
sudo usermod -aG docker $USER
```

You will need to log out or reboot for this to take effect.

## Installing NVIDIA Docker

Refer to
the [official NVIDIA documentation](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker).

## Getting Started

### Install ADE CLI

Go to the [ADE CLI releases page](https://gitlab.com/ApexAI/ade-cli/-/releases) and download the latest version for your
system.

```bash
mv ade+x86_64 ade
# or mv ade+aarch64 ade
chmod +x ade
sudo mv ade /usr/local/bin
```

### Shell Completion

Add the following code to your `.zshrc` or `.bashrc`:

```bash
if [ -n "$ZSH_VERSION" ]; then
    eval "$(_ADE_COMPLETE=source_zsh ade)"
else
    eval "$(_ADE_COMPLETE=source ade)"
fi
```

### Build Docker

```bash
./build_docker.sh
```

### Usage

#### Choose Directory to Mount (e.g., `~/ws`):

```bash
cd ~/ws
touch .adehome
```

This indicates that Docker will mount `~/ws` as the container's home directory. You can also mount other directories.

#### Set Up `.aderc`:

```bash
cd ~/ws
touch .aderc
```

Add the following to `.aderc`:

```bash
export ADE_DOCKER_RUN_ARGS="--cap-add=SYS_PTRACE \
 --privileged \
 --net=host \
 --add-host ade:127.0.0.1 \
 -v ${HOME}/.Xauthority:${HOME}/.Xauthority:ro \
 -e XAUTHORITY=${HOME}/.Xauthority \
 -v /dev:/dev \
"

export ADE_IMAGES=" \
 orbbecsdk-env:x86_64_20240711 \
"
```

#### Start Container:

Navigate to the directory containing `.aderc`:

```bash
ade start
ade enter
```

You should now be inside the Docker container.

### References

1. [Docker Documentation](https://docs.docker.com/engine/install/ubuntu/)
2. [NVIDIA Container Toolkit Installation Guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
3. [ADE CLI Documentation](https://ade-cli.readthedocs.io/en/latest/)