ModusToolbox Version 2.1 Documentation | Cypress Semiconductor
ModusToolbox Version 2.1 Documentation
Sep 26, 2020
This page provides brief descriptions and links to various types of documentation included as part the ModusToolbox 2.1 software.
For ModusToolbox version 2.0 documentation, please click here.
Getting Started Documents
This section contains general documents to install ModusToolbox software, use the IDE, learn tips for using ModusToolbox in Eclipse, and porting applications from other Cypress IDEs.
|ModusToolbox Installation Guide||This document is available online only. It describes how to install the ModusToolbox software on Windows, Linux, and macOS.|
|ModusToolbox Release Notes||Features and Known Issues for the ModusToolbox 2.1 release.|
|ModusToolbox User Guide||This document provides an overall user guide for ModusToolbox GUI and CLI tools, including getting started and exporting to various IDEs, including Visual Studio Code, IAR Embedded Workbench, and Keil µVision.|
|Eclipse IDE for ModusToolbox Quick Start Guide||This is a short step-by-step guide specifically for using the Eclipse-based IDE to create and build applications for ModusToolbox.|
|Eclipse IDE for ModusToolbox User Guide||This guide also focuses on the Eclipse IDE, covering more details about the IDE and software features.|
|Eclipse Survival Guide||This document is also online only. It offers tips on using the Eclipse environment.|
|PSoC® Creator™ to ModusToolbox Porting Guide||Information to port an application from PSoC Creator to ModusToolbox.|
Configurator and Tool Documents
These documents are located in the "tools" directory in each individual configurator and tool "docs" subfolder.
|Project Creator Guide||Covers how to use the stand-alone tool to create projects for ModusToolbox.|
|Library Manager User Guide||Covers how to add/remove BSPs and libraries for your ModusToolbox project.|
|Firmware Loader on GitHub||This is a link to the Firmware Loader tool with the latest version of KitProg3 firmware. Use this tool to upgrade the firmware on your development/evaluation kit.|
|Device Configurator Guide||Covers how to enable and configure platform peripherals, such as clocks and pins, as well as standard MCU peripherals. that do not require their own tool.|
|CapSense Configurator Guide||Covers how to create and configure CapSense widgets and generate code to control the application firmware.|
|CapSense Tuner Guide||Covers how to use the Tuner to debug your CapSense application.|
|QSPI Configurator Guide||Covers how to open or create configuration files, configure memory slots, and generate code for your application.|
|Segment LCD Configurator Guide||Covers how to configure LCDs and generate code for your application.|
|Smart I/O Configurator Guide||Covers how to configure the Smart I/O and generate code for your application.|
|Bluetooth Configurator Guide||Covers how to configure Bluetooth parameters and generate code to control the application firmware.|
|USB Configurator Guide||Covers how to design a USB Full Speed device by configuring the descriptors needed for your application.|
|Library Manager User Guide||Covers how to add/remove BSPs and libraries.|
|Cypress MCU Elf Tool User Guide||Covers how to use the CyMCUElfTool for signing important data structures, merging ELF files, and generating bootloadable data for use with the PSoC 6 MCU Bootloader.|
|Device Firmware Update Host Guide||Covers how to use the Device Firmware Update Host Tool to communicate with a PSoC 6 MCU with a programmed application and perform various actions, such as program new data, verify, and erase.|
|Power Estimator User Guide||Provides an estimate of power consumed by a target device (also called platform).|