Skip to main content

Student Robotics API for Python 3

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sr.robot3-2023.0.0.dev2.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.dev2.tar.gz
Algorithm Hash digest
SHA256 395a9927c6c95b8a625b1859a875ce5093c54c83f3568ccf36096c72a84e4390
MD5 1a6afc46c3d4c866fdf7a136ff590799
BLAKE2b-256 f82270c5edf77f50ec13dc29bdbaa75fcf12b8585f376edb7f56dfc570b50b00

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sr.robot3-2023.0.0.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 d0edc424962334df8eb45215e7161c714a7dc7affec8bb9400ffa9452be23cc2
MD5 bfc0abd902b072a65c397c4e2171969e
BLAKE2b-256 76a67009fe7642769ac378b7ddc487beabce97cf9a9fc360a4cbddeb9411cd65

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