Creating and importing a FreeRTOS project - renesas/iot-reference-rx GitHub Wiki
This section shows how to use FreeRTOS projects in e² studio ported to the RX family.
e² studio is the integrated development environment using Eclipse and please visit here to get the e² studio.
The FreeRTOS projects can be created using e² studio's “Create New Project” function.
You can also import the sample programs posted on the Renesas Website, or a cloned project from this repository.
You can develop a FreeRTOS project using e² studio in the following ways.
When you want to start developing a FreeRTOS project from scratch, Renesas recommends to use Create New Project Function.
For the latest information on using Free RTOS projects for RX, please refer to the Getting Start Guide.
-
Create a new FreeRTOS project [Recommended]
- Create a new project in e² studio
-
Importing a FreeRTOS project
- Cloning projects from GitHub (hereafter Cloned project)
- Unzipping sample program of APN zip file (hereafter sample project)
-
Create an Executable project for CC-RX or GCC for Renesas RX.
-
Select "FreeRTOS (with IoT libraries)" in the "RTOS" field to create a FreeRTOS project.
*1: "FreeRTOS (with IoT libraries)(deprecated structure)" in the “RTOS” field is retained for compatibility. It is recommended to select "FreeRTOS (with IoT libraries)" for newly developed software.
*2: If nothing is displayed in the "RTOS version" field, click "Manage RTOS versions" to download the newest version.
*3: If a board that is not supported is selected in the "Target Board" field, the project cannot be created. If there is no "CK-RX65N-V2" in the board selection, click "Download additional boards..." to download the board description file.
-
Transition to the sample project selection dialog (in 202406-LTS-rx-1.0.1 below).
For details on the sample projects, refer to the following documents:- (Ethernet) Minimal sample project:
Performs TCP/IP communication using FreeRTOS Kernel and FreeRTOS-Plus-TCP.
For use with RX Family MCUs other than RX65N, please refer to the Porting Guide.
- (Ethernet) PubSub/MQTT sample project:
Send PubSub message to the AWS IoT Core.
- (Ethernet) Minimal sample project:
Performs TCP/IP communication using FreeRTOS Kernel and FreeRTOS-Plus-TCP.
The following sections show you how to import the downloaded FreeRTOS project into e² studio.
- The instructions in this section are mainly intended for importing such as sample programs in application note, and projects cloned from GitHub.
- The folder names and structures may differ depending on the project where you downloaded.
- Please replace environment specific words such as board name in the figures and description to match your environment.
- The root folder of Amazon FreeRTOS that was downloaded, unzipped, or cloned from GitHub with git is denoted as ${base_folder}.
- ${base_folder} contains demos and tests folders
-
Please put on the project in a place where the path can be shortened such as "c:\ ".
Note that total path length over 256 characters caused e² studio to output an error at Build. - The figure below shows amazon-freertos cloned from GitHub and placed in c:\ws2. In this case, ${base_folder} becomes “C:\ws2\amazon-freertos”
-
Double-click the e² studio icon to launch
-
Select workspace -> Launch
When you have already selected the default folder, this window does not appear. -
Launch e² studio
-
Select the “import” menu from “File” tab.
-
Select “Existing Projects into Workspace” and press “next”.
-
Select the folder the project placed using "browse" button and press the “Select folder”.
The folder depends on the compiler that you will use.- CC-RX
- ${base_folder}/projects/renesas/Board name/e2studio/
- GCC
- ${base_folder}/projects/renesas/Board name/e2studio-gcc/
- CC-RX
-
This figure shows an example of using the following project
Board :CK-RX65N(with CAT.M1 module 'RYZ014A')
Compiler :GCC -
Select the projects to import and press “Finish” Project description:
Functions | Projects |
---|---|
For connection to AWS Cloud Services only | Select aws_demos |
For OTA FW Update | Select aws_demos and boot_loader |
-
This figure shows the case of selecting OTA function.
Note: Don’t select "Copy Projects into workspace" in both cases. -
When close the "Welcome to e² studio" screen using the “Hide” button, the Project Explorer will appear.
↓↓↓
-
Select “clean” from “Project” tab.
- When you imported two projects, select "Clean all projects" check button.
- Select “Start a build immediately” and “Build the entire workspace”, and press “Clean”.
- Check the build is finished successfully completed without any build errors.
It is necessary to register “things” name to AWS IoT Core and register certificates and keys to the FreeRTOS program.
Please configure settings according to the sample program/APN you are using before connecting to AWS.
- When you use a sample program/APN, please refer to the documentation of the sample program/APN how to proceed.
- Please check GettingStartGude for each board when you use AWS Partner Device certified sample programs.
- GettingStartGude and APN documents contain the screenshot and settings. If the information or screenshot is different from your environment, please check the Register device to AWS IoT page.