Skip to content

Commit 0d0c838

Browse files
committed
extended readme with usage
1 parent 166b4b1 commit 0d0c838

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,24 @@ Python package to interface an igus Robot Control via the CRI protocol.
2424
- CAN Bridge
2525

2626
# Getting Started
27-
An API documentation as HTML can be found in `docs`.
28-
2927
## Installation
3028
Using the library requires no additional libraries, only testing has external dependencies.
3129

3230
In the top directory of this repository execute `pip install .`
3331

32+
## Usage
33+
The library provides the `CRIController` class which is the main interface to controll the iRC. It handles the network connection and starts background threads for keep alive messages and processing of received messages. Movement functions directly return even though the move might not be finisched. If you want to wait for the move to finish, set the `wait_move_finished` parameter to `True`.
34+
Most function return a bool to check whether the execution was successful.
35+
36+
### Typical procedure
37+
1. Connect to iRC: `CRIController.connect(...)` Default IP is `192.168.3.11` with port `3921`. For using the simulation in the iRC desktop software, connect to `127.0.0.1`, most of the time the port in the simulation is `3921`, but can be different. Have a look at the log if you are unable to connect. Check whether connection was successfull via the returned bool.
38+
2. If you want to control the robot, acquire active control via `CRIController.set_active_control(True)`.
39+
3. Enable drives with `CRIController.enable()`
40+
4. Wait unitl axes are ready `CRIcontroller.wait_for_kinematics_ready()`
41+
5. Do some work with your robot, see API documentation for all functionality.
42+
6. Diable drives with `CRIController.disable()`
43+
7. Close connection with `CRIController.close()`
44+
3445
## Examples
3546
See `examples` directory.
3647

0 commit comments

Comments
 (0)