Metadata-Version: 2.1
Name: fourier-grx-client
Version: 0.1.5
Summary: Client library for Fourier GRx series robots
Author-Email: Yuxiang Gao <yuxiang.gao@fftai.com>
License: MIT
Requires-Python: >=3.8
Requires-Dist: numpy>=1.24.4
Requires-Dist: msgpack>=1.0.8
Requires-Dist: msgpack-numpy>=0.4.8
Requires-Dist: eclipse-zenoh==0.11.0rc3
Requires-Dist: loguru>=0.7.2
Requires-Dist: rich>=13.8.0
Description-Content-Type: text/markdown

# fourier-grx-client

This is the client library for the Fourier GRX robot.
The correponding server library can be found [here](https://pypi.org/project/fourier-grx/0.1.1rc6/).

## Installation

> [!IMPORTANT]
> This software is highly unstable and subject to change at any time. Version 0.1.5 is only compatible with `fourier-grx` version `v0.1.1-rc.6`.

### On the robot

On the robot, install `fourier-grx==0.1.0rc6` following the instructions [here](https://github.com/FFTAI/Wiki-GRx-Deploy/tree/0.1.0rc6).

### On your local machine:

#### Install from pypi

Run:

```bash
pip install fourier-grx-client==0.1.5
```

#### Install from source

```bash
git clone https://github.com/FFTAI/fourier-grx-client.git
cd fourier-grx-client
pip install -e .
```

## Usage

First make sure you know the IP address of the robot server and the namespace it is running on.
Then you can create a client object like this:

```python
from fourier_grx_client import *

r = RobotClient(namespace="gr/my_awesome_robot", server_ip="192.168.6.6")
```

> [!TIP]
> For more information on the API, see the [API Reference](https://fftai.github.io/fourier-grx-client/latest/reference/api/).


## Development

1. Install the `pdm` package manager:

```bash
pip install pdm
```

2. use `pdm` to install the package and all development dependencies:

```bash
pdm install -v -d
```