Project Aria Tools

https://facebookresearch.github.io/projectaria_tools/docs
Admin
Project Aria Tools is a software development kit and documentation for Project Aria, Facebook...
Tokens:73,831
Snippets:1,049
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Run Dataprovider quickstart tutorial

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/getting_started

Navigate to the project directory and launch the dataprovider quickstart Jupyter notebook.

```bash
cd $HOME/Documents/projectaria_sandbox  
  
jupyter notebook projectaria_tools/core/examples/dataprovider_quickstart_tutorial.ipynb  
```

--------------------------------

### Run Machine Perception Services (MPS) quickstart tutorial

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/getting_started

Navigate to the project directory and launch the MPS quickstart Jupyter notebook.

```bash
cd $HOME/Documents/projectaria_sandbox  
  
jupyter notebook projectaria_tools/core/examples/mps_quickstart_tutorial.ipynb  
```

--------------------------------

### Run Pangolin Examples

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/troubleshooting

Execute specific Pangolin examples to test display driver functionality.

```bash
./examples/BasicOpenGl/tutorial_3_gl_intro_classic_triangle_vbo_shader
```

```bash
./examples/SimplePlot/SimplePlot
```

--------------------------------

### Install Client SDK and CLI

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/setup

Activate the virtual environment and install the SDK package. Linux users should specify version 1.1.0.

```bash
source ~/venv/bin/activate

  

python3 -m pip install projectaria_client_sdk --no-cache-dir
```

```bash
python3 -m pip install projectaria_client_sdk==1.1.0 --no-cache-dir
```

--------------------------------

### Launch Aria Studio

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/aria_studio

Command to start the Aria Studio application after installation.

```bash
aria_studio
```

--------------------------------

### Install Pixi Package Manager

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/installation_python

Installation commands for Pixi on different operating systems.

```bash
# Install Pixi  

curl -fsSL https://pixi.sh/install.sh | bash  
```

```powershell
# Install Pixi  

iwr -useb https://pixi.sh/install.ps1 | iex  
```

--------------------------------

### Start recording on the client devices

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/ticsync_sample

Iterates through all client recording managers to trigger the start of recording.

```python
# Start recording on the client devices  

for manager in client_recording_managers.values():  

    manager.start_recording()
```

--------------------------------

### Install persistent streaming certificates

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/concepts/streaming_internals

Use the CLI to generate and install persistent certificates on the glasses.

```bash
aria streaming install-certs
```

--------------------------------

### Setup Virtual Environment on Windows

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/aria_studio

Commands to create and activate a virtual environment before installing Aria Studio on Windows.

```powershell
remove-Item -Path $HOME/venv/aria_studio -recurse -Force

py -3 -m venv $HOME/venv/aria_studio

& $HOME\venv\aria_studio\Scripts\Activate.ps1

py -3 -m pip install aria_studio --no-cache-dir
```

--------------------------------

### Run the ADT tutorial notebook

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_digital_twin_dataset/getting_started

Commands to navigate to the project directory and launch the quickstart Jupyter notebook.

```bash
cd $HOME/Documents/projectaria_sandbox  
  
jupyter notebook projectaria_tools/projects/AriaDigitalTwinDatasetTools/examples/adt_quickstart_tutorial.ipynb  
```

--------------------------------

### Setup Virtual Environment on Linux and macOS

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/aria_studio

Commands to create and activate a virtual environment before installing Aria Studio on Unix-based systems.

```bash
rm -rf $HOME/venv/aria_studio

python3 -m venv $HOME/venv/aria_studio

source $HOME/venv/aria_studio/bin/activate

python3 -m pip install aria_studio --no-cache-dir
```

--------------------------------

### Run Sophus Pybind Tutorial

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/getting_started

Navigate to the project directory and launch the Sophus quickstart Jupyter notebook.

```bash
cd $HOME/Documents/projectaria_sandbox  
  
jupyter notebook projectaria_tools/core/examples/sophus_quickstart_tutorial.ipynb  
```

--------------------------------

