Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Multi-Sanbdox Getting Started for STM32F7508-DK #1090

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from
Draft

Add Multi-Sanbdox Getting Started for STM32F7508-DK #1090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d2b042e
Add Multi-Sanbdox Getting Started for STM32F7508
acolleux-microej Oct 25, 2024
79741cb
Fix links
acolleux-microej Oct 25, 2024
cec647a
Add Multi-Sandbox Getting Started
acolleux-microej Oct 28, 2024
2bb5194
Add Kernel Getting Started + update Sandbox Apps Getting Started
acolleux-microej Oct 29, 2024
45f2606
Fix doc build issue
acolleux-microej Oct 30, 2024
f4565b2
Fix Getting Started according to review
acolleux-microej Oct 30, 2024
b44db74
Add introduction schematic to Multi-Sandbox Getting Started
acolleux-microej Oct 30, 2024
b6a2e1c
Apply suggestions from code review
acolleux-microej Oct 30, 2024
37266f2
Fix multiSandboxGettingStartedOverview.png
acolleux-microej Oct 30, 2024
4649058
Update GREEN Kernel version to 2.1.0 (links to be updated later)
acolleux-microej Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion SDK6UserGuide/gettingStarted.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ In case you cannot get hands on your desired starter kit, please contact us, we
:ref:`i.MX RT1170 Evaluation Kit <sdk_6_getting_started_imxrt1170>`
* - |logo_st|
- |image_stm32f7508|
:ref:`STM32F7508-DK Evaluation Kit <sdk_6_getting_started_stm32f7508>`
:ref:`STM32F7508-DK Discovery Kit <sdk_6_getting_started_stm32f7508>`

.. toctree::
:hidden:
Expand All @@ -61,6 +61,56 @@ In case you cannot get hands on your desired starter kit, please contact us, we
gettingStartedIMXRT1170
gettingStartedSTM32F7508


Multi-Sandbox Evaluation
------------------------

This Getting Started serves as a starting point for evaluating
the Multi-Sandboxing capabilities of the MicroEJ technology.

Run Sandboxed Applications on a ready-to-use Multi-Sandbox Executable
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

MicroEJ provides ready-to-use Multi-Sandbox Executables with basic services
for developing Sandboxed Applications and deploying them easily on your Device.

This Getting Started explains how to deploy these Multi-Sandbox Executables on a board
and run Sandboxed Applications on it.

.. list-table::
:widths: 50 50
:header-rows: 0

* - |logo_st|
- |image_stm32f7508|
:ref:`Run Sandboxed Applications on STM32F7508-DK <sdk_6_getting_started_stm32f7508_multisandbox>`

.. _sdk6_getting_started_kernel_green:

Build your own Multi-Sandbox Executable
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This Getting Started is a step-by-step guide explaining how to build a Multi-Sandbox Executable.

This Executable will be built from `Kernel GREEN <https://github.com/MicroEJ/Kernel-GREEN>`__ sources.

Kernel GREEN provides a turnkey Kernel code providing basic services
to develop a Sandboxed Application and deploy it easily on your Device.

.. list-table::
:widths: 50 50
:header-rows: 0

* - |logo_st|
- |image_stm32f7508|
:ref:`Build your own Multi-Sandbox Executable on STM32F7508-DK <sdk_6_getting_started_stm32f7508_kernel_green>`

.. toctree::
:hidden:

gettingStartedSTM32F7508MultiSandbox
gettingStartedSTM32F7508KernelGREEN

VEE Port Examples
-----------------

Expand Down
6 changes: 3 additions & 3 deletions SDK6UserGuide/gettingStartedIMX93.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ Congratulations! You have finished the setup of your environment. You are now re
Build the Executable for i.MX93 Evaluation Kit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To build the Executable of the :guilabel:`Example-Java-Widget` Application, the SDK provides the Gradle :guilabel:`buildExecutable` task.
To build the Executable of the :guilabel:`Example-Java-Widget` Application, the SDK provides the :guilabel:`buildExecutable` Gradle task.

.. note::

Expand Down Expand Up @@ -450,7 +450,7 @@ Going Further

You have now successfully executed a MicroEJ application on an embedded device so what's next?

If you are an application developer you can continue to explore MicroEJ's API and functionalities by running and studying our samples at GitHub:
If you are an application developer you can continue to explore MicroEJ's APIs and functionalities by running and studying our samples at GitHub:

.. list-table::
:widths: 33 33 33
Expand All @@ -469,7 +469,7 @@ You can also learn how to build bigger and better applications by reading our :r

If you are an embedded engineer you could look at our VEE port examples at `GitHub <https://github.com/microej?q=vee&type=all&language=&sort=>`_. And to learn how create custom VEE ports you can read our :ref:`VEE Porting Guide <vee-porting-guide>`.

