Metadata-Version: 2.4
Name: fourier-aurora-client
Version: 0.1.8
Summary: Aurora Python Client - Python client for the Aurora API
Author-email: James <qianyue.zhang@fftai.com>
Requires-Python: >=3.9
Requires-Dist: click>=8.0.0
Requires-Dist: pyyaml>=6.0
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: isort; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Description-Content-Type: text/markdown

# fourier_aurora_client

This is the Python client for **Fourier Aurora** *(Advanced Unified Robot Operation and Resource Architecture)*. It allows you to interact with the Aurora API to retrieve data and perform actions on the Aurora platform. Aurora client can be installed on the robot chest computer or any other devices to communicate with Aurora server.


### Dependencies

- Python >= 3.9

### Installing

```bash
sudo apt install python3-pip
pip install fourier-aurora-client
```

## Usage

Aurora client can be used to interact with Aurora server through DDS protocol. You can send commands to Aurora, receive states and sensor data from Aurora. Before using the client, make sure Aurora server is running on the robot chest computer.

**NOTE: The Domain ID of the client should be the same as that of the server. The default Domain ID of Aurora is 123, which can be configured in the config file when starting the server.**

If you are not familiar with Aurora, please refer to the [Fourier Aurora SDK](https://github.com/FFTAI/fourier_aurora_sdk).