Getting Started with ModusToolbox™

This section provides various documents and links to help get you started working with ModusToolbox™ software.

• Tools package release notes
  • 1. Primary changes
    • 1.1 Expanded device support
    • 1.2 Update to Infineon
    • 1.3 XMC™ simulation tool support
    • 1.4 Application categories in Project Creator
    • 1.5 Improved Machine Learning capabilities
    • 1.6 Single copy of KitProg3 firmware
    • 1.7 Qt software update
    • 1.8 Update shipping toolchain to GNU C/C++ (GCC) 10.3
    • 1.9 External memory via SFDP
    • 1.10 Eclipse IDE Improvements
      • 1.10.1 Integrated Terminal
      • 1.10.2 Import Application shortcut
    • 1.11 Improved custom BSP process
    • 1.12 Configurator updates
  • 2. What’s included
    • 2.1 Supported tool chains
    • 2.2 Supported boards
    • 2.3 Open source
  • 3. Design impact
    • 3.1 New device-configurator-cli executable
    • 3.2 GCC 10 backward-compatibility issue for BTSDK
  • 4. Known issues/limitations
    • 4.1 Installation
    • 4.2 Project Creator
    • 4.3 Proxy
    • 4.4Building/programming/debugging
    • 4.5 Eclipse IDE
    • 4.6 Library Manager
    • 4.7 Device Configurator
    • 4.8 CAPSENSE™ Tuner
    • 4.9 Machine Learning
    • 4.10 Documentation
  • Revision history
• Installation Guide
  • 1. General information
    • 1.1 System requirements
    • 1.2 Uninstall Beta versions
  • 2. Step 1: Download the software
    • 2.1 ModusToolbox™ patches
    • 2.2 Pre-requisites
    • 2.3 SEGGER J-Link
  • 3. Step 2: Install ModusToolbox™ software
    • 3.1 Installing in non-default location
    • 3.2 Installing with previous versions
    • 3.3 Windows
    • 3.4 Linux
    • 3.5 macOS
  • 4. Step 3: Run the Eclipse IDE
  • 5. Default versus advanced Windows installation
  • 6. Installing with spaces in user home directory
    • 6.1 Step 1: Install at a custom path.
    • 6.2 Step 2: Create a variable to specify the path to Tools.
    • 6.3 Step 3: Create a variable to specify the path to cache.
    • 6.4 Step 4: Specify the custom path to use for offline content and manifest.loc.
      • 6.4.1 Offline content path
      • 6.4.2 manifest.loc
  • Revision history
