Skip to main content

Student Robotics API for Python 3

Reason this release was yanked:

Invalid rebase before publication. Please use 2023.0.0.dev2

Project description

sr.robot3

Tests PyPI version MIT license Bees

Student Robotics API for Python 3

This package uses PEP420-style namespace packaging.

Development

Requirements

This project uses the Poetry dependency and virtualenv manager.

You will also need:

  • Python 3.6+
  • Make

Setup

  • Clone the repository from GitHub to a folder on your local machine
  • cd to that folder, and tell Poetry to install dependencies and set up a virtualenv poetry install
  • You can now enter the virtual environment using poetry shell and develop using your IDE of choice.

Tests

The full type, test and lint suite can be run using make: make.

You can also run parts of the suite.

  • Unit tests: make test
  • Unit tests with HTML coverage: make test-cov
  • Linting: make lint
  • Static type checks: make type

Adding camera calibrations

You will need to print off a chAruco marker grid.

opencv_interactive-calibration -t=charuco -sz=GRID_SIZE

Replace GRID_SIZE with the length of one of the larger squares (in mm) from the printed marker grid.

Use -ci=1 for specifying camera index if multiple cameras are connected.

Point the camera at the marker grid. Until DF is at or below 30 then press S to save. This will output a cameraParameters.xml file. Place this file in sr/robot3/vision/calibrations named by the camera model.

You will need to add a detection strategy for the camera in to sr/robot3/vision/backend.py.

Contributions

This project is released under the MIT Licence. For more information, please see LICENSE.

The CONTRIBUTORS file can be generated by executing CONTRIBUTORS.gen. This generated file contains a list of people who have contributed to sr.robot3.

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-2023.0.0.dev1.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

sr.robot3-2023.0.0.dev1-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file sr.robot3-2023.0.0.dev1.tar.gz.

File metadata

  • Download URL: sr.robot3-2023.0.0.dev1.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.10.6 Darwin/21.5.0

File hashes

Hashes for sr.robot3-2023.0.0.dev1.tar.gz
Algorithm Hash digest
SHA256 c134fc41101b6ad727f1f2ed21e530d4b84c050e7f64ffaaaa418b645d061ff6
MD5 6cbc901ba03e8151332729b752299bb1
BLAKE2b-256 fe5b3b7eaa83894580a9bf4a0a8673b527834e4bd38437fbdcacfee38ba88605

See more details on using hashes here.

File details

Details for the file sr.robot3-2023.0.0.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for sr.robot3-2023.0.0.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 6cabb7f8bfeb847b056a2b51936cb82f1d3e1da63de6365df62f13a8de793338
MD5 c4e1759b380ebe04097b6e5802747665
BLAKE2b-256 ec9c7d9f8b6bddcb33c40bfd5176f8b6a4175bf4c54bdd6d8640de0b3a85717e

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