You can also follow the :ref:`Kernel Developer Guide <kernel-developer-guide>` for more information on our multi-applications framework or read about our powerful wearable solution called :ref:`VEE Wear <vee-wear>`.
You can also follow the :ref:`Kernel Developer Guide <kernel-developer-guide>` for more information on our multi-application framework or read about our powerful wearable solution called :ref:`VEE Wear <vee-wear>`.

Last but not least you can choose to learn about specific topics by following one of our many :ref:`trainings` ranging from how to easily debug application to setting up a Continuous Integration process and a lot of things in between.

Expand Down
18 changes: 9 additions & 9 deletions SDK6UserGuide/gettingStartedIMXRT1170.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The Gradle project should now be imported in IntelliJ IDEA, your workspace conta
Accept the MICROEJ SDK EULA
---------------------------

You may have to accept the SDK EULA if you didn't already do, please have a look at :ref:`sdk_6_eula_acceptation`.
You may have to accept the SDK EULA if you haven't already done it, please have a look at :ref:`sdk_6_eula_acceptation`.

.. _sdk_6_getting_started_rt1170_run_virtual_device:

Expand Down Expand Up @@ -162,7 +162,7 @@ The Virtual Device starts and executes the :guilabel:`Demo-SmartThermostat` appl
:align: center
:scale: 70%

Well done !
Well Done!
-----------

Now you know how to run an application on a Virtual Device.
Expand Down Expand Up @@ -298,12 +298,12 @@ The COM port uses the following parameters:

You can have a look at your application logs with an RS232 Terminal (e.g. `Termite <https://www.compuphase.com/software_termite.htm>`__).

Congratulations, you have finished the setup of your environment. You are now ready to discover how to build and flash a MicroEJ application.
Congratulations! You have finished the setup of your environment. You are now ready to discover how to build and flash a MicroEJ application.

Build the Executable for i.MX RT1170 Evaluation Kit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In order to build the Executable of the :guilabel:`Demo-SmartThermostat` Application, the SDK provides the Gradle :guilabel:`buildExecutable` task.
In order to build the Executable of the :guilabel:`Demo-SmartThermostat` Application, the SDK provides the :guilabel:`buildExecutable` Gradle task.

.. note::

Expand All @@ -323,11 +323,11 @@ In order to build the Executable of the :guilabel:`Demo-SmartThermostat` Applica

Request your Evaluation License:

* Request your Evaluation license by following the :ref:`evaluation_license_request_activation_key` instructions. You will be asked to fill the machine UID you just copied before.
* Request your Evaluation license by following the :ref:`evaluation_license_request_activation_key` instructions. You will be asked to fill the machine UID field with the UID you copied before.

* When you have received your activation key by email, drop it in the license directory by following the :ref:`evaluation_license_install_license_key` instructions (drop the license key zip file to the ``~/.microej/licenses/`` directory).

Now your Evaluation license is installed, you can relaunch your application build by double-clicking on the :guilabel:`buildExecutable` task in the Gradle tasks view. It may takes some time.
Now your Evaluation license is installed, you can relaunch your application build by double-clicking on the :guilabel:`buildExecutable` task in the Gradle tasks view. It may take some time.

The gradle task deploys the Application in the BSP and then builds the BSP using Make.

Expand All @@ -342,7 +342,7 @@ In order to flash the :guilabel:`Demo-SmartThermostat` Application on i.MX RT117

If you are using another IDE than IntelliJ IDEA, please have a look at :ref:`sdk_6_run_on_device` section.

* Double-click on the :guilabel:`runOnDevice` task in the Gradle tasks view. It may takes some time.
* Double-click on the :guilabel:`runOnDevice` task in the Gradle tasks view. It may take some time.

.. figure:: images/gettingStarted/iMXRT1170/getting-started-runOnDevice.png
:alt: runOnDevice task
Expand Down Expand Up @@ -413,7 +413,7 @@ Going Further

You have now successfully executed a MicroEJ application on an embedded device so what's next?

If you are an application developer you can continue to explore MicroEJ's API and functionalities by running and studying our samples at GitHub:
If you are an application developer you can continue to explore MicroEJ's APIs and functionalities by running and studying our samples at GitHub:

.. list-table::
:widths: 33 33 33
Expand All @@ -432,7 +432,7 @@ You can also learn how to build bigger and better applications by reading our :r

If you are an embedded engineer you could look at our VEE port examples at `GitHub <https://github.com/microej?q=vee&type=all&language=&sort=>`_. And to learn how create custom VEE ports you can read our :ref:`VEE Porting Guide <vee-porting-guide>`.

You can also follow the :ref:`Kernel Developer Guide <kernel-developer-guide>` for more information on our multi-applications framework or read about our powerful wearable solution called :ref:`VEE Wear <vee-wear>`.
You can also follow the :ref:`Kernel Developer Guide <kernel-developer-guide>` for more information on our multi-application framework or read about our powerful wearable solution called :ref:`VEE Wear <vee-wear>`.