### Install additional dependencies

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/digital_twin_catalog/digital_twin_catalog_getting_started

Install required external packages opencv-python and trimesh.

```bash
python3 -m pip install opencv-python trimesh  
```

--------------------------------

### Install dependencies

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/advanced_code_snippets/vrs_to_mp4

Install the required projectaria_tools and moviepy packages.

```bash
python3 -m pip install projectaria_tools moviepy  
```

--------------------------------

### Start Streaming

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/device_stream

Initiate the streaming process using the configured settings.

```python
streaming_manager.start_streaming()
```

--------------------------------

### Run Aria Viewer

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/installation_cpp

Verify the installation by launching the viewer with sample data.

```bash
cd $HOME/Documents/projectaria_sandbox/build  

  

# Running the Aria Viewer with default example data  

./tools/visualization/aria_viewer \

--vrs ../projectaria_tools/data/mps_sample/sample.vrs  
```

--------------------------------

### TICSync Cleanup Output Example

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/ticsync

Example console output showing the device detection and cleanup process.

```text
-------- Plug in all devices to your computer again for TicSync cleanup --------  

-------- Then press Enter to start TicSync cleanup --------  

[('1WM999999D0000', 'Aria'), ('1WM281623D3490', 'Aria'), ('1WM391623D5689', 'Aria')]  

[AriaSdk:DeviceControllerImpl][INFO]: Connecting to device 1WM999999D0000 over USB  

[AriaSdk:DeviceControllerImpl][INFO]: Connecting to device 1WM281623D3490 over USB  

[AriaSdk:DeviceControllerImpl][INFO]: Connecting to device 1WM391623D5689 over USB  

Detected server serial 1WM999999D0000  

Detected client serials ['1WM281623D3490', '1WM391623D5689']  

[AriaSdk:DeviceControllerImpl][INFO]: Connecting to device 1WM281623D3490 over USB  

[AriaSdk:DeviceControllerImpl][INFO]: Connecting to device 1WM391623D5689 over USB  

[AriaSdk:DeviceControllerImpl][INFO]: Connecting to device 1WM999999D0000 over USB  

-------- All devices reconnected, please keep all devices plugged in. Performing cleanup --------  

DDS RPC enabled, disabling it  

-------- Successfully performed cleanup. Exiting --------
```

--------------------------------

### Extract and Prepare Sample Apps

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/setup

Extract SDK samples, navigate to the directory, and install required dependencies.

```bash
python -m aria.extract_sdk_samples --output ~
```

```bash
cd ~/projectaria_client_sdk_samples
```

```bash
python3 -m pip install -r requirements.txt
```

--------------------------------

### Launch ASE tutorial notebook

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_synthetic_environments_dataset/ase_data_tools

Navigate to the projectaria_tools directory and start the Jupyter notebook for ASE tutorials.

```bash
cd /path_to/projectaria_tools  

  

jupyter notebook projects/AriaSyntheticEnvironment/tutorial/ase_tutorial_notebook.ipynb  
```

--------------------------------

### Get downloader help

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_digital_twin_dataset/dataset_download

Display the available command-line arguments and usage information.

```bash
aria_dataset_downloader --help
```

--------------------------------

### Run AEA Tutorial Notebook

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_everyday_activities_dataset/aea_getting_started

Commands to navigate to the project directory and launch the AEA quickstart Jupyter notebook.

```bash
cd $HOME/Documents/projectaria_sandbox  

  
jupyter notebook projectaria_tools/projects/AriaEverydayActivities/examples/aea_quickstart_tutorial.ipynb  
```

--------------------------------

### Install Aria Studio via PyPI

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/aria_studio

Use this command to install the package directly into your Python environment.

```bash
python3 -m pip install aria_studio --no-cache-dir
```

--------------------------------

### Start Streaming Subscription

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/streaming_subscribe

Initiates the subscription to begin receiving live data.

```python
streaming_client.subscribe()  
```

--------------------------------

### Setup ASE local folder

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_synthetic_environments_dataset/ase_getting_started

Commands to create the local directory and move the download URLs file into it.

