README.md

[![logo](logo_blaar.png)](http://blaar.org)

Basic Libraries And Applications for Robotics
=====================================
BLAAR is still in active development. It is **not stable yet** and will evolve. Do no hesitate to [ask for improvements or notify issues](https://framagit.org/blaar/blaar/issues).

Basic Libraries for C/C++
-------------------------
- [blc_core](https://framagit.org/blibs/blc_core) : Generic helpers in C or C++ used by all other blaar projects
- [blc_channel](https://framagit.org/blibs/blc_channel) : Tools to use shared memory in synchrone ( in test) and asynchrone mode 
- [blc_image](https://framagit.org/blibs/blc_image) : Manipulate bla_array as images. Can load and save them as png files  
- [blc_program](https://framagit.org/blibs/blc_program) : Parse arguments and interacts with  user in commandline.

Applications for C/C++
----------------------

- [bapps](https://framagit.org/blaar/bapps.git) : Generic tools to manipulate blc_channels (find max, generate oscillators, ...)

Install
=======

Mac OSX
--------

[Video tutorial](http://www.etis.ensea.fr/neurocyber/blaar/videos/blaar_osx_install.mp4)

You need Xcode or a C/C++ compilation (clang, g++, ..). 

Copy past this line in a terminal

    curl -sS https://framagit.org/blaar/blaar/raw/master/developer_tools/install_standard_osx_blaar.sh | bash

You can do [**step by step**](https://framagit.org/blaar/blaar/blob/master/developer_tools/install_standard_osx_blaar.sh) copying command line by command line. This may be useful to better understand and in case where the installer crash.

If you have a problem at compile time it may be due to a bad configuration of your compiler  [**see how to install command line tools mac os x**](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/)


**Optional modules**

    #o_gnuplot : Draw as gnuplot graph, the values of blc_channels
    brew install gnuplot --with-qt
    git submodule add  git submodule add https://framagit.org/blaar/o_gnuplot.git
    
    #f_fftw : Apply fft on the signal. Need fftw
    brew install fftw
    git submodule add https://framagit.org/blaar/f_fftw.git
    
    #i_load_sound : load any kind of sound file. Required libsndfile
    brew install libsndfile
    git submodule add https://framagit.org/blaar/i_load_sound.git
 
    #f_view_channel : gtk interface to view blc_channels (need gtk3, blgtk basic library for gtk3,  will be installed)
    brew install gtk+3 gnome-icon-theme
    git submodule add https://framagit.org/blaar/blgtk.git
    git submodule add https://framagit.org/blaar/f_view_channel.git
    ./install blgtk

Ubuntu
------

Copy past this line in a terminal

    wget -q  -O/tmp/blaar_install.sh  https://framagit.org/blaar/blaar/raw/master/developer_tools/clone_and_install_ubuntu_blaar.sh && bash /tmp/blaar_install.sh; rm /tmp/blaar_install.sh
    

You will be requested at some point to enter your admin password to make the installation.

You can do [**step by step**](https://framagit.org/blaar/blaar/blob/master/developer_tools/clone_and_install_ubuntu_blaar.sh) copying command line by command line. This may be useful to better understand and in case where the installer crash.

**Optional modules** 
To install them, copy past the code in a terminal.

    #o_gnuplot : Draw as gnuplot graphs, the values of blc_channels. Need gnuplot
    sudo apt-get install gnuplot
    git submodule add  git submodule add https://framagit.org/blaar/o_gnuplot.git
    
    #fftw : Apply fft function on signal. Need fftw
    sudo apt-get install fftw
    git submodule add https://framagit.org/blaar/fftw.git
    
    #sndfile : load and save any kind of sound file using libsndfile
    sudo apt-get install libsndfile
    git submodule add https://framagit.org/blaar/sndfile.git
    
    #asound : acquire and produce sound
    sudo apt-get install alsa-sound
    git submodule add https://framagit.org/blaar/asound.git
 
    #f_view_channel : gtk interface to view blc_channels (need gtk3, blgtk basic library for gtk3,  will be installed)
    sudo apt-get install gtk+3
    git submodule add https://framagit.org/blaar/blgtk.git
    ./install blgtk
    git submodule add https://framagit.org/blaar/f_view_channel.git

Adding projects
===============
You will only have basic framework. You should add projects as needed

To add  project use : `git submodule add <project repository>` 

Usage 
=====

    ./run.sh <project directory> [--help] [others args ...]

This automatically compiles the project in release mode and executes it. You do not risk anymore to test a program you forget to recompile.

You have equivalent commands for debugging or editing projects. These scripts are shortcuts and you can manually compile, debug etc. See [developement](development).

You can see an [**example**](https://framagit.org/blaar/blc_core/wikis/home) of manipulating and displaying generic arrays with blc_core

You can create you first project with this example of [image manipulation](https://framagit.org/blaar/blc_image/wikis/home)