Status | Date | Doc Version | Applicable | Confidentiality |
RELEASE | 21 Mar 2025 | 1.1.0 | All | PUBLIC |
Introduction
From a developer's perspective, having a compiler and a well-configured development environment is essential.
To streamline the compilation process, Wirepas offers a Docker container that includes all necessary tools to compile applications built on our SDKs.
This guide focuses on installing the compilation tools on a Windows 10/11 OS. It also lists necessary tools for manual control over the compilation tasks, if needed.
Note: Getting the Wirepas SDK [1], Building [2] and Flashing [3] the boards is beyond the scope of this document. Please refer to the related document for that information.
Wirepas Tooling
The Docker Approach (Recommended)
- WSL2 installed: Instructions can be found here [4].
- Docker can be downloaded from here [5]: Install it.
- Start your Docker Desktop app.
Note that to facilitate usage of Docker in the WSL terminal, you need to activate the WSL integration in the Docker Engine. This can be found in the Resources / WSL integration item.
- Test Docker installation. In a WSL2 Terminal, type :
docker --version
You should see your docker version printed.
Wirepas provides Docker containers to facilitate the compilation process. You can find the list here [4]. Please note that the selected SDK Builder while compiling the application must be compatible with SDK. Please refer to [3] to have the compatibility matrix.
Now that we have installed the compilation tools, you can download Wirepas SDK [2] and then build your applications [3].
The Manual Set-Up
Docker may not be used due to various reasons in your working environment.
Please find here the guidelines to install the tools to manually compile a Wirepas Application.
- WSL2 installed: Instructions can be found here.
- Install the GCC Arm Toolchain: Selected version must be done accordingly to selected SDK version. Please refer to release notes from your Wirepas Stack version to get the fitted SDK version. Below table provides the compatibility matrix.
- Install Python 3.x:
apt-get install -y python3 python3-pip
- Install the correct version of PyCryptodome using pip and below compatibility matrix:
pip install pycryptodome==VERSION
| SDK v1.2.X | SDK v1.3.x | SDK v1.4.X | SDK v1.5.1+ |
ARM GCC Version: | 7-2017q4 | 10-2020q4 | 10-2020q4 | 10.3-2021.10 |
pycryptodome Version: | 3.9.7 | 3.9.7 | 3.9.7 | 3.16.0 |
To validate the manual installation, you should be able to compile any application from Wirepas SDKs. Download the SDKs from Wirepas GitHub following the instructions provided here [1] and build your applications as per the instructions [2].
[1] https://developer.wirepas.com/support/solutions/articles/77000560721
[2] https://developer.wirepas.com/support/solutions/articles/77000560720
[3] https://developer.wirepas.com/support/solutions/articles/77000465762
[4] https://learn.microsoft.com/en-us/windows/wsl/install
[5] Docker Container for sdk-builder
Revision History
Date | Version | Notes |
06 May 2024 | 1.0.0 | Initial version. |
21 Mar 2025 | 1.1.0 | Document is consolidated. |
Legal Notice
Use of this document is strictly subject to Wirepas’ Terms of Use and Legal Notice.
Copyright © 2025 Wirepas Oy