Get Started

Welcome to the Legato Application Framework. This getting start section will will walk you through

  • installing the framework on your dev machine.
  • configuring your target.
  • creating a couple of simple applications to demonstrate some of our main concepts.

Completing this section will familiarize you with the Legato Application Framework concepts and prepare you to start developing your own components and apps.

Install and Build the Legato Application Framework

The first thing to do to get started is to install the Source Code, Tools and do an initial Build of the Application Framework for your target.

Install and Build the Legato Application Framework from GitHub.

If you need help configuring your target for first time use:

Module Description
Configure Sierra Wireless Module Configure a Sierra Wireless Target
Configure Raspberry Pi Configure the Legato Application Framework for a Raspberry Pi

Develop Components and Apps

We provide two options for development environments:

  • the Legato Application Framework which contains tools to build systems for your target and configure your target through the command line.
  • Developer Studio, that Sierra Wireless has developed to use with officially support releases of the WP Smart Modules.

The Legato Application Framework tools are automatically installed and configured when you go through the setup process and make your first build for a target. To install Developer Studio follow the instructions on the Sierra Wireless Source.

The Framework also comes with a developer mode app, which when installed on a target provides the following tools and settings specific for development:

  • bundles gdbserver executable for use on the target device, allowing step-by-step debugging of Legato apps.
  • runs the tcf-agent, so the target is auto discoverable by Developer Studio.
  • sets the probation period of apps to 10 seconds, to prevent aggressive roll-back.
  • holds a wake lock, so the target won't go to sleep when disconnected from USB.
  • removes the boot count file on startup to disable the boot loop detection feature of Legato.

To install devMode on your target follow these install instructions.

Now you are ready to start developing apps and installing them on your target. We first recommend starting with our HelloWorld tutorial as it walks you through some of the basic concepts and how to create, install and test your first application.

Once you have mastered HelloWorld walk through our HelloIPC tutorials which will demonstrate 3 different ways to create components and applications and how to communicate between components and apps.

Tutorial Description
Develop Apps Create and modify Legato's version of Hello World and learn how to create components and apps and communicate between them

Concepts and Conventions

Now that you are familiar with the basic flow of the Legato Application Framework explore our documentation on our concepts and the programing conventions to create apps and systems with the Legato Application Framework.

Section Description
Concepts Introduction to the Concepts that make up Legato AF
Definition Files Use Definition Files to build systems, Apps, components and drivers
API Files Work with the API files to develop Apps
C Language Standards C Language Coding Standards

Sample Apps and How To's

Our How To section contains useful articles to walk through some of our advance concepts and tools. There is also a repo of Sample Apps that provide demo apps and apps showing how to connect to and consume specific APIs.

Section Description
How To How To and Troubleshooting articles for common features
Sample Apps Sample Applications