Last but not least you can choose to learn about specific topics by following one of our many :ref:`trainings` ranging from how to easily debug application to setting up a Continuous Integration process and a lot of things in between.

Expand Down
18 changes: 9 additions & 9 deletions SDK6UserGuide/gettingStartedIMXRT595.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ The Gradle project should now be imported in IntelliJ IDEA, your workspace conta
Accept the MICROEJ SDK EULA
---------------------------

You may have to accept the SDK EULA if you didn't already do, please have a look at :ref:`sdk_6_eula_acceptation`.
You may have to accept the SDK EULA if you haven't already done it, please have a look at :ref:`sdk_6_eula_acceptation`.

.. _sdk_6_getting_started_rt595_run_virtual_device:

Expand Down Expand Up @@ -158,7 +158,7 @@ The Virtual Device starts and executes the :guilabel:`Demo-Wearable-VG` applicat
:align: center
:scale: 70%

Well done !
Well Done!
-----------

Now you know how to run an application on a Virtual Device.
Expand Down Expand Up @@ -294,12 +294,12 @@ The COM port uses the following parameters:

You can have a look at your application logs with an RS232 Terminal (e.g. `Termite <https://www.compuphase.com/software_termite.htm>`__).

Congratulations, you have finished the setup of your environment. You are now ready to discover how to build and flash a MicroEJ application.
Congratulations! You have finished the setup of your environment. You are now ready to discover how to build and flash a MicroEJ application.

Build the Executable for i.MX RT595 Evaluation Kit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In order to build the Executable of the :guilabel:`Demo-Wearable-VG` Application, the SDK provides the Gradle :guilabel:`buildExecutable` task.
In order to build the Executable of the :guilabel:`Demo-Wearable-VG` Application, the SDK provides the :guilabel:`buildExecutable` Gradle task.

.. note::

Expand All @@ -319,11 +319,11 @@ In order to build the Executable of the :guilabel:`Demo-Wearable-VG` Application

Request your Evaluation License:

* Request your Evaluation license by following the :ref:`evaluation_license_request_activation_key` instructions. You will be asked to fill the machine UID you just copied before.
* Request your Evaluation license by following the :ref:`evaluation_license_request_activation_key` instructions. You will be asked to fill the machine UID field with the UID you copied before.

* When you have received your activation key by email, drop it in the license directory by following the :ref:`evaluation_license_install_license_key` instructions (drop the license key zip file to the ``~/.microej/licenses/`` directory).

Now your Evaluation license is installed, you can relaunch your application build by double-clicking on the :guilabel:`buildExecutable` task in the Gradle tasks view. It may takes some time.
Now your Evaluation license is installed, you can relaunch your application build by double-clicking on the :guilabel:`buildExecutable` task in the Gradle tasks view. It may take some time.

The gradle task deploys the MicroEJ application in the BSP and then builds the BSP using Make.

Expand Down Expand Up @@ -352,7 +352,7 @@ In order to flash the :guilabel:`Demo-Wearable-VG` Application on i.MX RT595 Eva

If you are using another IDE than IntelliJ IDEA, please have a look at :ref:`sdk_6_run_on_device` section.

* Double-click on the :guilabel:`runOnDevice` task in the Gradle tasks view. It may takes some time.
* Double-click on the :guilabel:`runOnDevice` task in the Gradle tasks view. It may take some time.

.. figure:: images/gettingStarted/iMXRT595/getting-started-runOnDevice.png
:alt: runOnDevice task
Expand Down Expand Up @@ -424,7 +424,7 @@ Going Further

You have now successfully executed a MicroEJ application on an embedded device so what's next?

If you are an application developer you can continue to explore MicroEJ's API and functionalities by running and studying our samples at GitHub:
If you are an application developer you can continue to explore MicroEJ's APIs and functionalities by running and studying our samples at GitHub:

.. list-table::
:widths: 33 33 33
Expand All @@ -443,7 +443,7 @@ You can also learn how to build bigger and better applications by reading our :r

If you are an embedded engineer you could look at our VEE port examples at `GitHub <https://github.com/microej?q=vee&type=all&language=&sort=>`_. And to learn how create custom VEE ports you can read our :ref:`VEE Porting Guide <vee-porting-guide>`.

You can also follow the :ref:`Kernel Developer Guide <kernel-developer-guide>` for more information on our multi-applications framework or read about our powerful wearable solution called :ref:`VEE Wear <vee-wear>`.
You can also follow the :ref:`Kernel Developer Guide <kernel-developer-guide>` for more information on our multi-application framework or read about our powerful wearable solution called :ref:`VEE Wear <vee-wear>`.

Last but not least you can choose to learn about specific topics by following one of our many :ref:`trainings` ranging from how to easily debug application to setting up a Continuous Integration process and a lot of things in between.

Expand Down
Loading