Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 3.09 KB

Readme.md

File metadata and controls

91 lines (58 loc) · 3.09 KB
Raw

Wirepas SDK

This repository contains Wirepas SDK, which allows the development of an application to be executed on the same chip as Wirepas Stack. This application is often referred as a Single-MCU application.

⚠️

To use the SDK, you need to have access to the Wirepas binaries. You need to have a software license agreement (SLA) with Wirepas to get them. If you would like to become a SLA licensee, please see the right contact from www.wirepas.com/contact

Overview

The following diagram, describes the main components of the SDK.

Main components

Documentation

The documentation for this SDK is written with Doxygen and generated in HTML format.

It is hosted here. You can select the desired version depending on the SDK version you are working on.

Some information is available on this page too, but it is just a subset of what the html documentation contains.

Wirepas binaries

As a Wirepas SLA licensee, you should have received access to protected zipped archive containing the Wirepas binaries. Please extract them at the root of image folder (All the *.a, *.hex and *.conf files must be at the root of this folder).

Environment

This SDK relies on GNU Arm toolchain. To use the SDK you will need to fulfill the following requirements:

  1. A GCC Arm toolchain (version 10.2.1 is recommended)
  2. The make tool
  3. python 3.x
  4. pycryptodome package for python (can be installed with pip)

In order to validate that your environment is correctly configured, you should be able to build the custom_app application.

For more information, please refer to Documentation

How to build an application

This SDK supports multiple target boards. All of them are listed under board folder and can be selected with target_board=<target_board>

This SDK contains multiple application examples that can be found under source folder and can be selected with app_name=<app_name>

⚠️

The first time you'll build an application, you'll be prompted to choose bootloader keys. Once chosen the first time, they will be used for all your images and must be kept secret and in a safe place where they will not be lost or deleted. It is also possible to define keys per application.

To build the custom_app application for pca10040 board, please execute following command.

    make app_name=custom_app target_board=pca10040

After execution of this command, you should find the final_image_custom_app.hex under build/pca10040/custom_app folder.

For more information, please refer to Documentation

License

See LICENSE for full license details.