```bash
mkdir -p $HOME/Documents/projectaria_sandbox/projectaria_tools_ase_data  
  
mv $HOME/Downloads/aria_synthetic_environments_dataset_download_urls.json $HOME/Documents/projectaria_sandbox/projectaria_tools_ase_data/  
```

--------------------------------

### Install VRS Tools with Pixi

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_formats/aria_vrs/aria_vrs_tools_installation

Install vrs locally within a project or globally using the Pixi package manager.

```bash
# Pixi https://prefix.dev/  

# Local install  

pixi add vrs  

# Global install  

# pixi global install vrs
```

--------------------------------

### Build Python Bindings from Source

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/installation_python

Commands to install the package from the local source directory after installing C++ dependencies.

```bash
cd $HOME/Documents/projectaria_sandbox/projectaria_tools  

  

python3 -m pip install --upgrade pip  

  

python3 -m pip install .  
```

--------------------------------

### Visualize live stream

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/device_stream

Subscribe to the stream and start the rendering loop.

```python
streaming_client.subscribe()

aria_visualizer.render_loop()
```

--------------------------------

### Start recording on the server device

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/ticsync_sample

Initiates recording on the designated server device and retrieves the current recording state.

```python
# Start recording on the server device  

print(f"Starting to record the server device {server_serial} using {profile_name}")  

server_recording_manager.start_recording()  

# Get recording state of the server device  

server_recording_state = server_recording_manager.recording_state  

print(f"Recording state of server device {server_serial}: {server_recording_state}")
```

--------------------------------

### Manage device recording

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/cli/api_reference

Commands to start, stop, and list recording profiles.

```bash
aria recording [OPTIONS] SUBCOMMAND
```

```bash
aria recording start [OPTIONS]
```

```bash
--profile (string)
```

```bash
aria recording stop
```

```bash
aria recording profiles [OPTIONS]
```

```bash
--save-json (string)
```

```bash
--json-dir (string)
```

--------------------------------

### Example profile JSON structure

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/concepts/sdk_sensor_profiles

A sample JSON output representing the configuration of sensors for a specific profile.

```json
{
 "name": "profile12",
 "description": "Streaming mode with JPEG (RGB 10fps 2MP, SLAM 10fps, ET 10fps QVGA, JPEG; Audio, GPS, Wi-Fi and BLE off)",
 "imu1": {
  "enabled": true,
  "dataRateHz": 1000
 },
 "imu2": {
  "enabled": true,
  "dataRateHz": 800
 },
 "magnetometer": {
  "enabled": true,
  "dataRateHz": 10
 },
 "barometer": {
  "enabled": true,
  "dataRateHz": 50
 },
 "audio": {
  "enabled": false,
  "numChannels": 0,
  "sampleRateHz": "0",
  "periodSize": 0
 },
 "gps": {
  "enabled": false,
  "dataRateHz": 0
 },
 "ble": {
  "enabled": false,
  "scanDurationMs": 0
 },
 "wifi": {
  "enabled": false,
  "scanDurationMs": 0,
  "wifiScanModeActive": false,
  "wifiMinDwellTimeMs": 0,
  "wifiMaxDwellTimeMs": 0
 },
 "slamCameras": {
  "enabled": true,
  "width": 640,
  "height": 480,
  "fps": 10,
  "autoExposureEnabled": true,
  "exposureMinUs": "0",
  "exposureMaxUs": "0",
  "gainMin": 0,
  "gainMax": 0,
  "exposureUs": "0",
  "gain": 0,
  "irLedEnabled": false,
  "imageFormat": "JPEG",
  "jpegEncoderType": "HARDWARE",
  "jpegQuality": 80,
  "videoEncoderQp": 0,
  "videoCodecType": "H264",
  "targetIntensity": 0
 },
 "etCamera": {
  "enabled": true,
  "width": 320,
  "height": 240,
  "fps": 10,
  "autoExposureEnabled": false,
  "exposureMinUs": "0",
  "exposureMaxUs": "0",
  "gainMin": 0,
  "gainMax": 0,
  "exposureUs": "1000",
  "gain": 1,
  "irLedEnabled": true,
  "imageFormat": "JPEG",
  "jpegEncoderType": "HARDWARE",
  "jpegQuality": 80,
  "videoEncoderQp": 0,
  "videoCodecType": "H264",
  "targetIntensity": 0
 },
 "rgbCamera": {
  "enabled": true,
  "width": 1408,
  "height": 1408,
  "fps": 10,
  "autoExposureEnabled": true,
  "exposureMinUs": "0",
  "exposureMaxUs": "0",
  "gainMin": 0,
  "gainMax": 0,
  "exposureUs": "0",
  "gain": 0,
  "irLedEnabled": false,
  "imageFormat": "JPEG",
  "jpegEncoderType": "HARDWARE",
  "jpegQuality": 80,
  "videoEncoderQp": 0,
  "videoCodecType": "H264",
  "targetIntensity": 0
 },
 "attention": {
  "enabled": false
 }
}
```

