- Notifications
You must be signed in to change notification settings - Fork45
library for iRobot Create 2
License
MomsFriendlyRobotCompany/pycreate2
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
A python library for controlling theiRobotCreate 2. This was usedin ECE 387 Introduction to Robotics class I taught at the US Air Force Academy.
- video: robot could only follow the black tap road and couldn't run into anything. If anything got in the way, it had to naviage around it to its final destination
- video: robot pet, follow the pink ball
- video: robot pet, follow the pink ball
The recommended way to install this library is:
pip install pycreate2
If you wish to develop and submit git-pulls, you can do:
git clone https://github.com/walchko/pycreate2cd pycreate2poetry installpoetry run pytest -v
There are multiple ways to command the Create to move, here are someexamples:
frompycreate2importCreate2importtime# Create a Create2.port="/dev/serial"# where is your serial port?bot=Create2(port)# Start the Create 2bot.start()# Put the Create2 into 'safe' mode so we can drive it# This will still provide some protectionbot.safe()# You are responsible for handling issues, no protection/safety in# this mode ... becarefulbot.full()# directly set the motor speeds ... move forwardbot.drive_direct(100,100)time.sleep(2)# turn in placebot.drive_direct(200,-200)# inputs for motors are +/- 500 maxtime.sleep(2)# Stop the botbot.drive_stop()# query some sensorssensors=bot.get_sensors()# returns all dataprint(sensors.light_bumper_left)# Close the connection# bot.close()
More examples are found in theexamplesfolder.
Additional notes and documents are in thedocsfolder.
The different modes (OFF, PASSIVE, SAFE, and FULL) can be switchedbetween by calling different commands.
- OFF: The robot is off and can charge, it will accept no commands
- PASSIVE: The robot is in standbye and can charge. It will sendsensor packets, but will not move
- SAFE: The robot will not charge, but you full control over itwith a few exceptions. If the cliff sensors or wheel drop sensorsare triggered, the robot goes back to PASSIVE mode.
- FULL: The robot will not charge and you have full control. Youare responsible to handle any response due to cliff, wheel drop orany other sensors.
Sensor data is returned as anamedtuple
fromcollections
. Theinformation can be accessed as either:
sensors=bot.get_sensors()sensors.wall==sensors[1]# True
Sensor | Range | Index |
---|---|---|
bumps_wheeldrops | [0-15] | 0 |
wall | [0-1] | 1 |
cliff_left | [0-1] | 2 |
cliff_front_left | [0-1] | 3 |
cliff_front_right | [0-1] | 4 |
cliff_right | [0-1] | 5 |
virtual_wall | [0-1] | 6 |
overcurrents | [0-29] | 7 |
dirt_detect | [0-255] | 8 |
ir_opcode | [0-255] | 9 |
buttons | [0-255] | 10 |
distance | [-322768-32767] | 11 |
angle | [-322768-32767] | 12 |
charger_state | [0-6] | 13 |
voltage | [0-65535] | 14 |
current | [-322768-32767] | 15 |
temperature | [-128-127] | 16 |
battery_charge | [0-65535] | 17 |
battery_capacity | [0-65535] | 18 |
wall_signal | [0-1023] | 19 |
cliff_left_signal | [0-4095] | 20 |
cliff_front_left_signal | [0-4095] | 21 |
cliff_front_right_signal | [0-4095] | 22 |
cliff_right_signal | [0-4095] | 23 |
charger_available | [0-3] | 24 |
open_interface_mode | [0-3] | 25 |
song_number | [0-4] | 26 |
song_playing | [0-1] | 27 |
oi_stream_num_packets | [0-108] | 28 |
velocity | [-500-500] | 29 |
radius | [-322768-32767] | 30 |
velocity_right | [-500-500] | 31 |
velocity_left | [-500-500] | 32 |
encoder_counts_left | [-322768-32767] | 33 |
encoder_counts_right | [-322768-32767] | 34 |
light_bumper | [0-127] | 35 |
light_bumper_left | [0-4095] | 36 |
light_bumper_front_left | [0-4095] | 37 |
light_bumper_center_left | [0-4095] | 38 |
light_bumper_center_right | [0-4095] | 39 |
light_bumper_front_right | [0-4095] | 40 |
light_bumper_right | [0-4095] | 41 |
ir_opcode_left | [0-255] | 42 |
ir_opcode_right | [0-255] | 43 |
left_motor_current | [-322768-32767] | 44 |
right_motor_current | [-322768-32767] | 45 |
main_brush_current | [-322768-32767] | 46 |
side_brush_current | [-322768-32767] | 47 |
statis | [0-3] | 48 |
2021-02-22 | 0.8.1 | Cleaned up code |
2020-02-16 | 0.8.0 | Simplified interface and bug fixes |
2020-02-16 | 0.7.7 | Fixed typo with poetry |
2020-02-16 | 0.7.6 | Fixed typo erro inbin |
2020-02-16 | 0.7.5 | Switched to toml and poetry |
2019-06-30 | 0.7.4 | Midi sounds working |
2017-08-26 | 0.7.3 | code clean up and doc updates |
2017-08-26 | 0.7.2 | updates and fixes |
2017-05-26 | 0.5.0 | init and published to pypi |
Copyright (c) 2007 Damon Kohler
Copyright (c) 2015 Jonathan Le Roux (Modifications for Create 2)
Copyright (c) 2015 Brandon Pomeroy
Copyright (c) 2017 Kevin Walchko
Permission is hereby granted, free of charge, to any person obtaining acopy of this software and associated documentation files (the"Software"), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:
The above copyright notice and this permission notice shall be includedin all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESSOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANYCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THESOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
About
library for iRobot Create 2
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors3
Uh oh!
There was an error while loading.Please reload this page.