Advertisement

Quick Links

a
RKX-EVK-001and ROHM EVK EVB
ROHM EVK SW User's Guide
The ROHM EVK Platform is an easy-to-use platform that allows evaluation of ROHM products. It supports multiple Host Adapters and connectivity
methods including RKX-A3-EVK-001 which uses CY8CKIT-059 Prototyping Kit or Arduino Uno R3 as a Host Adapter. RKX-A3-EVK-001 is a
highly configurable adapter board that provides an easy-to-use hardware interface for a variety of ROHM products in a plug-and-play fashion.
The ROHM EVK GUI SW, a powerful Windows-based desktop application, is an evaluation kit software that provides an intuitive Graphical User
Interface capable of displaying and logging the real-time product's data and configuring the product functions through a graphical register editor.
This user guide describes usage of the ROHM EVK GUI SW. For the ROHM EVK HW, please refer to the ROHM EVK HW User's Guide.
1

Acronyms

ADC
A/D Converter
GUI
Graphical User Interface
MCU
Micro Controller Unit
ODR
Output Data Rate
PSoC
Programmable SoC (System on Chip)
WU
Wake-Up
2

Definitions

ROHM EVK Platform
Provides the full range of software, hardware and the firmware used for the product evaluation purposes
ROHM EVK SW
The software for product evaluation purposes consists of ROHM EVK GUI SW and ROHM EVK FW
ROHM EVK GUI SW
ROHM Product evaluation software with a graphical user interface running on Windows OS
ROHM EVK FW
Proprietary firmware running on microcontroller-based host adapters
ROHM EVK HW
ROHM EVK EVB connected for example to RKX-EVK-001 board
RKX-EVK-001
RKX-A3-EVK-001 + CY8CKIT-059 Prototyping Kit
RKX-A3-EVK-001
Adapter board designed to interface with the ROHM EVK Evaluation Board and Host adapter board
Accelerometer EVB
Evaluation board with an accelerometer
ADC EVB
Evaluation board with an ADC
ROHM EVK Host adapter
Refers to MCU board hardware that connects computer systems to peripheral devices. The host adapter board
board
requires firmware for communication between the host adapter board and the computer
ROHM EVK EVB
Evaluation board having ROHM Product
© 2022 ROHM Co., Ltd.
1/33
User's Guide
No. 64UG118E Rev.008
Feb.2025

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the EVK SW Series and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Rohm EVK SW Series

  • Page 1: Acronyms

    Interface capable of displaying and logging the real-time product’s data and configuring the product functions through a graphical register editor. This user guide describes usage of the ROHM EVK GUI SW. For the ROHM EVK HW, please refer to the ROHM EVK HW User’s Guide.
  • Page 2: Table Of Contents

    Firmware update for other host adapters ............................. 27 Firmware update procedure for CY8CKIT-059 without ROHM EVK bootloader ................28 Troubleshooting ..............................................29 Communication troubleshooting ................................29 “EVK Mismatch” – state with the ROHM EVK GUI SW ........................30 Known issues ....................................... 30 Appendix .................................................. 30 10.1 Information about RKX-EVK-001 .................................
  • Page 3: Introduction

    EVK GUI SW as typical of software products. Various demo environments can be easily built on top of the ROHM EVK GUI SW. Because of its versatile use, the ROHM EVK GUI SW is used by people in various responsibilities and technical expertise from product development, quality control and marketing.
  • Page 4: Installation

    Click “Register” tab and select the ROHM product, (Figure 8) which is on the EVB, from the “Device name” pull-down menu. Registers of the selected ROHM product are shown the same way as in the data sheet. At this point it is possible to apply read and write operations to any register and parameter of the product.
  • Page 5: First Time Product Family Selection

    First time product family selection The ROHM EVK GUI SW is designed to work with a wide range of ROHM products, including sensors, LED drivers, and more. To ensure you have the right tools for evaluating your specific product, you will be prompted to choose a product family when you launch the software for the first time.
  • Page 6: List Of Common Use Cases

    Product information is organized into groups known as product families, which help the software focus on relevant products under evaluation. These products’ information can be updated, and new product families can be added without installing a new version of the ROHM EVK GUI SW.
  • Page 7: Offline Usage

    ROHM EVK GUI SW The ROHM EVK GUI SW provides generic functionality for evaluating a variety of ROHM products with unified user interface. Some parts of the user interface are always visible, and some of the functionality is under tabs. Since all tabs are dockable it is also possible to view and use several tabs at same time (Figure 7).
  • Page 8: Menu Bar

    Figure 9 ROHM EVK GUI plotter tab Figure 10 Product specific operations in menu bar and sidebar Menu bar Most of the functionality of the ROHM EVK GUI SW is accessible from the menu bar. (Figure 11) Figure 11 ROHM EVK GUI menu bar 7.1.1 File Selecting Exit from File menu will close the ROHM EVK GUI SW.
  • Page 9 Host Adapter with ROHM EVK FW, for example the RKX-EVK-001, is connected. The connectivity options in the Connection menu are based on what is supported by the selected EVB in the Board menu. The ROHM EVK GUI SW remembers the type of last used connection.
  • Page 10 Figure 13 Settings menu 7.1.4.1 Reconfigure Product Family The Reconfigure Product Family menu item opens a dialog (Figure 14) for browsing and selecting different ROHM EVK product families. The dialog displays the available product families along with their update status in three columns.
  • Page 11 7.1.5 Stream The Stream menu can be used to preconfigure applicable ROHM products to operate in certain modes. It can also be used to define how data is received or processed from the ROHM product and shown in the plotter. (7.7) This setup is named Data Stream. The list of Data Streams will change according to the chosen board.
  • Page 12 7.1.6 Board The board menu is used for selecting the ROHM EVK HW that is going to be used. Some EVK HW are product specific, and some can be used for multiple products. In such case, the product can be selected from the “Device name” pull down menu. (Figure 36) After Board is selected, user needs to visually verify from Product Information tab (7.5) that the selection is correct and then confirm the board selection with “Confirm board”...
  • Page 13 Show ODR warning pop up window: Shows notification window if the output sample rate in the plotter is not what is expected. This phenomenon could occur if there are connectivity problems between the ROHM EVK GUI SW and the ROHM product or with high data rates.
  • Page 14 User’s Guide 7.1.8 Help From the Help menu it is possible to access ROHM EVK User’s guides as well as version information about the ROHM EVK GUI SW, ROHM EVK FW and when Product Family information has been updated. Figure 22 Help Menu •...
  • Page 15: Title Bar

    Figure 26 ROHM EVK GUI SW status bar NOTE: Calculated ODR value can vary from the actual ODR value since data is sent from ROHM EVK FW to ROHM EVK GUI SW in bursts which timing is controlled by the operating system. See also (7.1.7) and (7.9).
  • Page 16 Figure 29 Status-view in EVK Connected state NOTE: In this phase it is important to check that the physical ROHM EVK HW corresponds to the image in the Product Information tab (7.5) and the electrical connection is done according to information accordingly.
  • Page 17 Figure 30 Status-view in EVK Ready state If the ROHM EVK FW has not been updated for a while or if a custom version of the ROHM EVK FW is required for the ROHM EVK Host Adapter of the selected ROHM EVK HW, then the status will be “EVK Mismatch”. (Figure 31) The required ROHM EVK FW version can be found on the error_log.txt file which is on the root folder of the ROHM EVK GUI SW installation.
  • Page 18: Product Information Tab

    HW setup are done, the ROHM EVK Platform can be initialized for the ROHM EVK HW by pressing the “Confirm board” button from the Sidebar. (7.4.1) NOTE: if confirming incorrect ROHM EVK HW or if the HW setup is not done according to instructions there is a possibility of physical damage of ROHM EVK HW.
  • Page 19: Register Editor

    Register editor Register Editor tab is shown for ROHM products which has internal registers. Register editor contains Register Editor Toolbar 7.6.1 for common operations and the Register Editor View 7.6.3 for viewing editing register values of selected ROHM product. (Figure 36) Figure 36 ROHM EVK GUI SW register editor tab with opened device name pull-down menu 7.6.1 Operations in register editor toolbar...
  • Page 20 7.6.2 Register polling. Register polling is a functionality for monitoring subsets of registers. In this way, it is possible to monitor the state of the ROHM product via registers. Polling can be started with the “Start” button and stopped with the same button, which during polling operation has text “Stop”. Polling interval can be defined in the corresponding numeric input box.
  • Page 21 • Status: Status of the latest register operation. • Read and Write: Buttons for reading the register value from the ROHM product to register editor and vice versa. • Register values: Register value shown as specified in the datasheet. 7.6.3.1 Register Status field The register status field shows the status of the latest operation for the register.
  • Page 22: Editing Numeric Values

    Plotter tab Plotter tab provides oscilloscope functionality for viewing information from the connected ROHM product. The data to be plotted is selected from the Stream menu (7.1.5). Plotter contains Plotter Toolbar for common operations (7.7.1) and the Plotter view (7.7.2) for viewing numeric values in graphical form.
  • Page 23 Figure 46 FFT plot with RKX-EVK-001/ADC EVB 7.7.3 Product example KXTJ3 wake up detection The KXTJ3 wake-up detection streaming can be selected using RKX-EVK-001/Accelerometer EVB/I2C board configuration (7.1.5.1) by selecting © 2022 ROHM Co., Ltd. No. 64UG118E Rev.008 23/33 Feb.2025...
  • Page 24: Event View Panel

    Event view panel The Event View panel is in the bottom part of the ROHM EVK GUI SW window, if it is enabled from the View menu. (7.1.7) Event view panel shows time stamped communication events between the ROHM EVK GUI SW and the ROHM EVK Host Adapter. This includes for example register read and write operations.
  • Page 25: Keyboard Shortcuts

    Enable/Disable Verify write CTRL + SHIFT + B Reinitialize board (re-execute board initialization messages) ROHM EVK firmware Several MCU boards can be used as a Host Adapter in the ROHM EVK Platform. Most common MCU boards are: • CY8CKIT-059 Infineon •...
  • Page 26 The same procedure can be used also for other Adafruit industries’ MCU boards. NOTE: If ROHM EVK FW is not yet available in the Adafruit Metro M4 MCU board, then the ROHM EVK Programmer must be started separately from the %USERPROFILE%\Documents\ROHM_EVK_v<version number>/ROHM-EVK-GUI/FirmwareProgrammer directory.
  • Page 27: Firmware Update For Other Host Adapters

    Figure 53 Firmware programming done / CY8CKIT-059 Firmware update for other host adapters Sometimes Arduino Uno R3 or nRF52-DK MCU boards are used as ROHM EVK Host Adapter. For these host adapters, the firmware update procedure is different. © 2022 ROHM Co., Ltd.
  • Page 28: Firmware Update Procedure For Cy8Ckit-059 Without Rohm Evk Bootloader

    Firmware update procedure for CY8CKIT-059 without ROHM EVK bootloader For a CY8CKIT-059 MCU board that does not yet have a compatible version of the ROHM EVK Firmware, the initial update must be performed using the Infineon PSoC Programmer tool. This procedure needs to be done only once, provided that the ROHM EVK Firmware has not been previously flashed.
  • Page 29: Troubleshooting

    User’s Guide Troubleshooting In case of connection problems or an application crash, please check the error log file of the ROHM EVK GUI SW. The default path of this file is ..\Documents\ROHM_EVK_v4\ROHM-EVK-GUI\errorlog.txt. Communication troubleshooting 9.1.1 Host adapter communication issues The communication between the ROHM EVK GUI SW and the host adapter may not work for several reasons. The issue can be related to hardware, software, or both.
  • Page 30: Evk Mismatch" - State With The Rohm Evk Gui Sw

    Known issues If you have a previous ROHM EVK GUI version installed already, make sure to close it before running the installer. (5.1) To have the best user experience, it is recommended to use a display resolution of not less than 3440 x 1440.
  • Page 31 10.1.1 Sensor EVB interface with RKX-EVK-001 Sensor Evaluation Board can be connected to RKX-EVK-001 adapter board either with ribbon cable to J5 - ROHM EVK EVB ribbon cable compatible header or directly to J6 - ROHM EVK EVB compatible header.
  • Page 32: List Of Figures

    User’s Guide Figure 57 Interface with ROHM EVK EVB 10.2 List of Figures 1 ROHM EVK SW ............................3 IGURE DOWNLOAD PAGE 2. ROHM EVK GUI SW ..............................4 IGURE ICON 3 ROHM 10 ..................4 IGURE APPLICATION FOLDER IN THE START MENU OF...
  • Page 33 User’s Guide 25 ROHM EVK ..............................15 IGURE TITLE BAR 26 ROHM EVK GUI SW ............................. 15 IGURE STATUS BAR 27 B ..............................16 IGURE OARD PULL DOWN MENU 28 EVK EVK D ......................16 IGURE STATUS VIEW IN ISCONNECTED STATE...
  • Page 34 Specific Applications). Unless otherwise agreed in writing by ROHM in advance, ROHM shall not be in any way responsible or liable for any damages, expenses, or losses incurred by you or third parties arising from the use of ROHM Products for Specific Applications.

This manual is also suitable for:

Rkx-evk-001

Table of Contents