diff --git a/README.md b/README.md index eedb94e96590061f4738b8d05a98c9af556e354a..00b276c8fd29fd61e4ef8b359458f473484517ba 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,17 @@ -## omnibot.py +# omnibot.py ## Description This is a python package which allows connection (currently only TCP-based) with the omnibots at the Department of Automatic Control. -Note that this package covers the *client side*. For information about setting up the omnibot, see (link here). +Note that this package covers the *client side*. For information about setting up the omnibot, see [omnibotserver.py](https://gitlab.control.lth.se/processes/omnibot/omnibotserver.py). ## Installation On linux: `pip install git+https://gitlab.control.lth.se/processes/omnibot/omnibot.py` ## Usage + +### Code Import the connection-object with `from omnibot.tcp import Connection`. Use the `with Connection(HOST) as bot:` command, as this will automatically open and close the connection cleanly. To e.g. set the reference speed for servo 1 to 100, use `bot.set_speed(1,100)`. To set all servo speeds at once, use `bot.set_speeds([100,100,100])`. To read positions from the crazyflie, use @@ -55,6 +57,8 @@ from omnibot.Dummybot import run_dummybot HOST = "localhost" run_dummybot(HOST) ``` +### Network +At the department of automatic control, you should be connected to the omnibots via the same router. Currently this has been done with the router with name *robotlab*, where the IP naming conventions for the robots are `192.168.0.10X` for robot with name `omniX`, i.e. omnibot `omni6` has IP `192.168.0.106`. ## Support felix.agner@control.lth.se @@ -66,4 +70,4 @@ Please feel free to improve this as future projects happen at the department. MIT-license. ## Project status -The project is mostly updated when courses using the robots are ongoing. \ No newline at end of file +The project is mostly updated when courses using the robots are ongoing. diff --git a/pyproject.toml b/pyproject.toml index 8fc158d4cfe3b7af322db432e9883409417aee85..8f2302f7753de61370e6587a33a693b33ce81b26 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,5 +18,5 @@ classifiers = [ ] [project.urls] -"Homepage" = "https://gitlab.control.lth.se/processes/omnibot/omnibotclient.py" -"Bug Tracker" = "https://gitlab.control.lth.se/processes/omnibot/omnibotclient.py/issues" +"Homepage" = "https://gitlab.control.lth.se/processes/omnibot/omnibot.py" +"Bug Tracker" = "https://gitlab.control.lth.se/processes/omnibot/omnibot.py/issues"