PSoC 6 with AnyCloud Logo
  • Getting Started with ModusToolbox
    • ModusToolbox Installation Guide
      • System Requirements
      • Uninstall Beta Versions
      • Step 1: Download the Software
        • ModusToolbox Patches
        • Pre-Requisites
        • SEGGER J-Link
      • Step 2: Install ModusToolbox Software
        • Installing in non-default Location
        • Installing with Previous Versions
        • Windows
        • Linux
        • macOS
      • Step 3: Run the Eclipse IDE
      • Next Steps
      • Default Versus Advanced Windows Installation
      • Installing with Spaces in User Home Directory
        • Step 1: Install at a custom path.
        • Step 2: Create a variable to specify the path to Tools.
        • Step 4: Create a variable to specify the path to cache.
        • Step 5: Specify the custom path to use for Offline Content and manifest.loc.
    • Eclipse IDE for ModusToolbox Quick Start Guide
      • Download/Install ModusToolbox and Run Eclipse IDE
      • Create New Application
        • Step 1: Open Project Creator Tool
        • Step 2: Choose Board Support Package (BSP)
        • Step 3: Select Application
        • Step 4: Create Application
      • Add/Modify Application Code
      • View Device Resources
      • Build the Application
      • Program the Device
        • Connect the Kit
        • Program
      • Debug the Program
      • Next Steps
    • ModusToolbox User Guide
      • Introduction
        • About this Guide
        • What is ModusToolbox?
          • Supported Devices
          • Development Tools
          • Run-Time Software
        • Partner Ecosystems
      • Getting Started
        • Install and Configure Software
          • GUI Set-up Instructions
          • CLI Set-up Instructions
        • Get Help
          • GUI Documentation
            • Eclipse IDE
            • Configurator and Tool Guides
          • Command Line Documentation
            • make help
            • CLI Tools
        • Create Applications
          • Project Creator Tools
            • Project Creator GUI
            • project-creator-cli
          • git clone
          • Typical Application Contents
            • Application Directory
            • mtb_shared Directory
        • Update BSPs and Libraries
          • Library Manager
          • make getlibs
        • Configure Settings for Devices, Peripherals, and Libraries
          • Configurator GUI Tools
          • Configurator CLI Tools
        • Write Application Code
        • Build, Program, and Debug
          • Use Eclipse IDE
          • Export to another IDE
          • Use Command Line
            • make build
            • make program
            • make debug/qdebug/attach
      • ModusToolbox Software Overview
        • Application Layers
          • HAL
          • PDL
          • Configurators
        • Installation Resources
          • Directory Structure
          • Documentation
            • Release Notes
            • Top-Level Documents
            • Document Index Page
          • IDE Support
          • Tools
            • Configurators
            • Other Tools
            • Utilities
            • Build System Infrastructure
            • Program and Debug Support
        • Code Examples
        • BSPs & Libraries
          • Board Support Packages
        • Libraries
        • Product Versioning
          • General Philosophy
          • Tools Package Versioning
          • Multiple Tools Versions Installed
          • Specifying Alternate Tools Version
            • System Variable
            • Eclipse IDE Workspace Setting
            • Specific Project Makefile
          • Tools and Configurators Versioning
            • Configurator Messages
          • GitHub Libraries Versioning
          • Dependencies Between Libraries
            • Dependencies via .mtb files
            • Regular C Dependencies via #include
      • ModusToolbox Build System
        • Overview
        • Application Types
        • BSPs
        • make getlibs
          • repos
        • Adding source files
          • Auto-Discovery
            • .cyignore
            • TOOLCHAIN_<NAME>
            • TARGET_<NAME>
            • CONFIG_<NAME>
            • COMPONENT_<NAME>
            • BSP Makefile
            • Multi-project application with imported BSP
        • Pre-builds and Post-builds
        • Program and Debug
        • Available Make Targets
          • General Make Targets
          • IDE Make Targets
          • Tools Make Targets
          • Utility Make Targets
        • Available Make Variables
          • Basic Configuration Make Variables
          • Advanced Configuration Make Variables
          • BSP Make Variables
          • Getlibs Make Variables
          • Path Make Variables
          • Miscellaneous Make Variables
      • Board Support Packages
        • Overview
        • What’s in a BSP
          • COMPONENT_BSP_DESIGN_MODUS
          • COMPONENT
          • deps Subdirectory
          • docs Subdirectory
          • Support Files
          • <BSP_NAME>.mk
          • locate_recipe.mk
          • README/RELEASE.md
          • BTSDK-Specific BSP files
        • Creating your Own BSP
        • Modifying the BSP Configuration for a Single Application
      • Manifest Files
        • Overview
        • Create Your Own Manifest
          • Overriding the Standard Super-Manifest
          • Secondary Super-Manifest
          • Processing
          • Conflicting Data
        • Using Offline Content
        • Access Private Repositories
      • Exporting to IDEs
        • Overview
        • Import to Eclipse
        • Export to VS Code
          • Prerequisites
          • Process Example
            • To Debug using KitProg3/MiniProg4
            • To Debug using J-Link
        • Export IAR EWARM (Windows Only)
          • Prerequisites
          • Process Example
            • To Use KitProg3/MiniProg4
            • To use MiniProg4 with PSoC 6 Single Core and PSoC 6 256K
            • To Use J-Link
        • Export to Keil µVision 5 (Windows Only)
          • Prerequisites
          • Process Example
            • To Use KitProg3/MiniProg4, CMSIS-DAP, ULink2, and ULink Pro debuggers
            • To Use J-Link debugger
            • Program External Memory
            • Erase External Memory
      • Document Revision History
    • PSoC6 Hello World Example
    • ModusToolbox 101 Training Class
    • Where To Learn More About ModusToolbox
  • PSoC 6 Code Examples
  • Feature Guides
    • Security
      • Secure Boot SDK User Guide
        • 1 Introduction
          • Where to Get the Secure Boot SDK
          • Using this Guide
          • Definition of Terms
          • Revision History
        • 2 Overview
          • Secure Boot SDK Components
          • How Does the Secure Boot SDK Work?
          • What is Provisioning?
            • Transferring RoT
            • Injecting User Assets
            • Re-provisioning User Assets
          • Cypress Secure Bootloader
          • CySecureTools Installation and Documentation
            • Linux
            • macOS
            • Linux
            • Mac OS
        • ModusToolbox – Provisioning Flow
          • Prerequisites
            • ModusToolbox Installation
            • CySecureTools Installation
          • Device Provisioning
            • A. Create Blinky LED FreeRTOS Application Project
            • B. Set Up CySecureTools Workspace
            • C Generate new keys
            • D. (Optional) Run Entrance Exam
            • E. Perform Provisioning
          • Device Re-provisioning
          • ModusToolbox Secure Image Generation
          • Build and Run the Application
          • Debug the application
          • Re-provisioning After Failure
        • 4 Mbed OS – Provisioning Flow
          • Prerequisites
          • Device Provisioning
            • A. Set Up Mbed OS Example Project Folder:
            • B. Generate New Keys:
            • C. Run Entrance Exam (Optional)
            • D. Perform provisioning
          • Device Re-provisioning
          • Building the Mbed OS Blinky Application
          • Debugging Application Code
            • Prerequisites
            • Create Empty C/C++ Application
            • Configure PyOCD GDB Server Path
            • Setting up ‘Program’ PyOCD configuration
            • Setting up ‘Debug’ PyOCD configuration
            • Setting up ‘Erase’ PyOCD configuration
          • Mbed OS Secure Image Generation
          • Signing Generic Images
        • 5 CySecureTools Design
          • CySecureTools Component Diagram
          • CySecureTools Design
            • Creating a Provisioning Packet
          • Understanding the Default Policy
            • Policy and Configuration Limitations
            • Boot&Upgrade Policy
            • Debug Policy
            • External Clock Policy
            • Cypress Bootloader
            • CySecureTools Misc Assets
          • Provisioning JWT packet Reference
            • 1. prov_cmd.jwt
            • 2. prov_identity.jwt
            • 3. cy_auth.jwt
            • 4. rot_auth.jwt
            • 5. prov_req.jwt
            • 6. boot_upgrade.JSON
            • 7. debug.JSON
      • Secure Policy Configurator Guide
        • Overview
        • Definitions
        • Installation
          • Configuring CySecureTools location
        • Quick Start
        • Launch the Secure Policy Configurator
          • As a Stand-Alone Tool
          • From the Eclipse IDE
          • From the Command Line
        • GUI Description
          • Menus
            • File
            • Edit
            • View
            • Execute
            • Help
        • Toolbar
          • Tabs
          • Notice List
          • Log
          • Keys Tab
          • Configuration Tabs
        • Configuration Parameters
        • Certificates Tab
        • Advanced Dialog
        • SysAP Options
        • RMA Options
        • Startup Options
          • Bootloader Options
        • Reprovisioning Options
        • Start WDT in CM0+ (bootloader)
          • WDT timeout (ms)
        • References
        • Version Changes
      • PSoC 64 Secure Blinky LED Example
      • SHA2 with Cryptographic Hardware Block Example
      • AES Encryption/Decryption Example
      • CY Secure Tools
    • BlueTooth Low Energy
      • Getting Started with PSoC 6 MCU with Bluetooth Low Energy (BLE) Connectivity on PSoC Creator
        • 1. Introduction
          • 1.1 Prerequisites
            • 1.1.1 Hardware
            • 1.1.2 Software
        • 2 Development Ecosystem
          • 2.1 PSoC Resources
          • 2.2 Firmware/Application Development
            • 2.2.1 PSoC Creator
            • 2.2.2 Peripheral Driver Library ( PDL)
          • 2.3 Support for Other IDEs
            • 2.3.1 Using PSoC Creator to Target Another IDE
          • 2.4 RTOS Support
          • 2.5 Debugging
          • 2.6 CY8CKIT-062-BLE PSoC 6 BLE Pioneer Kit
          • 2.7 CySmart Host Emulation Tool and Mobile Applications
        • 3 Device Features
        • 4 Development Setup
        • 5 My First PSoC 6 MCU Design With BLE
          • 5.1 Using These Instructions
          • 5.2 Before You Begin
          • 5.3 About the Design
          • 5.4 Part 1: Create a New Project from Scratch
          • 5.5 Part 2: Implement the Design
          • 5.6 Part 3: Generate Source Code
          • 5.7 Part 4: Write the Firmware
          • 5.8 Part 5: Build the Project, Program the Device
          • 5.9 Part 6: Test Your Design
        • 6 Summary
        • 7 Related Application Notes and Code Examples
        • Appendix A. Glossary
        • Appendix B. BLE Protocol
          • B.1 Overview
          • B.2 Physical Layer (PHY)
          • B.3 Link Layer (LL)
          • B.4 Host Control Interface (HCI)
          • B.5 Logical Link Control and Adaptation Protocol (L2CAP)
          • B.6 Security Manager (SM)
          • B.7 Attribute Protocol (ATT)
            • B.7.1 Attribute Hierarchy
            • B.7.2 Attribute Operations
          • B.8 Generic Attribute Profile (GATT)
          • B.9 Generic Access Profile (GAP)
        • Appendix C. Device Features
          • C.1 System Wide Resources
            • C.1.1 CPU Subsystem: CM 4 and CM 0
            • C.1.2 IPC
            • C.1.3 Memory System
            • C.1.4 DMA
            • C.1.5 Clocking System
            • C.1.6 System Interrupts
            • C.1.7 Power Supply and Monitoring
            • C.1.8 Power Modes
          • C.2 Secure Boot
          • C.3 Programmable Digital Peripherals
            • C.3.1 UDB
            • C.3.2 Programmable TCPWM
            • C.3.3 SCB
            • C.3.4 BLESS
            • C.3.5 Audio Subsystem
            • C.3.6 Serial Memory Interface
            • C.3.7 e FUSE
            • C.3.8 Segment LCD
          • C.4 Programmable Analog Peripherals
            • C.4.1 Continuous Time Block Opamps
            • C.4.2 Low - Pow er Comparator
            • C.4.3 SAR ADC
            • C.4.4 DAC
            • C.4.5 CapSense
          • C.5 Programmable GPIOs
        • Appendix D. Cypress IoT Development Tools
          • D.1 CY8CKIT-062-BLE PSoC 6 BLE Pioneer Kit
          • D.2 CySmart Host Emulation Tool
          • D.3 CySmart Mobile App
        • Document History
      • BLE GATT Throughput Example
      • BLE Environmental Sensing Profile Example
      • BLE GAP Peripheral - GATT Client with Current Time Service
      • BLE GAP Peripheral - GATT Server with Current Time Service
      • BLE Beacon Example
      • BLE Battery Server
      • PSoC 6 MCU - Firmware Design for BLE Applications
        • 1 Introduction
        • 2 PSoC Resources
        • 3 BLE Protocol Implementation in PSoC 6 BLE
          • 3.1 BLE Host
            • 3.1.1 Generic Access Profile (GAP)
            • 3.1.2 Generic Attribute Profile (GATT)
            • 3.1.3 ATT Protocol – Organizing the Data
          • 3.2 BLE Controller
            • 3.2.1 Managing Multiple Connections
        • 4 Developing a BLE Application: Firmware Flow
          • 4.1 Implementing Low-Power BLE Design
          • 4.2 Implementing a Secure BLE Design
            • 4.2.1 Configuring Security Features Using the BLE Component Security Mode and Security Level
            • 4.2.2 Establishing Secure BLE Link : Firmware Flow
          • 4.3 Additional BLE Design Considerations
        • 5 BLE Design Examples
          • 5.1 Multi-Master Multi-Slave: Implementing Four BLE Slaves
            • 5.1.1 About the Design
          • 5.2 Multi-Master Multi-Slave: Implementing Three BLE Masters and One BLE Slave
            • 5.2.1 About the Design
        • 6 Summary
        • 7. Related Documents
        • Document History
    • CapSense
      • CapSense Configurator Guide
        • Overview
          • Supported Middleware
        • Launch the CapSense Configurator
          • As a Stand-Alone Tool
          • From the Device Configurator
          • From the Eclipse IDE
          • From the Command Line
        • Quick Start
        • GUI Description
          • Menus/Commands
            • File
            • Edit
            • View
            • Help
          • Notice List
        • Tabs
          • Basic Tab
          • Advanced Tab
            • General Sub-tab
            • CSD Settings Sub-tab
            • CSX Settings Sub-tab
            • Widget Details Sub-tab
          • Pins Tab
        • Migration of Configuration File Format
        • References
        • Version Changes
      • CapSense Tuner Guide
        • Overview
        • Launch the CapSense Tuner
          • As a Stand-Alone Tool
          • From the Device Configurator
          • From the Eclipse IDE
          • From the Command Line
        • Quick Start
        • GUI Description
          • Menus
          • Toolbar
          • Widget Explorer Pane
          • Widget/Sensor Parameters Pane
          • Tabs
          • Status Bar
        • Tuner Communication Setup
        • Widget View Tab
          • Touch Signal Graph
          • Toolbar
        • Graph View Tab
          • Toolbar
          • Graph Functionality
        • SNR Measurement Tab
          • SNR Options
          • SNR Measurement Procedure
        • Touchpad View Tab
          • Toolbar
          • Widget Selection
          • Display settings
          • Show signal
          • Touch report
        • Gesture View Tab
          • Toolbar
          • Widget Selection
          • Image Pane
          • Detected Gesture
          • Gesture Event History
        • Tuner Configuration Options
          • Display Options
          • SNR Options
          • Logging Options
        • References
        • Troubleshooting
        • Version Changes
      • CapSense Middleware
        • CapSense Middleware Library
        • API Reference
          • High-level Functions
          • Low-level Functions
          • CapSense Data Structure
            • CapSense Structures
            • Gesture Structures
          • Enumerated Types
          • Macros
            • General Macros
            • Middleware State Macros
            • Status Macros
            • Settings Macros
            • Pin-related Macros
            • Processing Macros
            • Touch-related Macros
            • Gesture Macros
            • Miscellaneous Macros
            • Built-in Self-test Macros
          • Callbacks
      • CapSense Tuner Client over BLE Example
      • CapSense Tuner Server over BLE Example
      • CapSense Buttons and Slider Example
      • CapSenes FreeRTOS Example
      • CapSense Buttons BLE Example
      • PSoC® 4 and PSoC 6 MCU CapSense® Design Guide
        • 1. Introduction
          • 1.1 Abstract
          • 1.2 Introduction
          • 1.3 CapSense Features
          • 1.4 PSoC 4 and PSoC 6 MCU CapSense Plus Features
          • 1.5 CapSense Design Flow
        • 2. CapSense Technology
          • 2.1 CapSense Fundamentals
          • 2.2 Capacitive Touch Sensing Method
          • 2.3 Signal-to-Noise Ratio
          • 2.4 CapSense Widgets
          • 2.5 Liquid Tolerance
        • 3. PSoC 4 and PSoC 6 MCU CapSense
          • 3.1 CapSense CSD Sensing Method
          • 3.2 CapSense CSX Sensing Method
          • 3.3 CapSense Architecture in PSoC 4 S-Series, PSoC 4100S Plus, PSoC 4100PS, and PSoC 6 MCU
          • 3.4 CapSense in PSoC 4xxxM/4xxxL-Series
        • 4 CapSense Design and Development Tools
          • 4.1 PSoC Creator
          • 4.2 ModusToolbox
          • 4.3 Hardware Kits
        • 5. CapSense Performance Tuning
          • 5.1 Selecting between SmartSense and Manual Tuning
          • 5.2 SmartSense
          • 5.3 Manual Tuning
        • 7. Design Considerations
          • 7.1 Firmware
          • 7.3.2 Overlay Thickness
          • 7.3.3 Overlay Adhesives
          • 7.4 PCB Layout Guidelines
          • 7.4.1 Sensor CP
          • 7.4.2 Board Layers
          • 7.4.3 Button Design
          • 7.4.3.1 Self-Capacitance Button Design
          • 7.4.4 Slider Design
          • Slider-Segment Shape, Width, and Air Gap
          • 7.4.4.4 Routing Slider Segment Trace
          • 7.4.5 Sensor and Device Placement
          • 7.4.6 Trace Length and Width
          • 7.4.7 Trace Routing
          • 7.4.8 Crosstalk Solutions
          • 7.4.9 Vias
          • 7.4.10 Ground Plane
          • 7.4.12 Layout Guidelines for Liquid Tolerance
          • 7.4.13 Schematic Rule Checklist
        • 8 CapSense Plus
    • Low Power Development
      • Low Power Assistant
        • Low Power Assistant Middleware Library 3.0.0
          • LPA Utility API
      • WLAN Low Power Example
      • TCP Keepalive Offload Example
      • Power Mode Switching Example
      • PSoC 6 MCU Low-Power Modes and Power Reduction Techniques
        • 1.Introduction
        • 2.Power Modes
          • 2.2 CPU Sleep and Wakeup Instructions
          • 2.3 Low-Power Assistant
          • 2.3.1 Low-Power Assistant Features
          • 2.3.2 PSoC 6 MCU Device LPA Settings
          • 2.5 Example Case Scenarios
          • 2.6 System Power Management (SysPm) Library
        • 3. PSoC 6 MCU Power Management Techniques
          • 3.2 ULP Mode Clock
          • 3.3 Backup Power Domain
          • 3.3.3 External PMIC Control
          • 3.3.5 Backup Data Registers
        • 4.Other Power Saving Techniques
          • 4.8 GPIOs
          • 4.9 SRAM
          • 4.10 TCPWM
          • 4.11 SCB
          • 4.15 SAR ADC
          • 4.16 Voltage DAC
          • 4.17 Opamp
        • 5. Power Measurement
        • 6.Power Supply Protection System
        • 7.Summary
        • 8. References
        • 9.Power Modes Summary
          • 9.1 Power Modes and Wakeup Source
        • 10.Subsystem Availability
          • 10.1 Resources Available in Different Power Modes
        • 11. Callback Function Examples
        • 12. Code Examples
          • 12.3 CE218542 - PSoC 6 MCU Custom Tick Timer Using RTC Alarm Interrupt
          • 12.4 CE226306 - PSoC 6 MCU Power Measurements
      • Low-Power System Design with CYW43012 and PSoC 6 MCU
        • 1 Introduction
        • 2.Low-power Overview
          • 2.1 CYW43012 Power Modes
          • 2.2 PSoC 6 MCU Power Modes
          • 2.3 CYW43012 Power-Related Hardware Signals
          • 2.4 Power Mode Transition
        • 3 WLAN Power Optimization Techniques
          • 3.1 IEEE 802.11 (Wi-Fi) Power Saving
          • 3 . 1 . 1 Beacon Interval
          • 3 . 1 . 2 Listen Interval
          • 3 . 1 . 3 DTIM Period
          • 3 . 1 . 4 Power Saving Methods
          • 3.1.4.1 Power Save Poll
          • 3.1.4.2 802.11 Power Save Without Poll
          • 3.1.4.3 Association Timeout Limit
          • 3 . 1 . 5 802 . 11ac - Friendly Features
        • 3.2 Wi-Fi Power Save Implementation
          • 3 . 2 . 1 WHD Pow er Save Interface
          • 3 . 2 . 2 Cyclic Timers in Netw ork Stack
        • 3.3 Host Offloads to WLAN Device
          • 3 . 3 . 1 ARP Offload
          • 3 . 3 . 2 Packet Filter Offload
          • 3.3.2.1 Network Layer or EtherType filter
          • 3.3.2.2 Transport Layer/IP Protocols
          • 3.3.2.3 Applications Layer/TCP and UDP Port Numbers
        • 4 Bluetooth Power Optimization Techniques
          • 4.1 Advertisement Events
        • 4.2 Connection Events
          • 4 . 2 . 1 Connection Interval
          • 4 . 2 . 2 Use Slave Latency
          • 4 . 2 . 3 Connection Parameter Update in Mbed OS
        • 5 PSoC 6 MCU Power Optimization Techniques
          • 5.1 Core voltage and Operating Frequency
          • 5.2 Reducing Leakage in Deep Sleep
          • 5.3 RTOS Tickless Mode
          • 5.4 Additional Power Optimization Techniques
        • 6 Low Power Assistant (LPA)
          • 6.1 LPA Configuration
          • 6.2 Using LPA in Mbed OS
        • 7 Power Measurement Using CY8CKIT-062S2-43012
          • 7.1 Hardware setup
          • 7.2 mbed-os-example-wlan-lowpower
          • 7.3 mbed-os-example-wlan-offload-arp
        • 8 Summary
        • 9 Related Documents
    • AnyCloud IoT Middleware
      • ModusToolbox™ AnyCloud User Guide
        • Overview
        • Getting Started
        • AnyCloud Library Descriptions and Documentation
          • Wi-Fi Middleware Core (wifi-mw-core)
          • Wi-Fi Connection Manager (WCM)
          • Wi-Fi Host Driver (WHD)
          • anycloud-ota
          • MQTT
          • Secure Sockets
          • lwIP
            • TCP and UDP
          • MbedTLS
          • Low Power Assistant (LPA)
          • http-server / http-client
          • FreeRTOS
          • command-console
          • enterprise-security
          • Bluetooth Libraries
          • Smart CoEX
          • Connectivity Middleware Tools
            • Wi-Fi Bluetooth Tester
            • WLAN Manufacturing Test Application
            • Wi-Fi Cert Tester Tool
        • Library Dependencies
          • Library Manager
          • Adding Libraries
          • Library Reference Tables
            • PSoC 6 Base Libraries
            • PSoC 6 Middleware
        • Library Configuration Files
          • Wi-Fi Middleware Core
            • Optimizing Smaller Memory Devices
          • MQTT
          • OTA
        • Supported Devices
        • Working with Examples
        • Adding and Configuring Low Power
        • Adding and Configuring Bluetooth
      • AnyCloud Code Examples
      • WiFi Connections
        • WiFi Scan Example
        • Provisioning with BLE
        • Provisioning with WPS
      • Firmware Updates
        • OTA Firmware Update with MQTT
        • OTA
          • Over The Air (OTA) Update Library
            • API Reference
      • IoT Protocols
        • MQTT Client Example
        • TCP Client Example
        • TCP Server Examaple
        • Secure TCP Client Example
        • Secure TCP Server Example
        • UDP Client Example
        • UDP Server Example
        • HTTPS Server Example
  • API Reference
    • RTOS Libraries
      • RTOS Abstraction Layer
        • RTOS Abstraction Layer
        • API Reference
          • Common
            • RTOS Specific Types and Defines
          • Mutex
          • Queue
          • Semaphore
          • Threads
          • Time
          • Timer
          • Worker Thread Utility
      • FreeRTOS
        • FreeRTOS
        • Clib-Support
          • CLib FreeRTOS Support
      • CMSIS
    • PSoC6 Base Libraries
      • corelib
        • Core Library
        • API Reference
          • Result Type
          • Utilities
      • PSoC6 HAL
        • Hardware Abstraction Layer
        • HAL API Reference
          • HAL General Types/Macros
            • Result Type
            • General Types
            • Overrideable Macros
            • Implementation Specific Types
          • HAL Driver Availability
          • HAL Drivers
            • ADC (Analog to Digital Converter)
            • Clock
            • COMP (Analog Comparator)
            • CRC (Cyclic Redundancy Check)
            • DAC (Digital to Analog Converter)
            • DMA (Direct Memory Access)
            • EZI2C (Inter-Integrated Circuit)
            • Flash (Flash System Routine)
            • System Power Management
            • GPIO (General Purpose Input Output)
            • HWMGR (Hardware Manager)
            • I2C (Inter-Integrated Circuit)
            • I2S (Inter-IC Sound)
            • INTERCONNECT (Internal digital routing)
            • Keyscan
            • LPTimer (Low-Power Timer)
            • Opamp (Operational Amplifier)
            • PDM/PCM (Pulse-Density Modulation to Pulse-Code Modulation Converter)
            • PWM (Pulse Width Modulator)
            • QSPI (Quad Serial Peripheral Interface)
            • Quadrature Decoder
            • RTC (Real-Time Clock)
            • SDHC (SD Host Controller)
            • SDIO (Secure Digital Input Output)
            • SPI (Serial Peripheral Interface)
            • System
            • TDM (Time Division Multiplexed)
            • Timer (Timer/Counter)
            • TRNG (True Random Number Generator)
            • UART (Universal Asynchronous Receiver-Transmitter)
            • USB Device
            • WDT (Watchdog Timer)
          • CAT1 (PSoC 6) Implementation Specific
            • Deprecated
            • Clocks
            • COMP (CTB Opamps)
            • COMP (LP Comparator block)
            • DMA (Direct Memory Access)
            • CAT1 Specific Hardware Types
            • Interconnect (Internal Digital Routing)
            • Pins
            • System Power Management
            • Timer (Timer/Counter)
            • Triggers
            • TRNG (True Random Number Generator)
            • WDT (Watchdog Timer)
            • ADC (Analog Digital Converter)
            • ADC (Analog Digital Converter)
            • COMP (Analog Comparator)
            • DAC
            • I2S (Inter-IC Sound)
            • LPTIMER
            • Opamp
            • PDM/PCM (Pulse Density Modulation to Pulse Code Modulation Converter)
            • PWM (Pulse Width Modulator)
            • QuadDec (Quadrature Decoder)
            • RTC (Real Time Clock)
            • SDHC (SD Host Controller)
            • TDM (Time Division Multiplexing)
            • UDB SDIO (Secure Digital Input Output)
      • PSoC6 PDL
        • MTB CAT1 Peripheral driver library Documentation
        • Introducing MTB CAT1A
        • Getting Started
        • PDL API Reference
          • BLE ECO (BLE ECO Clock)
            • Functions
            • Enumerated Types
            • Macros
          • CAN FD (CAN with Flexible Data-Rate)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • Crypto (Cryptography)
            • Client-Server Model
            • Direct Crypto Core Access
            • Common Data Structures
            • Common Enumerated Types
          • CSD (CapSense Sigma Delta)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • CTB (Continuous Time Block)
            • Macros
            • Functions
            • Global Variables
            • Data Structures
            • Enumerated Types
          • CTDAC (Continuous Time Digital to Analog Converter)
            • Macros
            • Functions
            • Global Variables
            • Data Structures
            • Enumerated Types
          • DMA (Direct Memory Access)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • DMAC (Direct Memory Access Controller)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • eFuse (Electronic Fuses)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • Flash (Flash System Routine)
            • Macros
            • Functions
            • Enumerated Types
          • GPIO (General Purpose Input Output)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • I2S (Inter-IC Sound)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • IPC (Inter Process Communication)
            • IPC driver layer (IPC_DRV)
            • IPC semaphores layer (IPC_SEMA)
            • IPC pipes layer (IPC_PIPE)
            • IPC bluetooth sub-system layer (IPC_BTSS)
          • LPComp (Low Power Comparator)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • LVD (Low-Voltage-Detect)
            • Macros
            • Functions
            • Enumerated Types
          • MCWDT (Multi-Counter Watchdog)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • PDM_PCM (PDM-PCM Converter)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • PRA (Protected Register Access)
            • Macros
            • Functions
            • Enumerated Types
            • Data Structures
          • Profile (Energy Profiler)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • Prot (Protection Unit)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • RTC (Real-Time Clock)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • SAR (SAR ADC Subsystem)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • SCB (Serial Communication Block)
            • Common
            • EZI2C (SCB)
            • I2C (SCB)
            • SPI (SCB)
            • UART (SCB)
          • SD Host (SD Host Controller)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • SegLCD (Segment LCD)
            • Macros
            • Functions
            • Data Structures
            • Global Data
            • Enumerated Types
          • SmartIO (Smart I/O)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • SMIF (Serial Memory Interface)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • Startup (System Configuration Files)
            • Macro
            • Functions
            • Global Variables
          • SysAnalog (System Analog Reference Block)
            • Macros
            • Functions
            • Global Variables
            • Data Structures
            • Enumerated Types
          • SysClk (System Clock)
            • Macros
            • General Enumerated Types
            • External Clock Source (EXTCLK)
            • External Crystal Oscillator (ECO)
            • Clock Path Source
            • Frequency Locked Loop (FLL)
            • Phase Locked Loop (PLL)
            • Internal Low-Speed Oscillator (ILO)
            • Precision Internal Low-Speed Oscillator (PILO)
            • Clock Measurement
            • Clock Trim (ILO, PILO)
            • Low Power Callback
            • Watch Crystal Oscillator (WCO)
            • High-Frequency Clocks
            • Fast Clock
            • Peripheral Clock
            • Peripherals Clock Dividers
            • Slow Clock
            • Alternative High-Frequency Clock
            • Low-Frequency Clock
            • Timer Clock
            • Pump Clock
            • Backup Domain Clock
            • Medium Frequency Domain Clock
          • SysInt (System Interrupt)
            • Macros
            • Global variables
            • Functions
            • Data Structures
            • Enumerated Types
          • SysLib (System Library)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • SysPm (System Power Management)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • SysTick (ARM System Timer)
            • Macros
            • Functions
            • Data Structures
          • TCPWM (Timer Counter PWM)
            • Common
            • Timer/Counter (TCPWM)
            • PWM (TCPWM)
            • Quadrature Decoder (TCPWM)
            • Shift Register (TCPWM)
          • TrigMux (Trigger Multiplexer)
            • Macros
            • Functions
            • Enumerated Types
          • USBFS (USB Full-Speed Device)
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
          • WDT (Watchdog Timer)
            • Macros
            • Functions
        • Online Documentation
        • Additional Resources
        • MISRA-C:2004 Compliance
        • Device Catalog
          • List of Devices
          • Device Catalog
      • PSoC6 Base Examples
        • GPIO Interrupt Example
        • Multi-Counter Watchdog Timer (MCWDT) Example
        • Watchdog Timer (WDT) Example
        • Fault Handling Example
        • Real Time Clock Example
        • PDM/PCM Example
        • Square Wave PWM using TCPWM Example
        • PWM Ramp using SmartIO Example
        • True Random Number Generator Example
        • SHA2 with Cryptographic Hardware Block Example
        • AES Encryption/Decryption Example
        • Dual Core IPC Semephore Example
        • Dual Core IPC Pipes Example
        • I2S Audio Codec Example
        • PDM to I2S Routing Example
        • Serial Communications Block SPI with DMA Example
        • UART using DMA Example
        • HAL UART Example
        • SPI Master Example
        • I2C Master Example
        • I2C Slave Callback Example
        • I2C Master with EzI2C Client
      • PSoC6 Prebuilt Images
      • ModusToolbox QSPI Configurator Guide
        • Overview
        • Launch the Configurator
          • From the Eclipse IDE
          • From the Device Configurator
          • Without the Eclipse IDE
          • From the Command Line
        • Quick Start
        • Code Generation
        • Files Used by the Configuration Tool
        • QSPI Configurator Menus
          • File
          • View
          • Options
          • Help
        • QSPI Configuration Fields
        • Edit Memory File Fields
        • Memory Database
        • Create New Memory File
        • Migration of Configuration File Format
          • From the Eclipse IDE
          • Without the Eclipse IDE
        • XML Schemas
          • *.cyqspi Schema
          • *.cymem Schema
        • References
        • Version Changes
      • ModusToolbox Smart I/O Configurator Guide
        • Overview
        • Launch the Smart I/O Configurator
          • As a Stand-Alone Tool
          • From the Device Configurator
          • From the Eclipse IDE
          • From the Command Line
        • Quick Start
        • GUI Description
          • Menus
          • File
          • View
          • Help
        • Tabs
          • Routing Tab
          • Data Unit Tab
          • LUT Tabs
        • Functional Description
          • Routing Fabric
          • Clock and Reset Behavior
          • LUT Combinatorial Feedback
        • References
        • Version Changes
      • ModusToolbox Device Configurator Guide
        • Overview
          • Definitions
        • Launch the Device Configurator
          • From the Eclipse IDE
          • From the Command Line
          • As a Stand-Alone Tool
        • Quick Start
        • Code Generation
        • GUI Description
          • Menus
            • File
            • Edit
            • View
            • Help
        • Icons
        • Create Design Dialog
        • Device Tabs
        • Resources Tabs
          • Peripherals
            • PSoC 6 Applications
            • Bluetooth Applications
          • Pins
            • PSoC 6 Applications
            • Bluetooth Applications
          • Analog-Routing Tab
            • Analog Route Editor
          • System Tab
          • Peripheral-Clocks Tab
          • DMA Tab
        • Panes
          • Parameters Pane
            • Configuration Help
            • Parameter Descriptions
            • Parameter Values
            • Signal Select Indicators
            • Launch Other Configurators
          • Notice List
            • Fix a Task/Error
            • Copy a Notice
          • Code Preview Pane
        • References
        • Version Changes
      • stdio UART Support
        • Retarget IO (retarget-io)
        • Retarget IO API Reference
    • PSoC6 Middleware
      • USB
        • USB Configurator Guide
          • Overview
            • Supported Middleware
          • Launch the USB Configurator
            • As a Stand-Alone Tool
            • From the Eclipse IDE
            • From the Command Line
          • Quick Start
          • Code Generation
          • GUI Description
            • Menus
          • Toolbars
            • Descriptor Toolbar
            • HID Report Toolbar
          • Panes
            • Descriptors
            • Parameters
          • Errors
          • Supported Descriptors
          • Known Issues, Limitations, and Workarounds
          • Migration of Configuration File Format
          • References
          • Version Changes
        • USB
          • Cypress USB Device Middleware Library 2.0
          • API Reference
            • Device
            • Audio Class
            • CDC Class
            • HID Class
        • EZ-PD Configurator Guide
          • Overview
          • Supported Software
          • Definitions
          • Launch the EZ-PD Configurator
            • As a Stand-Alone Tool
            • From the Eclipse IDE
            • From the Command Line
          • Quick Start
          • GUI Description
            • Menus
            • Toolbar
            • Parameter Categories
            • Parameters and Values
            • Notice List
          • References
          • Version Changes
        • Audio Recorder Example
        • HID Mouse Example
        • Mass Storage Example
        • Generic HID Example
        • CDC Serial Port Example
        • Audio Device and HID Consumer Control Example
        • Mass Storage File System Example
      • Memory
        • Device Firmware Update Host Tool
          • Overview
          • Example Code
          • Walkthrough
          • Launch the DFU Host Tool GUI
            • As a Stand-Alone Tool
            • From the Eclipse IDE
            • From the Command Line
          • GUI Description
            • Main window
            • Port Configuration
            • Log
            • Errors
          • CLI Description
            • Command-Line Flags
            • CLI Example
          • Troubleshooting
          • References
          • Version Changes
        • SPI Flash
          • Serial Flash
          • API Reference
        • Device Firmware Update
          • Device Firmware Update
          • API Reference
            • Macros
            • Functions
            • Global Variables
            • Data Structures
            • Enumerated Types
          • MISRA-C:2012 Compliance
        • Emulated EEPROM
          • Cypress Em_EEPROM Middleware Library
          • API Reference
            • Macros
            • Functions
            • Data Structures
            • Enumerated Types
        • Emulated EEPROM Example
        • ModusToolbox QSPI Configurator Guide
          • Overview
          • Launch the QSPI Configurator
            • As a Stand-Alone Tool
            • From the Device Configurator
            • From the Eclipse IDE
            • From the Command Line
          • Quick Start
          • Code Generation
          • Files Used by the Configuration Tool
          • GUI Description
            • Menus
            • Toolbar
            • QSPI Configuration Fields
            • Edit Memory File Fields
          • Memory Database
            • Notes:
          • Create New Memory File
          • Migration of Configuration File Format
            • From the Eclipse IDE
            • Without the Eclipse IDE
          • Patching Flashloaders
          • XML Schemas
            • *.cyqspi Schema
            • *.cymem Schema
          • References
          • Version Changes
        • QSPI FRAM Example
        • QSPI NOR Flash Example
        • QSPI Flash with Serial Memory Interface (SMIF) Example
        • External Flash Execute In Place Example
      • Sensing
        • Thermistor (Temperature Sensor)
          • Thermistor (Temperature Sensor)
          • API Reference
        • CapSense
          • CapSense Configurator Guide
            • Overview
            • Launch the CapSense Configurator
            • Quick Start
            • GUI Description
            • Tabs
            • Migration of Configuration File Format
            • References
            • Version Changes
          • CapSense Tuner Guide
            • Overview
            • Launch the CapSense Tuner
            • Quick Start
            • GUI Description
            • Tuner Communication Setup
            • Widget View Tab
            • Graph View Tab
            • SNR Measurement Tab
            • Touchpad View Tab
            • Gesture View Tab
            • Tuner Configuration Options
            • References
            • Troubleshooting
            • Version Changes
          • CapSense Middleware
            • CapSense Middleware Library
            • API Reference
          • CapSense Tuner Client over BLE Example
          • CapSense Tuner Server over BLE Example
          • CapSense Buttons and Slider Example
          • CapSenes FreeRTOS Example
          • CapSense Buttons BLE Example
        • ADC using CSDADC
          • Cypress CSDADC Middleware Library
          • API Reference
            • Macros
            • Enumerated types
            • Data Structures
            • Functions
            • Callback
        • CSDIDAC Middleware Library 2.10
          • CSDIDAC Middleware Library
          • API Reference
            • Macros
            • Enumerated Types
            • Data Structures
            • Functions
        • Light Sensor
          • API Reference
        • BMI-160 Inertial Measurement Unit
          • BMI-160 Inertial Measurement Unit
          • API Reference
        • BME 680 Atmospheric Sensor
          • BME 680 Atmospheric Sensor
          • API Reference
        • CSD ADC Example
      • Display
        • emWin Graphics Library
          • SEGGER emWin Graphics Library 5.48.1
          • emWin User Guide
          • SEGGER emWin Web Page
          • emWin OLED Example
          • emWin Eink Example
        • RGB LED
          • RGB LED
          • API Reference
        • ModusToolbox SegLCD Configurator Guide
          • Overview
            • Supported Software
          • Definitions
          • Launch the SegLCD Configurator
            • As a Stand-Alone Tool
            • From the Device Configurator
            • From the Eclipse IDE
            • From the Command Line
          • Quick Start
          • Code Generation
          • GUI Description
            • Menus
            • Toolbar
          • Display Editor
            • Display Editor Toolbar
            • Display Row
          • Display View
          • Mapping Table
            • Connect/Disconnect Display Pixel
            • Change Pixel Name
          • Notice List
          • References
          • Version Changes
      • Bluetooth Low Energy
        • ModusToolbox® Bluetooth Configurator Guide
          • Overview
            • Supported Devices and Libraries
            • SIG-Adopted Profiles and Services
            • Custom Profiles
          • Launch the Bluetooth Configurator
            • As a Stand-Alone Tool
            • From the Eclipse IDE
            • From the Command Line
          • Quick Start
          • Code Generation
            • 20xxx
            • Bluetooth MCU
            • 43xxx
          • GUI Description
            • Menus
            • Toolbar
            • Tab Components
            • Notice List
            • Status Bar
          • Parameter Configuration
            • General Tab (20xxx)
            • General Tab (Bluetooth MCU)
            • General Tab (43xxx)
            • GATT Settings Tab (All Devices)
            • GAP Settings Tab (Bluetooth MCU and 43xxx)
            • L2CAP Settings Tab (Bluetooth MCU and 43xxx)
            • Link Layer Settings (Bluetooth MCU)
            • Service Discovery Settings Tab (20xxx) (Beta)
          • Migration of Configuration File Format
            • Notes
          • References
          • Version Changes
        • ModusToolbox Bluetooth TUNER Guide
          • Overview
            • Supported Devices
            • Supported Middleware
            • SIG-Adopted Profiles and Services
            • Custom Profiles
          • Launch the Bluetooth Configurator
            • Launch without the Eclipse IDE
            • Launch from the Eclipse IDE
            • Running from the Command Line
          • Quick Start
            • PSoC 6 MCU
            • 20xxx Device
          • Menus
            • File
            • Edit
            • View
            • Help
          • Notice List
          • Status Bar
          • Parameter Configuration
            • General Tab (PSoC 6)
            • General Tab (20xxx)
            • GATT Settings Tab (All Devices)
            • GAP Settings Tab (PSoC 6)
            • L2CAP Settings Tab (PSoC 6)
            • Link Layer Settings (PSoC 6)
            • Service Discovery Settings Tab (20xxx) (Beta)
          • Migration of Configuration File Format
          • References
          • Version Changes
        • BLESS
          • Cypress PSoC 6 Bluetooth Low Energy Middleware Library 3.50
          • General Description
          • Quick Start Guide
          • Configuration Considerations
          • Supported Software and Tools
          • More Information
          • Industry Standards
          • Changelog
          • API Reference
            • BLE Common API
            • BLE Service-Specific API
        • WICED Bluetooth Host Stack
          • ble
            • Overview
            • API Reference
          • Dual-Mode
            • Overview
            • API Reference
        • BLE GATT Throughput Example
        • BLE Find Me Profile Example
        • BLE GATT Battery Level Service Example
      • Kits Support Middleware
        • CY8CKIT-028-EPD
          • CY8CKIT-028-EPD shield support library
          • API Reference
            • Shield
            • Pins
            • Microphone
            • Motion Sensor
            • Temperature Sensor
            • E-Ink Display
          • E2271CS021 EInk Controller (display-eink-e2271cs021)
          • E2271CS021 EInk Controller API Reference
        • CY8CKIT-028-TFT
          • Shield Library (CY8CKIT-028-TFT)
          • API Reference
            • Shield
            • Pins
            • Microphone
            • Audio Codec
            • Light Sensor
            • Motion Sensor
            • TFT Display
          • AK4954A Audio Codec
            • Audio Codec
            • Audio Codec API Reference
          • Display 2.4 Inch TFT LCD (ST7789V)
            • API Reference
          • Light Sensor Functions
            • API Reference
        • CY8CKIT-032
          • CY8CKIT-032 shield support library
          • API Reference
            • Pins
            • Analog Front End
            • OLED Display
          • DSSD1306 OLED Controller (display-oled-ssd1306)
            • OLED Display (SSD1306)
            • API Reference
    • AnyCloud IoT Middleware
      • Wi-Fi Base
        • Overview
        • API Reference
          • lwIP and WHD port
            • Enumerated Types
            • Port Functions
            • Port Structures
            • EAPOL Functions
          • CY generic lwIP WHD glue results/error codes
          • Optimization of Wi-Fi Middleware Core
      • Wi-Fi Connection Manager Library
        • Overview
        • API Reference
          • Message Sequence Charts
          • Macros
            • WCM results/error codes
          • Enumerated Types
          • Typedefs
          • Structures
            • cy_wcm_wps_config_t
            • cy_wcm_config_t
            • cy_wcm_ip_address_t
            • cy_wcm_event_data_t
            • cy_wcm_ap_credentials_t
            • cy_wcm_ip_setting_t
            • cy_wcm_connect_params_t
            • cy_wcm_scan_filter_t
            • cy_wcm_scan_result_t
            • cy_wcm_wps_device_detail_t
            • cy_wcm_wps_credential_t
            • cy_wcm_associated_ap_info_t
            • cy_wcm_wlan_statistics_t
            • cy_wcm_custom_ie_info_t
            • cy_wcm_ap_config_t
          • Functions
      • HTTPS Server
        • Overview
        • API Reference
          • C API
            • Structures & Enumerations
            • Macros
            • Functions
          • C++ Class Interface
            • HTTPServer Class Reference
      • HTTP Client
        • HTTP Client Middleware Library
          • Overview
          • API Reference
            • C APIs
      • Low Power Assistant
        • Low Power Assistant Middleware Library 3.0.0
          • LPA Utility API
      • OTA
        • Over The Air (OTA) Update Library
          • API Reference
            • Cypress Over The Air (OTA) API
      • MQTT
        • Overview
        • API Reference
          • C APIs
            • Structures and Enumerations
            • Macros
            • Functions
      • Secure Sockets
        • Overview
        • API Reference
          • Secure Sockets API
            • Message Sequence Charts
            • Macros
            • Typedefs
            • Enumerated types
            • Structures
            • Functions
          • TLS API
            • Enumerations
            • Typedefs
            • Structures
            • Functions
      • lwlP
      • mbedTLS
      • Wi-Fi Host Driver (WHD)
        • Wi-Fi Host Driver (WHD) Documentation
        • Modules
          • WHD Event handling API
          • WHD Buffer Interface API
            • whd_buffer_funcs
          • WHD Network Interface API
            • whd_netif_funcs
          • WHD Resource API
            • whd_resource_source
          • WHD Wi-Fi API
            • WHD Wi-Fi Management API
            • WHD Wi-Fi join, Scan and Halt API
            • WHD Wi-Fi Utility API
            • WHD Wi-Fi SoftAP API
            • WHD Wi-Fi Power Save API
            • WHD Wi-Fi IOCTL Set/Get API
            • WHD Wi-Fi Debug API
          • WHD Bus API
        • Data Structures
          • Data Fields
            • Variables
        • Files
          • File List
          • Globals
            • All
            • Functions
            • Typedefs
            • Enumerations
            • Enumerator
            • Macros
      • UDB based SDIO WiFi Host Driver
        • UDB SDIO for Wi-Fi Host Driver
        • API Reference
          • Pin States
          • Pin Mappings
          • Macros
          • Functions
          • UDB_SDIO
            • Macros
            • Functions
            • Data Structures
      • Connectivity Middleware Utilities Library
        • Overview
        • API Reference
          • Common middleware utilities
            • Middleware utilities enumerated types
            • Logging utilities
            • JSON parser utilities
            • Linked list utilities
            • Network helper utilities
            • String conversion utilities
  • Development Tools Guide
    • ModusToolbox IDE
      • ModusToolbox Installation Guide
        • System Requirements
        • Uninstall Beta Versions
        • Step 1: Download the Software
          • ModusToolbox Patches
          • Pre-Requisites
          • SEGGER J-Link
        • Step 2: Install ModusToolbox Software
          • Installing in non-default Location
          • Installing with Previous Versions
          • Windows
          • Linux
          • macOS
        • Step 3: Run the Eclipse IDE
        • Next Steps
        • Default Versus Advanced Windows Installation
        • Installing with Spaces in User Home Directory
          • Step 1: Install at a custom path.
          • Step 2: Create a variable to specify the path to Tools.
          • Step 4: Create a variable to specify the path to cache.
          • Step 5: Specify the custom path to use for Offline Content and manifest.loc.
      • Eclipse IDE for ModusToolbox® Quick Start Guide
        • Download/Install ModusToolbox and Run Eclipse IDE
        • Create New Application
          • Step 1: Open Project Creator Tool
          • Step 2: Choose Board Support Package (BSP)
          • Step 3: Select Application
          • Step 4: Create Application
        • Add/Modify Application Code
        • View Device Resources
        • Build the Application
        • Program the Device
          • Connect the Kit
          • Program
        • Debug the Program
        • Next Steps
      • Eclipse IDE for Modus Toolbox User Guide
        • Introduction
          • Overview
          • References
          • Document Conventions
          • Revision History
        • Getting Started
          • Launch Eclipse IDE
          • Open Project Creator Tool
          • Create PSoC 6 MCU Application
            • Choose Board Support Package
            • Select Application
            • Create Application
          • Build Application
          • Program Application
          • Export/Share Application
          • Import Application/Code Example
          • Search Online for Code Examples
          • Search Online for Libraries/BSPs
        • Mbed OS to ModusToolbox Flow
          • Install and Configure Mbed CLI
            • Install/Update PyOCD
            • Configure Compilers
          • Switch Kit to DAPLink Mode
          • Create Application in Mbed CLI
          • Compile Application in Mbed CLI (Optional)
          • Export Application from Mbed CLI
          • Import Mbed OS Application into Eclipse IDE
          • Configure Eclipse IDE
            • Define the Workspace pyOCD Path
            • Verify Properties Settings
          • Build, Program, Debug Application
            • Build
            • Program
            • Debug
          • Using MiniProg4 in DAPLink Mode
        • IDE Description
          • Overview
          • Project Explorer
          • Quick Panel
        • Configure Applications
          • Modify Code
          • Restore Shared Directory
          • Use Configurators
            • Launching Configurators from the IDE
            • Launching Configurators without the IDE
          • Use Tools
            • Launching Tools from the IDE
            • Library Manager
            • BTSpy and ClientControl
            • DFU Host Tool
            • Power Estimator
          • Refresh Quick Panel
          • Rename Application
        • Build Applications
          • Build with Make
          • Build with IDE
          • GCC Version
        • Program and Debug
          • PSoC MCU Programming/Debugging
            • Launch Configurations
            • Using JTAG Interface in MiniProg4
            • Erasing external memory
            • Programming eFuse
            • Debug Connection Options
            • Select Specific CMSIS-DAP Device
            • Select Specific J-Link Device
            • KitProg Firmware Loader
            • Power Cycle Programming Mode with KitProg3_MiniProg4
            • PSoC 4 Flash Security Programming
          • Bluetooth Programming/Debugging
            • Program Configuration
            • Attach Configurations
            • Debug Settings
          • Mbed OS Programming/Debugging
            • Launch Configurations
            • Change PyOCD Message Color
            • Attach to Running Target (PyOCD)
      • 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
      • ModusToolbox Project Creator Guide
        • Overview
        • Manifest Files
        • Created Application(s)
        • Library Management Flows
        • Launch the Project Creator
          • As a Stand-Alone GUI Tool
            • <install_dir>/ModusToolbox/tools_<version>/project-creator
          • From Eclipse IDE
          • As a Command-Line Tool
            • <install_dir>/ModusToolbox/tools_<version>/project-creator
        • GUI Description
          • Menus
          • Choose BSP Page
            • Import BSP
          • Select Application Page
            • Toolbar Options
            • Select Multiple Applications
            • Using Search
            • Import Application
          • Create an Application
        • CLI Description
          • Example
        • Version Changes
      • ModusToolbox Library Manager User Guide
        • Overview
          • Version
            • Dynamic
            • Fixed
          • Manifests
          • MTB Flow
            • .mtb File
            • Direct Dependency
            • Indirect Dependency
            • Shared
            • Local
          • LIB Flow
        • Launch the Library Manager
          • As a Stand-Alone Tool
          • Offline Mode
          • With the Eclipse IDE
          • Running the make modlibs Command
          • Running the Non-GUI Command Line Interface
        • Working with BSPs/Libraries (MTB Flow)
          • Update Indirect Dependency Libraries
          • Add/Remove BSPs
          • Select Active BSP
          • Share/Unshare BSPs and Libraries
          • Change BSP/Library Version
        • Working with BSPs/Libraries (LIB Flow)
          • Adding BSPs/Libraries
          • Remove BSPs/Libraries
            • Update.
          • Update Shared BSPs/Libraries
          • Change BSP/Library Version
        • GUI Description
          • Menus
          • Fields
          • Tabs
            • Shared Check Box (MTB Flow)
            • BSP and Library Versions
          • Buttons
          • Message Console
          • Status Indicator
        • Manual Library Management
          • Acquiring a Library (MTB flow)
          • Acquiring Dependencies (MTB flow)
            • import_deps
            • lib2mtbx
          • Acquiring a Library (LIB flow)
          • Acquiring Dependencies (LIB flow)
        • Tool Change Description
      • ModusToolbox 2.3 Tools Package Release Notes
        • Overview
        • What’s Changed
          • New EZ-PD Configurator
          • Updated KitProg3 Firmware
          • Integrated Third Party IDE Support
          • Third Party IDE Secure Device Support
          • Improved Library Support and Control
          • Updated BSP Creation and Update Processes
          • Eclipse Update and macOS Big Sur Support
          • Windows Multi-User Installation Support
          • Update Quick Panel Performance
          • Project Creation / Library Management Message Improvements
          • Removed Power Estimator Tool
        • What’s Included
        • Supported Tool Chains
        • Supported Boards
        • Known Issues/Limitations
          • Installation
          • Project Creator
          • Proxy
          • Building/Programming/Debugging
          • Eclipse IDE
          • Library Manager
          • Device Configurator
          • CapSense Tuner
          • Documentation
        • Open Source
        • Further Reading
      • ModusToolbox™ AnyCloud 1.4.1 Release Notes
        • Overview
        • What’s New/Changed in Version 1.4.1
        • What was Included in Version 1.4
        • Known Issues/Limitations
          • GCC newlib Memory Leaks
        • More Information
    • Running Modus Toolbox from the Command Line
      • Introduction
      • Getting Started
        • git clone
        • make getlibs
        • make build
        • make program
        • make help
      • Application Types
      • Boards
      • Library Files
        • libs
        • getlibs
        • repos
      • Adding source files
        • Auto-Discovery
          • cyignore
          • TOOLCHAIN_<NAME>
          • TARGET_<NAME>
          • CONFIG_<NAME>
          • COMPONENT_<NAME>
          • BSP Make File
      • Pre-builds and Post-builds
      • Program and debug
      • Available Make Targets
        • General Make Targets
        • Tools Make Targets
        • Utility Make Targets
      • Available Make Variables
        • Basic Configuration Make Variables
        • Advanced Configuration Make Variables
        • Path Make Variables
        • Miscellaneous Make Variables
      • Troubleshooting on Windows
        • HOME Directory
        • Permissions
    • Build Process
      • PSoC6 GNU Make Build System
      • PSoC6 Prebuilt Images
      • Managing the Makefile for ModusToolbox® v2.x
        • Clocks & Buffers Tags
        • DOCUMENT HISTORY
    • ModusToolbox Version 2.1 Documentation
  • Hardware Reference
    • PSoC 6 Datasheets and Technical Reference Manuals
      • PSoC 61 MCU: CY8C61x6, and CY8C61x7 Datasheet
      • PSoC 61 Architecture Technical Reference Manual
      • PSoC 61 Register Technical Reference Manual
      • PSoC 62 MCU: CY8C62x6, and CY8C62x7 Datasheet
      • PSoC 62 MCU: CY8C62x8, and CY8C62xA Datasheet
      • PSoC 62 MCU: CY8C62x5 Datasheet
      • PSoC 62 with up to 512KB Flash, 256KB SRAM and 64 GPIOs Architecture Technical Reference Manual
      • PSoC 62 with up to 512KB Flash, 256KB SRAM and 64 GPIOs Registers Technical Reference Manual
      • PSoC 62 with up to 1MB Flash, 288KB SRAM and 104 GPIOs Architecture Technical Reference Manual
      • PSoC 62 with up to 1MB Flash, 288KB SRAM and 104 GPIOs Registers Technical Reference Manual
      • PSoC 62 with up to 2MB Flash, 1MB SRAM and 102 GPIOs Architecture Technical Reference Manual
      • PSoC 62 with up to 2MB Flash, 1MB SRAM and 102 GPIOs Registers Technical Reference Manual
      • PSoC 63 MCU: CY8C63x6, and CY8C63x7 Datasheet
      • PSoC 6 MCU: PSoC 63 with Bluetooth Low Energy Architecture Technical Reference Manual
      • PSoC 6 MCU: PSoC 63 with Bluetooth Low Energy Register Technical Reference Manual
      • PSoC 64 MCU: CYS0644xxZI-S2D44 Datasheet (Preliminary)
      • PSoC 64 MCU: CYB06447BZI-D54 Datasheet (Preliminary)
      • PSoC 64 MCU: CYB06447BZI-BLDX Datasheet (Preliminary)
      • PSoC 64 MCU: CYB06445LQI-S3D42 Datasheet (Preliminary)
      • PSoC 64 MCU: CYB0644XXZI-S2D44 Datasheet (Preliminary)
    • Supported Boards
      • CY8CKIT-062-BLE Board Support Package (BSP)
        • CY8CKIT-062-BLE BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Arduino Header Pins
            • J2 Header Pins
            • Capsense
            • WCO
          • Pin States
          • Errors
          • Functions
      • CY8CKIT-062-WIFI-BT Board Support Package (BSP)
        • CY8CKIT-062-WIFI-BT BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Arduino Header Pins
            • J2 Header Pins
            • Capsense
            • WCO
          • Pin States
          • Errors
          • Functions
          • Bluetooth Configuration Structure
      • CY8CKIT-062S2-43012 Board Support Package (BSP)
        • CY8CKIT-062S2-43012 BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Arduino Header Pins
            • J2 Header Pins
            • Capsense
            • WCO
          • Pin States
          • Errors
          • Functions
          • Bluetooth Configuration Structure
      • CY8CKIT-062S4 Board Support Package (BSP)
        • CY8CKIT-062S4 BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Arduino Header Pins
            • J2 Header Pins
            • Capsense
            • WCO
          • Pin States
          • Errors
          • Functions
      • CY8CKIT-064B0S2-4343W Board Support Package (BSP)
        • CY8CKIT-064B0S2-4343W BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Arduino Header Pins
            • J2 Header Pins
            • Capsense
            • WCO
          • Pin States
          • Errors
          • Functions
          • Bluetooth Configuration Structure
      • CY8CKIT-064S0S2-4343W Board Support Package (BSP)
        • CY8CKIT-064S0S2-4343W BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Arduino Header Pins
            • J2 Header Pins
            • Capsense
            • WCO
          • Pin States
          • Errors
          • Functions
          • Bluetooth Configuration Structure
      • CY8CPROTO-062-4343W Board Support Package (BSP)
        • CY8CPROTO-062-4343W BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Capsense
            • WCO
          • Pin States
          • Errors
          • Functions
          • Bluetooth Configuration Structure
      • CY8CPROTO-062S3-4343W Board Support Package (BSP)
        • CY8CPROTO-062S3-4343W BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Capsense
            • WCO
          • Pin States
          • Errors
          • Functions
          • Bluetooth Configuration Structure
      • CY8CPROTO-063-BLE Board Support Package (BSP)
        • CY8CPROTO-063-BLE BSP
        • BSP Overview
        • BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
          • Pin States
          • Error Codes
          • Functions
      • CY8CPROTO-064B0S1-BLE Board Support Package (BSP)
        • CY8CPROTO-064B0S1-BLE BSP
        • BSP Overview
        • BSP Settings
        • BSP API Reference
          • BSP API Reference
            • LED Pins
            • Button Pins
            • Communication Pins
            • WCO
          • Pin States
          • Error Codes
          • Functions
      • CY8CPROTO-064B0S3 Board Support Package (BSP)
        • CY8CPROTO-064B0S3 BSP
        • BSP Overview
        • BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • WCO
          • Pin States
          • Error Codes
          • Functions
      • CY8CPROTO-064S1-SB Board Support Package (BSP)
        • CY8CPROTO-064S1-SB BSP
        • BSP Overview
        • BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • WCO
          • Pin States
          • Functions
      • CYBLE-416045-EVAL Board Support Package (BSP)
        • CYBLE-416045-EVAL BSP
        • BSP Overview
        • BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Arduino Header Pins
            • J2 Header Pins
            • J6 Header Pins
          • Pin States
          • Error Codes
          • Functions
      • CYW9P62S1-43012EVB-01 Board Support Package (BSP)
        • CYW9P62S1-43012EVB-01 BSP
        • BSP Overview
        • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Arduino Header Pins
            • Capsense
            • WCO
          • Pin States
          • Error Codes
          • Functions
          • Bluetooth Configuration Structure
      • CYW9P62S1-43438EVB-01 Board Support Package (BSP)
        • CYW9P62S1-43438EVB-01 BSP
        • BSP Overview
        • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
            • Arduino Header Pins
            • J2 Header Pins
            • Capsense
            • WCO
          • Pin States
          • Error Codes
          • Functions
          • Bluetooth Configuration Structure
      • CYSBSYSKIT-01 Board Support Package (BSP)
        • CYSBSYSKIT-01 BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
        • BSP API Reference
          • Pin Mappings
            • LED Pins
            • Button Pins
            • Communication Pins
          • Pin States
      • TARGET_PSOC6-GENERIC Board Support Package (BSP)
        • PSOC6-GENERIC BSP
        • BSP Overview
          • ModusToolbox Board Support Package (BSP) Overview
        • BSP Settings
          • Peripheral Default BSP Settings
            • Peripheral Default HAL Settings:
        • BSP API Reference
          • Pin Mappings
            • Communication Pins
          • Pin States
          • Error Codes
          • Functions
    • WiFi Host Driver Board Support Package Integration
      • WiFi Host Driver Board Support Package Integration
      • API Reference
        • Buffer management
        • WiFi Initialization
PSoC 6 with AnyCloud
  • »
  • Feature Guides »
  • Low Power Development »
  • Power Mode Switching Example
  • Get Support in Our Community

Power Mode Switching Example¶

Click here to be taken to the project on GitHub.

Next Previous

© Cypress Semiconductor Corporation. All rights reserved.
Contact      > Legal     > https://www.cypress.com

Revision 54c1ae6e. Built with Sphinx using a theme provided by Read the Docs.
Switch Version v: latest
Versions
latest
Downloads
PSoC 6 with AnyCloud
Project Home
Builds