Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ In the top directory of this repository execute `pip install .`
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`.
Most function return a bool to check whether the execution was successful.

The low-level `CRIController.send_command(...)` method returns a `SentCommand` with a `message_id` and an `answer_event` (`None` when no answer was registered).

### Typical procedure
1. Connect to iRC: `CRIController.connect(...)` Default IP is `192.168.3.11` with port `3920`. 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.
2. If you want to control the robot, acquire active control via `CRIController.set_active_control(True)`.
Expand Down
8 changes: 7 additions & 1 deletion cri_lib/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
.. include:: ../README.md
"""

from .cri_controller import CRIClient, CRIConnector, CRIController, MotionType
from .cri_controller import (
CRIClient,
CRIConnector,
CRIController,
MotionType,
SentCommand,
)
from .cri_errors import (
CRICommandError,
CRICommandTimeOutError,
Expand Down
Loading
Loading