Skip to content

sonydevworld/spresense

Repository files navigation

twitter spresense handle twitter devworld handle

Welcome to SPRESENSE project

Clone this repository and update submodules.

$ git clone --recursive https://github.com/sonydevworld/spresense.git

Submodules

spresense                  - This repository
|-- nuttx                  - NuttX original kernel + SPRESENSE port
|-- sdk
|   `-- apps               - NuttX original application + SPRESENSE port
`-- externals
    `-- nnablart
      `-- nnabla-c-runtime - Neural Network Runtime library

Update SDK2.x.x to SDK3.x.x

The URL of the submodule (nuttx, sdk/apps) in the spresense repository has been changed since SDK3.0.0. If you cloned the repository before SDK2.x, please run the following instructions to update the URL of the submodule.

$ cd spresense
$ git fetch origin
$ git checkout <remote branch>
$ git submodule sync
$ git submodule update
  • <remote branch>
    • For master branch: origin/master
    • For develop branch: origin/develop

Spresense SDK build instructions

Build instructions are documented at Spresense SDK Getting Started Guide.

Prerequisites

Install the necessary packages and GCC ARM toolchain for cross-compilation.

$ wget https://raw.githubusercontent.com/sonydevworld/spresense/master/install-tools.sh
$ bash install-tools.sh

Build

Go to the folder where you cloned the {SDK_FULL}, and enter the sdk folder name:

$ cd spresense/sdk

Set up the SDK configuration

$ tools/config.py examples/hello

Build the example image:

$ make

A nuttx.spk file appears in the sdk folder when this step has successfully finished. This file is the final result and can be flashed into the your board.

Using docker

A pre-compiled docker container is available with all the pre-requisite that is needed in order to build the Spresense SDK.

In order to start using it simply type:

$ source spresense_env.sh

This script will create an alias spresense which should proceed the regular SDK build scripts and Make commands.

Examples:

SpresenseSDK: $ spresense tools/config.py examples/hello
SpresenseSDK: $ spresense make