Home
14 Software API Guide
14.3 PIC32CX-BZ3 Device Support Component Library Help
The PIC32CX-BZ3 Device Support Component Library provides software API's for various subsystems in the PIC32CX-BZ3.
14.3.1 Device Support Library Usage
14.3.1.4 Sleep System
Sleep system helps to enter and exit sleep modes
14.3.1.4.2 DEVICE_SLEEP_ConfigRetRam Function

Introduction
1 Secure Boot and Signature Header Generation
2 Getting Started with WBZ351 Curiosity Board
This section covers evaluation board features and running the preprogrammed demo example
3 Getting Started with Software Development
This section gives a detailed information on the steps to install IDE, compiler, tool chain, BLE, Zigbee stacks and application examples on the PC.
4 Bluetooth Low Energy Applications
This section provides details on documentation describing the steps to test and develop the precompiled BLE application examples.
5 PIC32CXBZ3/WBZ35 Three-Wire PTA Coexistence Design
6 Getting Started with Zigbee Applications
7 Flashing hex from MPLAB DISCOVER using MPLAB IPE
This section provides a detailed procedure of how to download an already existing application hex file from MPLAB DISCOVER and flash the hex file into WBZ351 Curiosity Board using MPLAB IPE.
8 Adding Chip Peripherals
This section describes how to add analog/digital peripherals to the application
9 Low Power Design
This section explains in detail on how to enable the low power modes – Sleep/Standby or Deep Sleep/Backup modes in the design.
10 Firmware and OTA Updates
This section documents how to enable firmware updates in the design, whether it is serial or Over The Air (OTA)
11 Wireless System and Board Support Services
12 Application Timer Service
13 Support Documentation
This section has documentation that is generic and used as supporting document with the application example documentation.
14 Software API Guide
- 14.1 BLE Software
- 14.2 Zigbee SW
  Enter a short description of your topic here (optional).
- 14.3 PIC32CX-BZ3 Device Support Component Library Help
  The PIC32CX-BZ3 Device Support Component Library provides software API's for various subsystems in the PIC32CX-BZ3.
  - 14.3.1 Device Support Library Usage
    - 14.3.1.1 RF System
      RF System helps in initialization, calibration and other activities for using RF Sub system
    - 14.3.1.2 PMU System
      The PMU (Power Management Unit) subsystem helps in setting various power modes available in the system
    - 14.3.1.3 Info Block
      Information block helps in getting factory set values from the information base
    - 14.3.1.4 Sleep System
      Sleep system helps to enter and exit sleep modes
    - 14.3.1.5 Deep Sleep System
      Enter a short description of your topic here (optional).
  - 14.3.2 OSAL Extension for FreeRTOS
  - 14.3.3 App Idle Task
- 14.4 PIC32CX-BZ3 Persistent Data Server Component Library Help
  The PIC32CX-BZ3 Persistent Data Server Component Library provides interface for storing and restoring items into the Non volatile memory using wear leveling mechanism
Microchip Information

14.3.1.4.2 DEVICE_SLEEP_ConfigRetRam Function

C

void DEVICE_SLEEP_ConfigRetRam(bool enable);

Description

The API is used to enable/disable retention RAM

Parameters

bool enable Set as true to enable retention RAM; set as false to disable.

Returns

None