Skip to main content

Student Robotics API for Python 3

Project description

sr-robot3

Lint & build PyPI version Documentation Status MIT license Bees

sr-robot3 - Python 3 API for Student Robotics Kit

This is the API for Student Robotics, library for writing Robotics APIs. It will first be deployed at Student Robotics 2024.

Installation

If you wish to install openCV from your package manager, you can install the base package with:

pip install sr-robot3

To install the full package, including openCV, you can install with:

pip install sr-robot3[vision]

Usage

The main entry point for the API is the Robot class. Intantiating this class will automatically detect and connect to any SR v4 boards connected to the device. By default, the Robot class will wait for the start button on the power board to be pressed before continuing.

from sr.robot3 import Robot

r = Robot()

To disable the waiting for the start button, you can pass wait_for_start=False to the constructor. The wait_for_start method needs to be called before the metadata is available.

from sr.robot3 import Robot

r = Robot(wait_for_start=False)

# Setup in here

r.wait_start()

Developer Notes

There are a number of considerations that have been made in the design of this API. Some of these may not be immediately obvious, so they are documented below.

  • The API is designed to raise exceptions for incorrect actions, such as trying to modify the output dictionary or assign a value directly to the motor object.
  • MappingProxyType is used to prevent the user from adding, removing or overwriting keys in any parts of the API that return a dictionary.
  • tuple is used to prevent the user from adding, removing or overwriting items in any parts of the API that would return a list.
  • __slots__ is used to prevent the user from adding, removing or overwriting attributes in any parts of the API.
  • sr.robot3.serial_wrapper.SerialWrapper handles automatic reconnection to the serial port if the connection is lost and impleents 3 retries on any serial operation before raising a BoardDisconnectionError.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sr_robot3-2025.0.1.tar.gz (65.3 kB view details)

Uploaded Source

Built Distribution

sr_robot3-2025.0.1-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

Details for the file sr_robot3-2025.0.1.tar.gz.

File metadata

  • Download URL: sr_robot3-2025.0.1.tar.gz
  • Upload date:
  • Size: 65.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for sr_robot3-2025.0.1.tar.gz
Algorithm Hash digest
SHA256 b815439e576fb3161055cd2b0185153fb3468b4221cea7a68c561ef75501c07d
MD5 93cf6c209ea8a434746ec523a7584cde
BLAKE2b-256 3ef457f2f9dc6009ce4afe20ba203cd6c2dcbbf22069380cddc5584c026ed110

See more details on using hashes here.

File details

Details for the file sr_robot3-2025.0.1-py3-none-any.whl.

File metadata

  • Download URL: sr_robot3-2025.0.1-py3-none-any.whl
  • Upload date:
  • Size: 52.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for sr_robot3-2025.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e2d3ba9016bb893506078a6662c28a592af494d0f7c313dbd74a6ffbe31fe315
MD5 19b9d29c6601ab7b294c18d63e3b6b7b
BLAKE2b-256 4f3f92d456ff82556fd2355957adf65dff627943ed24d98ed9b748ba5e196f67

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page