You are here

ModusToolbox Version 1.1 Documentation | Cypress Semiconductor

ModusToolbox Version 1.1 Documentation

Last Updated: 
Jun 10, 2020
ModusToolbox contains several different types of documentation. This page provides brief descriptions of these documents and links to open them.
Note: All of these links are for versions of documents included with ModusToolbox 1.1 and the associated SDKs. If you have installed newer versions of the SDKs, you must manually navigate to the newer directory versions to locate documents.
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.
Name Description
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 1.1 release.
ModusToolbox IDE Quick Start Guide Step-by-step guide to create and build starter applications using the IDE.
ModusToolbox IDE User Guide Guide covering more details about the ModusToolbox IDE and software features.
Eclipse Survival Guide This document is also online only. It offers tips on how the ModusToolbox IDE works in the Eclipse environment.
Eclipse Survival Guide This document is also online only. It offers tips on how the ModusToolbox IDE works in the Eclipse environment.
Running ModusToolbox from the Command Line Guide for using the command-line make for ModusToolbox applications. See also Cypress Programmer 2.1 CLI Guide.
Configurator and Tool Documents
These documents are located in the "tools" directory in each individual configurator and tool "docs" subfolder. Links below are to versions provided with Modustoolbox 1.1. If there are newer versions of the SDK installed, there may be newer versions of the configurators and tools.
Name Description
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.
USB Configurator Guide Covers how to design a USB Full Speed device by configuring the descriptors needed 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.
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.
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.
Porting from PSoC Creator Information to port an application from PSoC Creator to ModusToolbox.