Giter Club home page Giter Club logo

obstacle-avoidance's Introduction

obstacle-avoidance

dependencies

  • opencv 2.4
  • QT 4.8
  • libusb-1.0-0-dev
  • ZeroMQ 2.2.0

How to build the system

Cloning the repository

  git clone https://github.com/UBCSailbot/obstacle-avoidance.git

If building on Ubuntu or other Debian flavor of Linux

Try running our setup script for debian systems, debiansetup.sh.

  chmod +x debiansetup.sh
  ./debiansetup

In general

  cd obstacle-avoidance
  git submodule update --init --recursive
  mkdir bin
  cd bin
  cmake ..
  make runCoreTests
  make rescale
  make rigRunner

Specific CMake flags for the Pi:

cmake -DDLIB_NO_GUI_SUPPORT=ON -DDLIB_LINK_WITH_SQLITE3=OFF ..
make liveFeeder

Otherwise just

  make liveFeeder

If you have problems

  • check that you've initiated the git submodules
  • check that all dependencies are met
  • re-run cmake ..
  • if all else fails, delete your build directory and try again.

Contributing

Please read the contribution guide.

Structure of the code

The directories src and test should mirror each other. That is, any unit testing code for the file src/a/b.cpp should be in test/a/bTest.cpp.

  • src/ - Source code. For more details, check out the README files in each sub-direcotry.
    • core/ - The foundation of obstacle avoidance. We avoid putting device-specific code here if we can, as it makes it easier to compile the fundamentals.
    • device/ - Drivers for sensors (e.g. Lepton ,LSM9DS0 IMU, USB display for Raspberry Pi, etc.) These can tend to be less platform-agnostic when it comes to compilation, so we leave them in their own compilation unit.
    • main/ - All the files that contain main functions and that are written more or less for their own end (as opposed to for testing).
  • test/ - Testing, including both unit tests and manually-run tests.
    • support/ - Code files that don't run unit tests, but only exist in support of testing.
    • Refer to documentation on src/ for a guide to the other sub-directories here.
  • config/ - Contains configuration files for sensors and software parameters
  • extra/ - Miscellaneous non-testing files
  • lib/ - Third-party libraries
  • resources/ - A few files that are handy to have around, namely for testing
  • scripts/ - A pot-pourri of Python scripts, including those that run the "test rig" for collecting thermal imaging data

Running unit tests

We use gtest as our unit testing framework. The target for running the unit tests is runCoreTests. Assuming you already have a build directory in which cmake has been run, the followwing command will build and run the unit test suite:

make runCoreTests 
./runCoreTests 

obstacle-avoidance's People

Contributors

pcernek avatar derek-lun avatar areksredzki avatar 0xacf avatar aditichak avatar dtrailin avatar amykhosa avatar kielstrang avatar joshuabaker2 avatar joshandrews avatar shikib avatar faithjiang avatar radu33 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.