This product provides the reference of IoT solution with using RX family, AWS, and FreeRTOS. The RX family is a kind of MCUs provided by the Renesas. You can easily try to run AWS IoT demos using RX family while working with our various other products. Refer to the Getting Started Guide for step by step instructions on setting up your development environment and running demos.
This reference is consist of demo applications, FreeRTOS kernel, middleware provided by AWS and 3rd party, middleware and drivers for RX family provided as the RX Driver Package by the Renesas, files to collaborate Renesas tools such as the IDE e2 studio, and etc. Summary of specifications explains in the following chapters.
- PubSub
- Simple MQTT communication with AWS Management Console
The preceding demos use the following technical elements of the AWS IoT:
- CK-RX65N v2 with:
- Ethernet
The following table indicates name and version of OSS which are used in this reference. The column LTS Until indicates the support period as LTS.
The following table indicates name and version of FIT modules which are used in this reference and version of RX Driver Package in which each FIT module is packaged.
| FIT module | Revision of FIT module | Version of RX Driver Package |
|---|---|---|
| r_bsp | 7.51 | 1.45 |
| r_s12ad_rx | 5.40 | 1.45 |
| r_byteq | 2.10 | 1.37 - 1.45 |
| r_ether_rx | 1.23 | 1.36 - 1.45 |
| r_flash_rx | 5.20 | 1.45 |
| r_sci_rx | 5.30 | 1.45 |
| r_tsip_rx | 1.21 | 1.44 - 1.45 |
RX family of MCU has internal Data Flash Memory, and this references are using the Data Flash to store the data for connecting to the Cloud service.
| Area | Description | Contents | Start address [Size] |
Section name |
|---|---|---|---|---|
| LittleFS management area | It's consist of the filesystem LittleFS, default size is 8960 bytes. You can change size by LFS_FLASH_BLOCK_COUNT. |
IoT const data
|
0x00100000 [8960 bytes (Default)] |
C_LITTLEFS_MANAGEMENT_AREA |
| Free area | It's not used by the demo. Therefore, it's free area for user application. |
User application data | 0x00102300 (Default) [23808 bytes (Default)] |
C_USER_APPLICATION_AREA |
- LittleFS management area
- The demo project uses a maximum of 8960 bytes of Data Flash from address 0x00100000 to 0x001022FF using LittleFS.
- If this area is less than 8960 bytes, the demo will not work properly.
- You must NOT overwrite other data against IoT const data in this area.
- If you intend to read/write user application data in this area, incrsease the value of
LFS_FLASH_BLOCK_COUNTin the "Projects\...\frtos_config\rm_littlefs_flash_config.h".LFS_FLASH_BLOCK_COUNTmust be specified 71 ( == 9088 bytes) or more and 256 (32768 bytes, it is Data Flash size) or less.- You must use LittleFS's API to read/write this area.
- When increasing
LFS_FLASH_BLOCK_COUNT, you must also reset the address of the section for free area(C_USER_APPLICATION_AREA) considering the increased LittleFS management area.
Open the project by e2 studio of IDE --> Right-click on the project at the project explore --> properties --> C/C++ Build --> Settings --> Section- If you do not set up a section, the demo may not work properly.
- The demo project uses a maximum of 8960 bytes of Data Flash from address 0x00100000 to 0x001022FF using LittleFS.
- Free area
- The remaining area on Data Flash, 23808 bytes of Data Flash area at address 0x00102300 or above, can be used as user application area.
- You must use FLASH FIT module's API to write this area.
- The remaining area on Data Flash, 23808 bytes of Data Flash area at address 0x00102300 or above, can be used as user application area.
The following figure indicates how memory in Data Flash in CK-RX65N v2 is used for each example of LFS_FLASH_BLOCK_COUNT value.
In case of `LFS_FLASH_BLOCK_COUNT` == 70 (8960 bytes)
+----------------------------+-------------------------+ <- 0x00100000
| LittleFS management area | IoT const data | <8960 bytes>
+----------------------------+-------------------------+ <- 0x00102300
| Free area | User application data | <23808 bytes>
| | |
+----------------------------+-------------------------+ <- 0x00107FFF
In case of `LFS_FLASH_BLOCK_COUNT` == 170 (21760 bytes)
+----------------------------+-------------------------+ <- 0x00100000
| LittleFS management area | IoT const data | <21760 bytes>
| | User application data |
+----------------------------+-------------------------+ <- 0x00105500
| Free area | User application data | <11008 bytes>
+----------------------------+-------------------------+ <- 0x00107FFF
-
CLI task cannot run after starting the demo to avoid the SCI conflict.
-
This demo doesn't support with OTA and Fleet Provisioning.
-
The following macros are not supported by this source code.
LFS_NO_MALLOC
LFS_THREADSAFE
If you build the above macros, a build error will occur. -
Limitations on the xGetMQTTAgentState() function
In the following case, the xGetMQTTAgentState() function for monitoring the communication status returns the state of established MQTT connection with AWS (MQTT_AGENT_STATE_CONNECTED) without detecting the disconnection:
The hook function *1 is called by occuring an error of a TCP_Sockets API *2 (disconnection with AWS) inner the xGetMQTTAgentState(), then this hook restores the connection to established state.
*1 The hook function defined in USER_TCP_HOOK_FUNCTION macro in src/frtos_config/user_tcp_hook_config.h
*2 TCP_Sockets API is a function defined in TCP_Sockets_xxxx -
Notes on redundant linker section after generating code with Smart Configurator.
After generating code with Smart Configurator, sections 'C_FIRMWARE_UPDATE_CONTROL_BLOCK' and 'C_FIRMWARE_UPDATE_CONTROL_BLOCK_MIRROR' will be created at address 0x00100000.
These sections are redundant, it does not impact memory usage of the project.
This behavior is according to the specification of r_tsip_rx FIT module (from version 1.17.l). -
Limitations on transmission with multiple sockets
If using multiple sockets and one of socket happens error,
Reset Hookfunction is executed. In this case, all socket information is removed, while the remaining socket attempts to send or receive data. The communication in this socket will not work properly. Do not use multiple sockets with Reset Hook function. -
Socket wrapper/TCP_socket_hook works in single thread. Do not trigger
TCP_socket_hookin multiple threads. -
Limitations on using the LittleFS module
The LittleFS is not thread-safe.
Calling the LittleFS API from multiple tasks is prohibited. -
When you connect to a GCC project in the debugger using e2 studio version
2024-10, you may see the following error message:
Exception occurred during launch
In this case, you can make a debug connection by performing the following steps.- Click the following from the e2 studio menu.
Help->About e2 studio - Click the button
Installation Detailsat the bottom left of theAbout e2 studiowindow. - Click the tab
Support Folders - Click the link
e2 studio support Area - Open the following folders from the opened Windows Explorer screen.
\DebugComp\RX\RtosPlugins - Delete the following files:
FreeRtosDll.dll
- Click the following from the e2 studio menu.
-
The configuration values of the FIT modules that have been changed from the default values are listed in the table below.
-
However, each projects is evaluated only with preset values, including configuration values that have not been changed from the default values.
-
If changed, the program may not work properly.
FIT module Config name Default Value Project value Reason for change r_bsp BSP_CFG_HEAP_BYTES 0x400 0x2000 Because LittleFS and fleet provisioning demo uses malloc which is not an OS feature.
Also, because the default value cannot secure enough heap memory.BSP_CFG_CODE_FLASH_BANK_MODE 1 0 This project uses the Dual bank function. BSP_CFG_RTOS_USED 0 1 This project uses FreeRTOS. BSP_CFG_SCI_UART_TERMINAL_ENABLE 0 1 This project uses SCI UART terminals. BSP_CFG_SCI_UART_TERMINAL_CHANNEL 8 5 This project uses SCI CH5 as the SCI UART terminal. BSP_CFG_EXPANSION_RAM_ENABLE 1 1* *This macro is set to "1" by default.
It is included in this table as a note, we used EXRAM area in GCC project to avoid overflow of RAM area.r_ether_rx ETHER_CFG_MODE_SEL 0 1 This value depends on the CK-RX65N v2 PHY-LSI and circuit specifications. ETHER_CFG_CH0_PHY_ADDRESS 0 5 This value depends on the CK-RX65N v2 PHY-LSI and circuit specifications. ETHER_CFG_EMAC_RX_DESCRIPTORS 1 6 Settings to prevent descriptor exhaustion when sending and receiving Ethernet frames. ETHER_CFG_EMAC_TX_DESCRIPTORS 1 3 Settings to prevent descriptor exhaustion when sending and receiving Ethernet frames ETHER_CFG_CH0_PHY_ACCESS 1 0 This value depends on the CK-RX65N v2 PHY-LSI and circuit specifications. ETHER_CFG_LINK_PRESENT 0 1 This value depends on the CK-RX65N v2 PHY-LSI and circuit specifications. ETHER_CFG_USE_PHY_ICS1894_32 0 1 This value depends on the CK-RX65N v2 PHY-LSI and circuit specifications. r_flash_rx FLASH_CFG_CODE_FLASH_ENABLE 0 1 OTA library rewrites code flash. FLASH_CFG_DATA_FLASH_BGO 0 1 LittleFS is implemented to rewrite data flash using BGO functionality. FLASH_CFG_CODE_FLASH_BGO 0 1 OTA library is implemented to rewrite code flash using BGO functionality. FLASH_CFG_CODE_FLASH_RUN_FROM_ROM 0 1 OTA library is implemented to execute code that rewrites the code flash from another bank. r_sci_rx SCI_CFG_CH1_INCLUDED 1 0 Because CH1 is not used. SCI_CFG_CH5_INCLUDED 0 1 SCI CH5 is used as the SCI UART terminal. SCI_CFG_TEI_INCLUDED 0 1 Transmit end interrupt is used. r_s12ad_rx No change r_tsip_rx No change r_byteq No change
See CONTRIBUTING for more information.
- Source code located in the Projects, Common, Middleware/AWS, and Middleware/FreeRTOS directories are available under the terms of the MIT License. See the LICENSE file for more details.
- Other libraries located in the Middleware directories are available under the terms specified in each source file.
- Each Renesas FIT Modules in RX driver package located in the Projects/xxx/xxx/src/smc_gen are available under the terms of the basically MIT License. See the doc/license of following URL for more details. https://github.com/renesas/rx-driver-package
Visit the following official webpage if having any technical questions.