J5 Robotics API
Project description
j5
j5 Robotics API - Currently under development.
What is j5?
j5 is a Python 3 library that aims to abstract away robotics hardware and provide a consistent API for robotics. It was created to reduce the replication of effort into developing the separate, yet very similar APIs for several robotics competitions. Combining the API into a single library with support for various hardware gives a consistent feel for students and volunteers. This means more time to work on building robots!
How do I use j5?
j5 is designed to never be visible to students. It sits behind the scenes and works magic.
from robot import Robot
r = Robot()
r.motor_boards[0].motors[1] = 0.5
The above code is likely to be familiar to any student who has competed in one of the below competitions. However, it is not a trivial problem to make this code portable across the platforms. For example, the motor board for Student Robotics is a separate board to the brain board, but is built into the same board for HR RoboCon.
j5 lets competition vendors define how the basic parts of the apis are accessed. A robot can thus be constructed from any combination of parts from various organisations.
from j5.boards import BoardGroup
from j5.backends.hw import HardwareBackendGroup
from j5.boards.sr.v4 import PowerBoard, MotorBoard, ServoBoard, Ruggeduino
class Robot:
def __init__(self):
self._backend_group = HardwareBackendGroup()
self.power_board = PowerBoard(self._backend_group)
self.motor_boards = BoardGroup(MotorBoard, self._backend_group)
self.motor_board = self.motor_boards.singular()
self.servo_boards = BoardGroup(ServoBoard, self._backend_group)
self.servo_board = self.servo_boards.singular()
self.ruggeduino = Ruggeduino(self._backend_group)
Competitions
We are working with developers for the following robotics competition to support their hardware(1):
- SourceBots
- Student Robotics
- Hills Road RoboCon
If you are interested in adding support for your hardware, please get in touch.
Design
As this library has to support multiple hardwares, with multiple backends and still have a common api for people to use, it has ended up fairly complex under the hood. The below diagram should help:
How do I contribute to j5?
j5 is being developed by a group of volunteers at the University of Southampton. We welcome contributions and reside in a channel on the SourceBots Slack.
(1): Neither Student Robotics nor Hills Road have officially agreed to use this software for their respective competitions. j5 does not represent any of the competitions listed.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file j5-0.0.2.tar.gz.
File metadata
- Download URL: j5-0.0.2.tar.gz
- Upload date:
- Size: 8.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b900520635d3de567d223419bfb6e308d230b1f25cfcd7ccb1bf6c9e0453cd72 |
|
| MD5 | dfd2d4851321e65590fe17637536af96 |
|
| BLAKE2b-256 | 1f8cb21ba2e98b5f85ba843419f0a3daeba6e66c5412bc6e0ced2b8103d6136f |
File details
Details for the file j5-0.0.2-py3-none-any.whl.
File metadata
- Download URL: j5-0.0.2-py3-none-any.whl
- Upload date:
- Size: 15.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 02575d0dd96606726dc7810080d32f539419db2e2d817a43331cd24912ab0fd0 |
|
| MD5 | f1062d2404c39fcd7e866a29e5f20bc0 |
|
| BLAKE2b-256 | c677fb0f4376fdb191efb8d3be69d60c43ac666c8132265222f076d4bc2d59ff |
