diff --git a/README.md b/README.md index e48bab27094e32b3cc9034d1716735d0d753c27d..66cf0da621aee840c0c00f1f6ea08581acf1b2c0 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,18 @@ Tested on RobotWare version: 1. Clone this repo. 2. Install `protoc` from protobuf. There are [prebuilt binaries available from GitHub](https://github.com/protocolbuffers/protobuf/releases/latest) if `protoc` is not available in your package manager. - 3.Find `egm.proto` in either +3. Find `egm.proto` in either `%LOCALAPPDATA%\ABB\RobotWare\RobotWare_6.XXXXX\utility\Template\EGM\egm.proto` or on the robot. - -3. Run protoc to generate protobuf classes for python. Substitute `$SRC_DIR` for - the location of `egm.proto` +4. Run protoc to generate protobuf classes for python. The output path should be in the subdirectory abb_egm_pyclient inside the repository directory abb_egm_pyclient. ```bash -protoc --python_out=abb_egm_pyclient $SRC_DIR/egm.proto +protoc --python_out=path/to/repo_folder/abb_egm_pyclient path/to/egm.proto ``` -4. Install this package in your environment of choice. +5. Install this package in your environment of choice by running the following inside the repository directory. ```bash -cd abb_egm_pyclient pip install -e . ``` @@ -35,4 +32,13 @@ And on your computer (and your python environment): ```bash python -m abb_egm_pyclient.run --help + +# example given +python -m abb_egm_pyclient.run 6510 joint 30 0 0 20 10 0 0 +``` + +Or import the client from your own code: + +```python +from abb_egm_pyclient import EGMClient ```