• ModusToolbox™ user guide
  • About this document
    • Version
    • Scope and purpose
    • Intended audience
    • Document conventions
  • 1 Introduction
    • 1.1 what-is-modustoolbox-software
      • 1.1.1 Supported devices
      • 1.1.2 Development tools
      • 1.1.2 Run-time software
    • 1.2 Partner ecosystems
  • 2 Getting started
    • 2.1 Install and configure software
      • 2.1.1 GUI set-up instructions
      • 2.1.2 CLI set-up instructions
    • 2.2 Get help
      • 2.2.1 GUI Documentation
        • 2.2.1.1 Eclipse IDE
        • 2.2.1.1 Configurator and tool guides
      • 2.2.2. Command line documentation
        • 2.2.2.1 make help
        • 2.2.2.2 CLI tools
    • 2.3 Create applications
      • 2.3.1 Project Creator tools
        • 2.3.1.1 Project Creator GUI
        • 2.3.1.2 project-creator-cli
      • 2.3.2 git clone
      • 2.3.3 Typical application contents
        • 2.3.3.1 Application directory
        • 2.3.3.2 mtb_shared directory
    • 2.4 Update BSPs and libraries
      • 2.4.1 Library Manager
      • 2.4.2 make getlibs
    • 2.5 Configure settings for devices, peripherals, and libraries
      • 2.5.1 Configurator GUI tools
      • 2.5.2 Configurator CLI tools
    • 2.6 Write application code
    • 2.7 Build, program, and debug
      • 2.7.1 Use Eclipse IDE
      • 2.7.2 Export to another IDE
      • 2.7.3 Use command line
        • 2.7.3.1 make build
        • 2.7.3.2 make program
        • 2.7.3.3 make debug/qdebug/attach
  • 3 ModusToolbox™ software overview
    • 3.1 Application layers
      • 3.1.1 HAL
      • 3.1.2 PDL
      • 3.1.3 Configurators
    • 3.2 Installation resources
      • 3.2.1 Directory structure
      • 3.2.2 Documentation
        • 3.2.2.1 Release notes
        • 3.2.2.2 Top-level documents
        • 3.2.2.3 Document index page
      • 3.2.3 IDE support
      • 3.2.4 Tools
        • 3.2.4.1 Configurators
        • 3.2.4.2 Other tools
        • 3.2.4.3 Utilities
        • 3.2.4.4 Build system infrastructure
        • 3.2.4.5 Program and debug support
    • 3.3 Code examples
    • 3.4 BSPs & libraries
      • 3.4.1 BSPs
    • 3.5 Libraries
    • 3.6 Product versioning
      • 3.6.1 General philosophy
      • 3.6.2 Tools package versioning
      • 3.6.3 Multiple tools versions installed
      • 3.6.4 Specifying alternate tools version
        • 3.6.4.1 Environment variable
        • 3.6.4.2 Specific project Makefile
      • 3.6.5 Tools and configurators versioning
        • 3.6.5.1 Configurator messages
      • 3.6.6 GitHub libraries versioning
      • 3.6.7 Dependencies between libraries
        • 3.6.7.1 Dependencies via .mtb files
        • 3.6.7.2 Regular C dependencies via #include
  • 4 ModusToolbox™ build system
    • 4.1 Overview
    • 4.2 Application types
    • 4.3 BSPs
    • 4.4 make getlibs
      • 4.4.1 repos
    • 4.5 Adding source files
      • 4.5.1 Auto-discovery
        • 4.5.1.1 .cyignore
        • 4.5.1.2 TOOLCHAIN_<NAME>
        • 4.5.1.3 TARGET_<NAME>
        • 4.5.1.4 CONFIG_<NAME>
        • 4.5.1.5 COMPONENT_<NAME>
        • 4.5.1.6 BSP makefile
        • 4.5.1.7 Multi-project application with imported BSP
    • 4.6 Pre-builds and post-builds
    • 4.7 Program and debug
    • 4.8 Available make targets
      • 4.8.1 General make targets
      • 4.8.2 IDE make targets
      • 4.8.3 Tools make targets
      • 4.8.4 Utility make targets
    • 4.9 Available make variables
      • 4.9.1 Basic configuration make variables
      • 4.9.2 Advanced configuration make variables
      • 4.9.3 BSP make variables
      • 4.9.4 Getlibs make variables
      • 4.9.5 Path make variables
      • 4.9.6 Miscellaneous make variables
  • 5 Board support packages
    • 5.1 Overview
    • 5.2 What’s in a BSP
      • 5.2.1 COMPONENT_BSP_DESIGN_MODUS
      • 5.2.2 COMPONENT
      • 5.2.3 deps subdirectory
      • 5.2.4 docs subdirectory
      • 5.2.5 Support files
      • 5.2.6 <BSP_NAME>.mk
      • 5.2.7 locate_recipe.mk
      • 5.2.8 README/RELEASE.md
      • 5.2.9 BTSDK-specific BSP files
    • 5.3 Creating your own BSP
    • 5.4 Modifying the BSP configuration for a single application
  • 6 Manifest files
    • 6.1 Overview
    • 6.2 Create your own manifest
      • 6.2.1 Overriding the standard super-manifest
      • 6.2.2 Secondary super-manifest
      • 6.2.3 Processing
      • 6.2.4 Conflicting data
    • 6.3 Using offline content
    • 6.4 Access private repositories
  • 7 Using applications with third-party tools
    • 7.1 Import to Eclipse
    • 7.2 Exporting to supported IDEs
      • 7.2.1 Overview
      • 7.2.2 Export to VS Code
        • 7.2.2.1 Prerequisites
        • 7.2.2.2 Process example
        • 7.2.2.3 To debug using KitProg3/MiniProg4
        • 7.2.2.4 To debug using J-Link
      • 7.2.3 Export IAR EWARM (Windows only)
        • 7.2.3.1 Prerequisites
        • 7.2.3.2 Process example
        • 7.2.3.3 To use KitProg3/MiniProg4
        • 7.2.3.4 To use MiniProg4 with PSoC™ 6 single core and PSoC™ 6 256K
        • 7.2.3.5 To use J-Link
      • 7.2.4 Export to Keil µVision 5 (Windows only)
        • 7.2.4.1 Prerequisites
        • 7.2.4.2 Process example
        • 7.2.4.3 To use KitProg3/MiniProg4, CMSIS-DAP, and ULink2 debuggers
        • 7.2.4.4 To use J-Link debugger
        • 7.2.4.5 Program external memory
        • 7.2.4.6 Erase external memory
    • 7.3 Generating files for XMC™ Simulator tool
  • Revision history
