VoR12’s documentation¶
The Vor12 project, a mobile video camera created for object tracking experiments.
Contents:
Introduction¶
The VoR12 project is a mobile video camera. It uses two Dynamixel AX-12 actuators and the OpenCV computer vision library for object tracking experiments.
Note
This project is still in beta stage, so the API is not finalized yet.
Dependencies¶
Note
If you use pip to install VoR12, PyAX-12 and Numpy will be
automatically downloaded and installed (see the following install
section).
OpenCV cannot be installed with pip, thus you have to install it
manually.
Installation¶
Gnu/Linux¶
You can install, upgrade, uninstall VoR12 with these commands (in a terminal):
pip install --pre vor12
pip install --upgrade vor12
pip uninstall vor12
Or, if you have downloaded the VoR12 source code:
python3 setup.py install
Windows¶
You can install, upgrade, uninstall VoR12 with these commands (in a command prompt):
py -m pip install --pre vor12
py -m pip install --upgrade vor12
py -m pip uninstall vor12
Or, if you have downloaded the VoR12 source code:
py setup.py install
VoR12 API¶
VoR12 provides classes which are usable by third party tools.
Note
VoR12 is still in beta stage, so the API is not finalized yet.
Modules:
Developer’s notes¶
Source code¶
The source code is currently available on GitHub under the terms and conditions of the MIT license. Fork away!
Contribute¶
VoR12 is written for Python versions 3.4 and above. Python 2.x is not supported.
The TODO.md file contains the TODO list.
All contributions should at least comply with the following PEPs:
- PEP8 “Python’s good practices”
- PEP257 “Docstring Conventions”
- PEP287 “reStructuredText Docstring Format”
All contribution should be properly documented and tested with unittest and/or doctest.
pylint, pep8 and pyflakes should also be used to check the quality of each module.
Changes¶
- Web site: http://www.jdhp.org/projects_en.html#vor12
- Online documentation: http://vor12.readthedocs.org
- Source code: https://github.com/volab/vor12
- Issue tracker: https://github.com/volab/vor12/issues
- VoR12 on PyPI: https://pypi.python.org/pypi/vor12
In collaboration with http://www.vorobotics.com
Indices and tables¶
Credits¶
Created by Jérémie Decock.
License¶
The VoR12 library is provided under the terms and conditions of the MIT license:
The MIT License
Copyright (c) 2015 Jérémie DECOCK <jd.jdhp@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.