--------------------------------

### Start streaming with ephemeral certificates

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/concepts/streaming_internals

Initiate a streaming session using temporary certificates valid only for the current session.

```bash
aria streaming start --use-ephemeral-certs
```

--------------------------------

### Generate and Install Type Hinting

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/installation_python

Steps to generate stub files for type hinting using pybind11-stubgen and reinstall the package.

```bash
python3 -m pip install pybind11-stubgen==1.1  

  

cd $HOME/Documents/projectaria_sandbox/projectaria_tools  
python3 generate_stubs.py  
cp -r projectaria_tools-stubs/projectaria_tools .  
python3 -m pip install .  
```

--------------------------------

### Start streaming with a sensor profile

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/concepts/sdk_sensor_profiles

Configures the streaming manager with a specific profile name and initiates the streaming process.

```python
streaming_manager = device.streaming_manager  

streaming_config = aria.RecordingConfig()  

streaming_config.profile_name = "profile12"  

streaming_manager.streaming_config = streaming_config  

streaming_manager.start_streaming()  
```

```bash
aria streaming start --profile profile12  
```

--------------------------------

### Start TICSync Recording

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/ticsync_sample

Initiate a synchronized recording session by specifying a server device and multiple client devices with their respective recording profiles.

```bash
python -m ticsync_recording --server <server_serial> profile4 --client <client1_serial> profile16 --client <client2_serial> profile24  
```

--------------------------------

### Launch Tutorial Notebook

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_digital_twin_dataset/advanced_tutorials/multiperson_synchronization

Commands to navigate to the project directory and launch the multi-person synchronization tutorial notebook.

```bash
cd $HOME/Documents/projectaria_sandbox

  

jupyter notebook projectaria_tools/projects/AriaDigitalTwinDatasetTools/examples/adt_multiperson_tutorial.ipynb
```

--------------------------------

### Run the tutorial notebook locally

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_digital_twin_dataset/advanced_tutorials/depth_maps_to_pointcloud

Commands to navigate to the project directory and launch the Jupyter notebook for the depth map to pointcloud tutorial.

```bash
cd $HOME/Documents/projectaria_sandbox  
  
jupyter notebook projectaria_tools/projects/AriaDigitalTwinDatasetTools/examples/adt_depth_maps_to_pointcloud_tutorial.ipynb
```

--------------------------------

### Install projectaria_tools from PyPI

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/getting_started

Upgrade pip and install the projectaria-tools package with all dependencies.

```bash
python3 -m pip  install --upgrade pip  
  
python3 -m pip  install projectaria-tools'[all]'  
```

--------------------------------

### Install Required Python Packages

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/installation_python

Upgrade pip and install the projectaria-tools package with all dependencies.

```bash
python3 -m pip install --upgrade pip  

  

python3 -m pip install projectaria-tools'[all]'  
```

--------------------------------

### Install VRS Tools with Conda

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_formats/aria_vrs/aria_vrs_tools_installation

Use the conda-forge channel to install the vrs package.

```bash
# conda https://conda.io/projects/conda/en/latest/user-guide/install/index.html  

conda install vrs --channel=conda-forge
```

