QuanserShield2
Quanser Shield v.2

Intel Galileo Gen 2 shield for use with the Quanser 2DSFJE robot. Documentation can be found in the docs/ folder or by accessing the link https://franciscoknebel.github.io/quansershield2/.

Prerequisites

  • Doxygen
    $ sudo apt install doxygen
  • GCC
  • Make

File Hierarchy

  • bin
    • Temporary folder for built program binaries.
  • Boards & Schematics
    • Folder containing project Gerbers, Netlist, Bill of Materials and schematics.
  • docs
    • Project documentation, built with Doxygen.
  • ext
    • External files, used in documentation.
  • include
    • Header Files.
  • init
    • Intel Galileo /etc/init.d files to setup pins.
  • lib
    • Folder for storage of built library files.
  • scripts
    • Scripts used to automate project tasks.
  • src
    • Project source files.

Makefile

Project

  • Compile the full project with make.
  • Clean built files with make clean.

Don't forget to setup environment variables from iss_setup.sh;

Documentation

Compile the project documentation to docs/ folder.

$ doxygen

Then you can open the docs/index.html file and search the Files section for code documentation. To change the docs generation configuration, you need to install the doxygen-gui config and run:

$ doxywizard Doxyfile

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Contributors Contributions

Francisco Knebel
Contributions by FranciscoKnebel

Luciano Zancan Mazzutti
Contributions by lzancan

Rodrigo Dal Ri
Contributions by rodrigodalri

See also the full list of contributors who participated in this project.

License

This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the LICENSE.md file for details.