This project is used to build a <VEE_PORT> for the <BOARD_NAME> development board.
Clone the repository with git clone --recursive <Git repository URL>
.
This directory also contains:
-
CHANGELOG to track the changes in the <VEE_PORT> for <BOARD_NAME>
-
RELEASE NOTES to list:
- the supported hardware,
- the known issues and the limitations,
- the development environment,
- the list of the dependencies and their versions.
-
README BSP recommended for users familiar with the <BOARD_MANUFACTURER> SDK/BSP and advanced usage on how to customize the build process.
Property | Value |
---|---|
Name | <BOARD_NAME> |
Revision | <BOARD_REVISION> |
MCU part number | |
MCU revision | |
MCU architecture | |
MCU max clock frequency | |
Internal flash size | |
Internal RAM size | |
External flash size | |
External RAM size | |
Power supply |
Here is a list of <BOARD_NAME> useful documentation links:
- Board documentation available here
- <BOARD_MANUFACTURER> board Getting Started available here
- Board schematics available here
- MCU Technical Reference Manual available here
- MCU Datasheet available here
- MCU Errata available here
The Architecture version is <MICROEJ_ARCHITECTURE_VERSION>
.
This <VEE_PORT> provides the following Foundation Libraries:
Foundation Library | Version |
---|---|
EDC | <EDC_VERSION> |
BON | <BON_VERSION> |
... | ... |
The <VEE_PORT> is derived into:
- a Mono-Sandbox <VEE_PORT> (default)
- a Multi-Sandbox <VEE_PORT>
- PC with Windows <Windows_version> or Linux (tested with <Linux_distribution_name_and_version>)
- Internet connection to MicroEJ Central Repository
- SDK Dist.
<MICROEJ_SDK_VERSION>
or higher, available here - <BOARD_NAME> board
Install the <BOARD_MANUFACTURER> toolchain as described here.
- C/C++ toolchain name: <C/C++ toolchain name>
- C/C++ toolchain version: <C/C++ toolchain version>
- C/C++ toolchain download link
Please refer to the <BOARD_MANUFACTURER> documentation available here for more details.
- C/C++ toolchain name: <C/C++ toolchain name>
- C/C++ toolchain version: <C/C++ toolchain version>
- C/C++ toolchain download link
Please refer to the <BOARD_MANUFACTURER> documentation available here for more details.
To build the bsp
project, open a
terminal and enter the following command lines:
On Windows:
$ cd "bsp/vee/scripts"
$ build.bat
On Linux / macOS:
$ cd "bsp/vee/scripts"
$ build.sh
The BSP project build is launched. Please wait for the final message:
To flash all build output, run 'make flash' or:
The build script expects the toolchain to be installed at a known
location. You can configure it, if you installed it elsewhere, by overriding
environment variables. The environment variables are declared in the
set_project_env*
script. They can be defined globally by the user or
in the set_local_env*
scripts. When the build.bat
(build.sh
)
scripts is executed, the set_local_env.bat
(set_local_env.sh
) script
is imported if it exists. Create and configure these files to
customize the environment locally. Template files are provided as
example, see set_local_env.bat.tpl
and set_local_env.sh.tpl
.
Note: Please refer to the following public documentation link to get more details on this part:
Please refer to the <BOARD_MANUFACTURER> documentation available here for more details.
<Provide here image(s) of the board showing important things for the board setup (power supply connector, programming connector, logs output connector, jumpers configuration, etc.)>
<The board can be powered by ...>
Please refer to the <BOARD_MANUFACTURER> documentation available here for more details.
The <BOARD_NAME> board can be flashed following the steps below:
- <Step 1>
- <Step 2>
- ...
On Windows:
$ cd "bsp/vee/scripts"
$ run.bat
On Linux / macOS:
$ cd "bsp/vee/scripts"
$ run.sh
The firmware is launched. Please wait for the final message:
<Board flash final message>
<BOARD_MANUFACTURER> build and flash documentation are also available here for more details.
<This <VEE_PORT> uses ...>
Parameter | Value |
---|---|
Baudrate | |
Data bits bits | |
Parity bits | |
Stop bits | |
Flow control |
Please refer to the <BOARD_MANUFACTURER> documentation available here for more details.
<Firmware debugging can be done using ...>
<Firmware profiling analysis with SEGGER SystemView can be done using ...>
Open the VEE Port project in your favorite IDE by selecting the root folder of the cloned repository.
The project contains the following subprojects:
-
vee-port
: Contains the <VEE_PORT> configuration description. Some modules are described in a specific sub-folder / with some optional configuration files (.properties
and / or.xml
). -
bsp
: Contains a ready-to-use BSP software project for the <BOARD_NAME> board, including a project, an implementation of MicroEJ Core Engine (and extensions) port on and the <BOARD_NAME> board support package. -
vee-port/extensions/front-panel
: Contains the board description and images for the Simulator. This project is updated once the <VEE_PORT> is built. -
vee-port/extensions/image-generator
: Contains the Image Generator extension. This project is updated once the <VEE_PORT> is built. -
vee-port/mock
: Contains a Mock. This project is updated once the <VEE_PORT> is built. -
app
: Contains a sample application which uses the <VEE_PORT>.
By default, the <VEE_PORT> is configured as a Mono-Sandbox Evaluation <VEE_PORT> (Please refer to the RELEASE NOTES limitations section for more details).
To build the <VEE_PORT>:
- Run the
app
sample Application on the Simulator or on Device. This automatically builds the <VEE_PORT> and uses it.
The build may take several minutes. The first time, the <VEE_PORT> build requires to download modules that are available on the MicroEJ Central Repository.
Please wait for the Application start, or for the final message:
BUILD SUCCESSFUL
An evaluation license is needed for building an Application. Please refer to https://docs.microej.com/en/latest/SDK6UserGuide/licenses.html#evaluation-licenses for information on how to acquire and activate a license.
<To run a Testsuite on ...>
Each testsuite can be configured in the config.properties
file located at the root of the testsuite project.