--------------------------------

### Set up dataset directory

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/dataset_download

Create a local directory and move the downloaded JSON metadata file into it.

```bash
mkdir -p $HOME/Documents/projectaria_tools_[your_dataset_name]_data  
  

mv $HOME/Downloads/[your_dataset_name]_download_urls.json $HOME/Documents/projectaria_tools_[your_dataset_name]_data/
```

--------------------------------

### Run the device connection sample

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/device_connection

Command to execute the device connection sample script from the terminal.

```bash
python -m device_connect
```

--------------------------------

### Set up AEA data directory

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_everyday_activities_dataset/aea_download_dataset

Create a local directory and move the downloaded JSON URL file into it.

```bash
mkdir -p $HOME/Documents/projectaria_tools_aea_data  
  
mv $HOME/Downloads/aria_everyday_activities_dataset_download_urls.json $HOME/Documents/projectaria_tools_aea_data/
```

--------------------------------

### Install Android Device Bridge

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/troubleshooting/linux_usb_driver

Use this command to install the necessary ADB tools on Debian-based Linux distributions.

```bash
sudo apt-get android-tools
```

--------------------------------

### Install C++ Dependencies

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/installation_cpp

Install required build tools and libraries for Project Aria Tools on various operating systems.

```bash
# Install build essentials  

sudo apt install build-essential git cmake  

  

# Install VRS/Pangolin dependencies  

sudo apt install libgtest-dev libgmock-dev libgoogle-glog-dev libfmt-dev \

liblz4-dev libzstd-dev libxxhash-dev libboost-all-dev libpng-dev \

libjpeg-turbo8-dev libturbojpeg0-dev libglew-dev libgl1-mesa-dev libeigen3-dev  
```

```bash
# Install build essentials  

sudo dnf install -y git cmake gcc gcc-c++ make  

  

# Install VRS/Pangolin dependencies  

sudo dnf install -y gtest-devel gmock-devel glog-devel fmt-devel lz4-devel \

libzstd-devel xxhash-devel boost-devel libpng-devel libjpeg-turbo-devel \

turbojpeg-devel glew-devel eigen3  
```

```bash
# Install build essentials with Homebrew  

xcode-select --install  

  

brew install git cmake eigen python3 boost fmt googletest \

glog lz4 zstd xxhash libpng jpeg-turbo glew  
```

--------------------------------

### Run TICSync Tutorial Notebook Locally

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/ticsync

Commands to navigate to the project sandbox and launch the TICSync tutorial Jupyter notebook.

```bash
cd $HOME/Documents/projectaria_sandbox  
  
jupyter notebook projectaria_tools/core/examples/ticsync_tutorial.ipynb  
  

```

--------------------------------

### Run visualization notebooks

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_synthetic_environments_dataset/ase_getting_started

Command to launch the Jupyter notebook for the ASE tutorial.

```bash
jupyter notebook projects/AriaSyntheticEnvironment/tutorial/ase_tutorial_notebook.ipynb  
```

--------------------------------

### Operator Summary JSON Example

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_formats/mps/mps_summary

Example of the JSON structure used to report the status, info, warnings, and errors for MPS operators.

```json

  

    "SLAM": {  

        "status": "SUCCESS",  

        "info": [  

            "Recording total time: 1104.00s; Trajectory total length: 155.42m",  

            "Total Vision Translational Correction (mm): p50: 0.048; p99: 0.451",  

            "Rotational Correction (deg): p50: 0.001; p99: 0.007"  

        ],  

        "warnings": [],  

        "errors": []  

    },  

...  



```

--------------------------------

### Create Virtual Environment

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/setup

Initialize a virtual environment to isolate SDK dependencies from the local system.

```bash
python3 -m venv ~/venv
```

--------------------------------

### Configure and connect server device

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/ticsync_sample

Initializes the server device using a DeviceClient and the retrieved serial number.