• Eclipse IDE
  • Quick Start Guide
    • 1 Download/Install/Run Eclipse IDE
    • 2 Create new application
      • 2.1 Step 1: Open Project Creator tool
      • 2.2 Step 2: Choose Board Support Package (BSP)
      • 2.3 Step 3: Select application
      • 2.4 Step 4: Create application
    • 3. Add/modify application code
    • 4. View device resources
    • 5. Build the Application
    • 6. Program the Device
      • 6.1 Connect the Kit
      • 6.2 Program
    • 7 Debug the program
      • Revision history
  • User Guide
    • About this document
      • Version
      • Scope and purpose
      • Intended audience
      • Document conventions
      • Reference documents
      • 1 Getting started
        • 1.1 Launch Eclipse IDE
        • 1.2 Open Project Creator tool
        • 1.3 Create an application
          • 1.3.1 Choose board support package
          • 1.3.2. Select application
          • 1.3.3 Create application
        • 1.4 Build application
        • 1.5 Program application
        • 1.6 Export/share application
        • 1.7 Import application/code example
          • 1.7.1 Project Creator import option
          • 1.7.2 Eclipse IDE import option
        • 1.8 Search online for code examples
        • 1.9 Search online for libraries/BSPs
        • 1.10 Access training material
      • 2 IDE description
        • 2.1 Project Explorer
        • 2.2 Quick Panel
      • 3 Configure applications
        • 3.1 Modify code
        • 3.2 Use configurators
          • 3.2.1 Launching configurators from the IDE
          • 3.2.2 Launching configurators without the IDE
        • 3.3 Use tools
          • 3.3.1 Launching tools from the IDE
          • 3.3.2 Library Manager
          • 3.3.3 BTSpy and ClientControl
          • 3.3.4 DFU Host tool
        • 3.4 Use integrated terminal
          • 3.4.1 Switch projects
          • 3.4.2 Specify alternate shell
          • 3.4.3 Update local terminal settings
          • 3.4.4 Connect to remote machine/board
        • 3.5 Refresh Quick Panel
        • 3.6 Rename application
        • 3.7 Restore shared directory
      • 4 Build applications
        • 4.1 Build with Make
        • 4.2 Build with IDE
        • 4.3 GCC version
      • 5 Program and debug
        • 5.1 PSoC™ MCU programming/debugging
          • 5.1.1 Launch configurations
          • 5.1.2 Using JTAG interface in MiniProg4
          • 5.1.3 Erasing external memory
          • 5.1.4 Programming eFuse
          • 5.1.5 Debug connection options
          • 5.1.6 Select specific CMSIS-DAP device
            • 5.1.6.1 Selecting by VID and PID
            • 5.1.6.2 Selecting by serial number
            • 5.1.6.3 Selecting by both VID/PID and serial number
          • 5.1.7 Select Specific J-Link Device
          • 5.1.8 KitProg Firmware Loader
          • 5.1.9 Power cycle programming mode with KitProg3_MiniProg4
          • 5.1.10 PSoC™ 4 flash security programming
        • 5.2 AIROC™ Bluetooth® programming/debugging
          • 5.2.1 Program configuration
          • 5.2.2 Attach configurations
          • 5.2.3 Debug settings
        • 5.3 Mbed OS programming/debugging
          • 5.3.1 Launch configurations
          • 5.3.2 Change PyOCD message color
          • 5.3.3 Attach to running target (PyOCD)
      • 6 Mbed OS to ModusToolbox™ flow
        • 6.1 Install and configure Mbed CLI
          • 6.1.1 Install/update PyOCD
          • 6.1.2 Configure compilers
            • 6.1.2.1 GCC
            • 6.1.2.2 Other compilers
        • 6.2 Switch Kit to DAPLink mode
        • 6.3 Create application in Mbed CLI
        • 6.4 Compile application in Mbed CLI (optional)
        • 6.5 Export application from Mbed CLI
        • 6.6 Import Mbed OS application into Eclipse IDE
        • 6.7 Configure Eclipse IDE
          • 6.7.1 Define the workspace pyOCD path
          • 6.7.2 Verify properties settings
        • 6.8 Build, program, debug application
          • 6.8.1 Build
          • 6.8.2 Program
          • 6.8.3 Debug
        • 6.9 Using MiniProg4 in DAPLink mode
      • Revision history
  • Eclipse IDE Survival Guide
    • Project Management
      • Parts of the code example’s readme file are hard to read in the IDE. How do I fix that?
      • How do I set up the IDE to use my preferred markdown editor?
      • How do I find the right Eclipse panel or option when I don’t know where anything is?
      • How do I rename an application?
      • How do I share a project?
      • What is a workspace?
      • How do I create a new/empty workspace?
      • How do I change workspaces?
      • What is a perspective and how does the IDE use them?
      • How can I change to a different perspective?
      • How can I make my own perspective?
      • How do I remove or delete a project from the project explorer?
      • What are workspace settings?
      • How do I share workspace settings across workspaces?
      • What is a working set and why would I want to use one?
      • How do I create a working set?
      • How do I set up dependencies between projects?
      • What does it mean to close a project, and how do I do it?
      • What is the difference between a local file and a linked file, and how do I tell which is which?
      • How do I link to files instead of duplicating files in each project that uses them?
      • How do I launch multiple instances of Eclipse on macOS?
      • Can I use an Eclipse IDE with a version control system?
    • Editor
      • How do I show line numbers?
      • How do I search across all files in a project or workspace?
      • How do I go from a file listed in the project explorer to the actual file in the file system?
      • I have multiple files of the same name open in the editor. How do I tell which project each one belongs to?
    • Build System
      • How do I build an application?
      • What does Build All build?
      • How do I add middleware or a library to a project?
      • How do I set up an application to run on a different kit?
      • What is the project’s makefile and what does it do?
      • Where do I find build settings?
      • What is a build configuration?
      • Where do I specify compiler symbols and defines?
      • How can I tell if a build was successful?
      • How do I terminate a build?
      • I have an error that a symbol (e.g. bool or uint32_t) could not be resolved. What’s going on and what do I do about it?
    • Program/Debug
      • What are run and debug configurations?
      • Where can I view the run and debug configurations?
      • My launch configurations disappeared, what do I do?
      • I copied my project, and now it has two sets of launch configurations. How do I fix that?
      • How do I start a debug session?
      • When I try to program or debug I get a connection error. What do I do?
      • How do I step through assembly code?
      • I like the Debug perspective better. How do I use it by default when I debug?
      • When debugging, how do I see variables, registers, and memory?
      • How do I see local variables?
      • How do I see global variables?
      • How do I see Peripheral registers?
      • How do I edit the values of the variables?
      • When I start a debug session, an editor window appears that tells me there is a break at an address with no debug information available. But the debug* session starts fine. What’s going on and what do I do about it?
      • When I terminate a debug session, the processor stops. How do I stop debugging but leave the processor running
      • How do I remove terminated debug sessions from the Debug view?
      • How do I start debugging without downloading the executable again?
    • Related Categories:
    • Document History
• Training material