Skip to content

Latest commit

 

History

History
194 lines (118 loc) · 5.73 KB

simplicity_studio.md

File metadata and controls

194 lines (118 loc) · 5.73 KB

Simplicity Studio Development

This describes how to development C++ applications in the MLTK using Silicon Lab's Simplicity Studio.
Using this guide, you can build C++ applications for Silicon Lab's embedded platforms.

NOTES:

  • All of the MLTK C++ source code may be found at: mltk repo/cpp
  • Refer to the example applications documentation for more details about what comes with the MLTK
  • Alternatively, applications may be built for Windows/Linux and embedded targets using Visual Studio Code
Simplicity Studio __5__ is required to run the MLTK

Install Tools

First, we need to install a few tools:

0) Setup OS

.. tab-set::

   .. tab-item:: Windows

      If you're on Windows, enable `long file paths`:
      https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry

      Also install the Visual Studio C++ compiler (this is needed to build some of the 3rd party Python packages for Python 3.10):
      https://visualstudio.microsoft.com/visual-cpp-build-tools/

      Be sure to check the _Desktop Development with C++_ workload in the installer GUI.

   .. tab-item:: Linux

      If you're on Linux, run the following command to install the necessary packages: 

      .. code-block:: shell

         sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
         sudo add-apt-repository -y ppa:deadsnakes/ppa
         sudo apt update
         sudo apt-get -y install build-essential g++-9 cmake ninja-build gdb p7zip-full git-lfs python3-dev python3-venv libusb-1.0-0 libgl1

1) Install CMake

CMake is a build system utility used internally by the MLTK.
Install CMake and ensure it is available on the command PATH
More details here: https://cmake.org/install

2) Install 7-Zip

7-Zip is a file archiver with a high compression ratio.
Several of the assets downloaded by the MLTK are compressed in this format.
More details here: https://www.7-zip.org/download.html

3) Install Python

Install Python 3.9, 3.10, 3.11, or 3.12 64-bit and ensure it is available on the command PATH
More details here: https://www.python.org/downloads

4) Install GIT

If necessary, install Git:
https://git-scm.com/downloads

5) Install Simplicity Studio 5

Download and install Simplicity Studio 5:
https://www.silabs.com/developers/simplicity-studio

Ensure Simplicity Studio is up-to-date before continuing

Install MLTK

Next, we need to install the MLTK:

1) Clone the MLTK repository

# Clone the MLTK GIT repository
git clone https://github.com/siliconlabs/mltk.git

Then navigate to the MLTK repository directory

cd mltk

2) Run the install script

.. tab-set::

   .. tab-item:: Windows

      .. code-block:: shell

         python .\install_mltk.py

   .. tab-item:: Linux

      .. code-block:: shell

         python3 ./install_mltk.py

3) Activate the MLTK Python virtual environment

Activate the MLTK's Python virtual environment:

.. tab-set::

   .. tab-item:: Windows

      .. code-block:: shell

         .\.venv\Scripts\activate.bat

   .. tab-item:: Linux

      .. code-block:: shell

         source ./.venv/bin/activate

After activation, the mltk command should be available on the command-line:

mltk --help

Install the MLTK into the Gecko SDK

The Gecko SDK is the main software stack used by Silicon Lab's embedded targets. The MLTK clones a local copy of the Gecko SDK to mltk/cpp/shared/gecko_sdk. We need to install the MLTK as an "extension" to the locally cloned Gecko SDK so that the MLTK applications are accessible in Simplicity Studio.

To do this, issue the following command:

mltk build gsdk_mltk_extension

Add the MLTK Gecko SDK to Simplicity Studio

After building the GSDK MLTK extension, add the locally cloned Gecko SDK at mltk/cpp/shared/gecko_sdk to Simplicity Studio.

From Simplicity Studio,

  1. On top toolbar, click: Window
  2. The click Preferences
  3. The on the sidebar, expand the Simplicity Studio entry
  4. Click the SDKs entry
  5. Click the Add SDK... button
  6. Populate the Location with the path to the locally cloned GSDK, e.g. <mltk repo root>/cpp/shared/gecko_sdk/v4.3.3
  7. Click: OK
  8. If prompted, click the Trust button to "trust" the locally cloned MLTK GSDK
  9. Click: Apply and Close

At this point, the MLTK Gecko SDK Suite is now available in Simplicity Studio 5.
From the Launcher, select your connected device, then select the Preferred SDK to be: MLTK Gecko SDK Suite
The MLTK example applications should now be available for project creation.

Refer to the Simplicity Studio 5 User Guide for more details about building and running projects.

When creating a new project, if you click the __Link to sources__ option, 
then you can directly edit the MLTK C++ sources from Simplicity Studio. Otherwise, the MLTK
C++ sources will be copied to your Simplicity Studio project directory.

Example Applications

Refer to the Examples Documentation for more details about the applications that come with the MLTK.