Skip to content
This repository has been archived by the owner on Jun 27, 2019. It is now read-only.

Quickstart

Jump to bottom
Bruno Dilly edited this page Jul 19, 2016 · 12 revisions

This guide contains information and steps to use and create applications using the Soletta™ Framework.

Before starting, see the Build requirements.

It is necessary to keep in mind that some of the requirements are optional and it is possible to build Soletta without them, but some features will not be available. For instance, it is possible to build Soletta without [libcurl] (http://https://curl.haxx.se/) but HTTP client features will be disabled (both node types and C API).

If you have one of the following development boards, you may just flash a pre-built image and start to code directly in the board:

Download

  • Since Soletta uses git submodules the best way to get started is to clone the repository. So get a git client and clone the repository:
    $ git clone [email protected]:solettaproject/soletta.git

Or you may use a visual client

Building

In order to have Soletta built and running, do:

$ cd soletta
$ make thirdparty-update
$ make alldefconfig
$ make -j

All the build options are available through the menuconfig rule ($ make menuconfig). To see other options and targets, issue $ make help.

If one wants to test the samples:

$ make samples

This is for compiling on your current host machine. If you want to cross-compile Soletta, please check:

Tips and tricks

The default install prefix is /usr/ so one must have write permission to that directory to be able to run make install. There are two different ways to change the install directory: setting the DESTDIR environment variable ($ make install DESTDIR=/path/to/) or through the menuconfig rule.

If the install directory is not the default one, it will probably be necessary to set some environment variables properly:

$ export LD_LIBRARY_PATH=/path/to/lib/:$LD_LIBRARY_PATH
$ export PKG_CONFIG_PATH=/path/to/lib/pkgconfig:$PKG_CONFIG_PATH

In case of build failure, please check if the support to DTLS is disabled. Currently the support to DTLS is not working and it should not be used. This is the reason why it is disabled by default. If one accidentally has enabled it, please turn this feature off.

$ make menuconfig
Network -> Enable DTLS (Datagram Transport Layer Security) support

Playing with Soletta

There are two paths to create an application using Soletta, using its C API or writing a flow based programming file. The samples directory contains small applications for both cases. Please take a look at the src/samples folder.

Other resources are available in the wiki:

Contributing

Please follow the steps described on Contributing

Clone this wiki locally