legatoproject/legato-af

Legato Open Source Project is an initiative by Sierra Wireless Inc. which provides an open, secure and easy to use Application Framework for embedded devices. The project enables developers who are not experienced in traditional embedded programming to participate in the exponential growth of the "Internet of Things". Visit legato.io to learn more or visit the Legato forum.

Prerequisites

• A maintained Long Term Support (LTS) version of Ubuntu
• Install required packages:

$ sudo apt-get install -y   \
    autoconf                \
    automake                \
    bash                    \
    bc                      \
    bison                   \
    bsdiff                  \
    build-essential         \
    chrpath                 \
    cmake                   \
    cpio                    \
    diffstat                \
    flex                    \
    gawk                    \
    gcovr                   \
    git                     \
    gperf                   \
    iputils-ping            \
    libbz2-dev              \
    libcurl4-gnutls-dev     \
    libncurses5-dev         \
    libncursesw5-dev        \
    libsdl-dev              \
    libssl-dev              \
    libtool                 \
    libxml2-utils           \
    ninja-build             \
    python                  \
    python-git              \
    python-jinja2           \
    python-pkg-resources    \
    python3                 \
    texinfo                 \
    unzip                   \
    wget                    \
    zlib1g-dev

Optional packages: openjdk-8-jdk (for Java support, at least Java 8 is required), doxygen graphviz (for doc generation), xsltproc (for running tests)

• Cross-build toolchain(s)
  For Sierra Wireless platforms, toolchains are available at https://source.sierrawireless.com/resources/legato/downloads/

Installation

Clone from GitHub

Legato uses git-repo as it is distributed as multiple repositories.

1. Install repo:

(on Ubuntu >= 16.04)

$ sudo apt-get install -y repo

OR (on Ubuntu < 16.04)

$ sudo apt-get install -y phablet-tools

OR

$ wget -O ~/bin/repo https://storage.googleapis.com/git-repo-downloads/repo
$ chmod a+x ~/bin/repo

2. Clone the environment:

$ mkdir workspace
$ cd workspace
$ repo init -u git://github.com/legatoproject/manifest
$ repo sync

You can also clone a specific release:

$ repo init -u git://github.com/legatoproject/manifest -m legato/releases/16.07.0.xml
$ repo sync

Install the Legato framework on your development PC

1. Clone it from GitHub or untar a release archive into a directory

2. cd into that directory

3. Run make

Configure your bash shell's environment for the Legato application build tools

Source bin/configlegatoenv:

$ . bin/configlegatoenv

OR, run the interactive bash shell bin/legs:

$ bin/legs

Run on Target Devices

Build support for cross-build targets, run make <target>.

For example, to enable support for the Sierra Wireless WP85xx devices, run make wp85.
Of course, each of these depends on the cross-build toolchain for that target, so ensure that you have the appropriate toolchain installed first.

The path to your toolchain and the prefix of the name of the tools in the toolchain are specified using the xxxxxx_TOOLCHAIN_DIR and xxxxxx_TOOLCHAIN_PREFIX environment variables (where xxxxxx is replaced with the target platform's ID, such as WP85).

If your toolchain is installed somewhere other than the default location under /opt/swi, ensure that the appropriate environment variables are set to tell the build tools where to find your toolchain and what its prefix is.
For example, for Sierra Wireless WP85xx devices, WP85_TOOLCHAIN_DIR must be set to the path of the directory that contains the file arm-poky-linux-gnueabi-gcc, and WP85_TOOLCHAIN_PREFIX must be set to arm-poky-linux-gnueabi--.

Following is a list of supported cross-build targets:

Directory Structure

The top level directory structure is as follows:

./apps - contains source code for apps.

./bin - created by build system and populated with executable files that run on the development host (the host that ran the build).

./build - contains the results of the build. Will be created by the build system.

./build/tools - contains build tools that are built and then used by the build system on the build host to build other things.

./build/<target> - contains the output of a build for a specific target (e.g., ./build/wp85).

./cmake - contains CMake scripts used by the build system to build samples and unit tests.

./components - contains platform-independent components that are used in apps.

./framework - contains the source code for the Legato application framework itself.

./targetFiles - contains some files for installation on target devices that don't need to be built.

./platformAdaptor - contains components that are specific to certain platforms.

./modules - contains other repositories that are extending Legato.

Documentation

Once you have completed the first three installation steps above, you will find a set of HTML documentation under the "Documentation" directory.
Point your web browser at Documentation/index.html to view it:

xdg-open Documentatation/index.html

The latest release documentation is available at: https://docs.legato.io/latest/

Uninstallation

To uninstall Legato from your development PC:

• Delete the directory you unzipped Legato under
• Revert any changes you may have made to your .bashrc, etc. to set up xxxxxx_TOOLCHAIN_DIR environment variables.

_Copyright (C) Sierra Wireless Inc. _