2.1. EGOS EvalKit User Guide

2.1.1. Introduction

Thank you for having purchased our EvalKit ! This EvalKit will allow you to take hands on EGOS, our IoT dedicated OS, and see how you can build your IoT application using the sensors and modules which are already available. You will also be able to develop your own sensor or module driver if you want, and you can test it on this EvalKit.

But first you will need to setup a few tools to be able to fully operate EGOS, so please read carefully this page.

2.1.2. EvalKit content

As a reminder, this EvalKit includes the following :

  • A STM NUCLEO-L476RG Eval Board
  • An extension board, made by eRTOSgener, allowing to plug up to 3 mikroBUS (https://www.mikroe.com/mikrobus) compatible click-boards https://www.mikroe.com/click
  • A MIKROE-2684 Click Board, based on the STM LSM303AGR Accelerometer & Magnetometer
  • A MIKROE-1997 Click Board, based on the Microchip RN2483 low-power long range LoRa technology transceiver module, from Microchip
  • A 868Mhz antenna, 113mm
  • 2 Mini-USB cables (USB type B to USB type A)
  • 1 year LoRaWAN subscription
  • 1 year subscription to a platform

This Kit is already loaded with a demo application: you simply need to power the Kit by connecting the provided USB cable to a USB Type-A port from a PC or a power supply, and the USB-Type B connector to the Kit, as shown below:

EvalKit-PowerSupply-USB

The demo application will start immediately.

2.1.3. EvalKit Demo application

This application includes 2 different modes:

  • A basic application using only the accelerometer with some LEDs
  • A enhanced application using the accelerometer to trigger LoRa messages transmission, which also includes some LEDs.

For further details about the demo application behavior, please refer to demo_app__master_EGOS_kit.

This demo also includes an UART communication which provides some debug information during its execution. This UART communication is activated by default, you simply need to use the second USB Cable, connecting the USB Type-B side to the "debug print" connector of the EvalKit, and the USB Type-A side to a PC on which is installed your favorite serial terminal (Hecules, teraterm, Docklight, etc.).

NOTE : The "debug print" connector is already connected to a Serial-to-USB converter included in the extension board of the EvalKit, so you don't need to use a Serial-to-USB cable.

EvalKit-Debug-USB

Once it is connected to you PC, launch you favorite serial terminal and configure it using the following parameters:

  • Port: Depends on your machine. On windows, check your peripheral manager to see which COM port is used.
  • Speed: 460800 (can be changed within EGOS)
  • Data: 8 bit
  • Parity: none
  • Stop bits: 1 bit
  • Flow control: none

Then plug the power-supply of the EvalKit or push the reset button on the board. You will see some debug information appearing on the terminal:

TeraTerm-StatupScreen

2.1.4. EGOS Source code access

We provide EGOS source code via GitLab (see https://about.gitlab.com about GitLab Inc.) using our own instance which is available at this address: https://gitlab.ertosgener.com

If you don't have already access to it, please send an email to commerce@ertosgener.com.

Once you have your GitLab credentials, you will have access to a company-dedicated GitLab Group: This group will contain a project which is a copy of the last available release of EGOS. This will be your own copy of EGOS, so you can modify it as you wish.

For more details about GitLab, please refer to GitLab Introduction Wiki page.

2.1.5. Tooling Setup

Before getting hands-on EGOS itself, you need to setup some tools which will allow to visualize, edit and debug the code on the EvalKit. Depending on if you consider yourself a contributor or a user, you can select the level of tooling to install. Simply go to the dedicated Development environment setup documentation page to find all the necessary information to install your working environment.

2.1.6. Tooling Configuration

Once you have installed the appropriate tools mentioned above, you are ready to configure them and take your first-steps with EGOS.

Please follow the Developing and Building EGOS Wiki page to go through all the steps to load EGOS on the EvalKit and execute it.

IMPORTANT NOTE : Please note that the Debug port (SWD) is of "ST-Link" type by default, and shall be configured to "J-Link" to be able to debug using Eclipse. To convert it, you simply need to follow the steps described in our dedicated documentation

2.1.7. EGOS Training

ERTOSGENER can propose training to help you get hands-on EGOS and realize how powerful it is.

If you are interested in such a training, please contact our sales representative at commerce@ertosgener.com.

If you have already planned a training with us, be aware that we will plan a 1 to 1 meeting prior the training to make sure that everything is in place at your side so we can be more efficient during the training session.