```python
server_serial = server_serial_and_profile_name[0]  

server_profile_name = server_serial_and_profile_name[1]  

# Set up the server device  

device_client_config.device_serial = server_serial  

device_client.set_client_config(device_client_config)  

# Connect to server device  

server_device = device_client.connect()  
```

--------------------------------

### Get StreamingManager instance

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/device_stream

Access the streaming manager from the device object.

```python
streaming_manager = device.streaming_manager
```

--------------------------------

### Initialize DeviceClient

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/device_connection

Create a new instance of the DeviceClient to manage connections.

```python
device_client = aria.DeviceClient()
```

--------------------------------

### Compile Pangolin for Visualization

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/installation_cpp

Build and install the Pangolin library required for the Aria viewer.

```bash
# compile & install Pangolin  

cd /tmp  

  

git clone --recursive https://github.com/stevenlovegrove/Pangolin.git  

  

mkdir -p Pangolin_Build && cd Pangolin_Build  

  

cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TOOLS=OFF -DBUILD_PANGOLIN_PYTHON=OFF \

-DBUILD_EXAMPLES=OFF ../Pangolin/  

  

make -j2  

  

sudo make install  
```

--------------------------------

### Navigate to SDK samples directory

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples

Use this command to enter the directory where standard Aria Client SDK samples are located.

```bash
cd ~/projectaria_client_sdk_samples
```

--------------------------------

### Set up local directory for DTC DSLR data

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/digital_twin_catalog/digital_twin_catalog_download_dataset

Create a directory to store the downloaded DSLR sequence data.

```bash
mkdir -p $HOME/Documents/projectaria_tools_dtc_dslr  
```

--------------------------------

### Access Compiled Artifacts

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/installation_python

Activate the Pixi shell and verify the installation of the projectaria_tools module.

```bash
# Activate the environment  

pixi shell  
# You can now run and use things from the projects  

python  

import projectaria_tools  

dir(projectaria_tools)  

# Will print  

>>>['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', 'core']  
```

--------------------------------

### Build Pangolin

Source: https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/installation/troubleshooting

Configure and compile the Pangolin library from source.

```bash
cd /tmp/Pangolin_Build  

  

cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TOOLS=OFF -DBUILD_PANGOLIN_PYTHON=OFF \
-DBUILD_EXAMPLES=ON ../Pangolin/  

  

make -j2
```

--------------------------------

### Start and stop recording

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/samples/device_recording

Control the recording duration programmatically using the recording manager.

```python
recording_manager.start_recording()

time.sleep(args.recording_duration)

recording_manager.stop_recording()
```

--------------------------------

### Define BoundingBox2dDataWithDt

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_digital_twin_dataset/data_loader

Example of the templated DataWithDt class used for timestamped data queries.

```cpp
using BoundingBox2dDataWithDt = DataWithDt<TypeBoundingBox2dMap>;
```

--------------------------------

### Create directory for object models

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/aria_digital_twin_dataset/object_models

Sets up the local directory structure required to store the downloaded 3D object models.

```bash
mkdir -p $HOME/Documents/adt_object_library
```

--------------------------------

### Control device operations

Source: https://facebookresearch.github.io/projectaria_tools/docs/ARK/sdk/cli/api_reference

Commands for listing, getting info, and managing device profiles.

```bash
aria device [OPTIONS] SUBCOMMAND
```

```bash
aria device list
```

```bash
aria device info
```

```bash
aria device status
```

```bash
aria device default-profile [OPTIONS] SUBCOMMAND
```

```bash
--status
```

```bash
--set
```

--------------------------------

### Download sample DSLR sequence via CLI

Source: https://facebookresearch.github.io/projectaria_tools/docs/open_datasets/digital_twin_catalog/digital_twin_catalog_download_dataset

Execute the downloader script to fetch a specific DSLR sequence using the CDN file and sequence label.

```bash
aria_dataset_downloader -c ${PATH_TO_YOUR_DSLR_Sequence_CDN_FILE} \

-o $HOME/Documents/projectaria_tools_dtc_dslr/ \

-l Airplane_B097C7SHJH_WhiteBlue_Lighting001 \

-d 0 1  
```
Tokens:
Raw