API Documentation#

Ash

Asynchronous Serial Host (ASH) Framework

Command Line Interface

Command line user interfaces for programs

• CLI Commands in NVM3 - Support for CLI commands stored in and executed from NVM3

• CLI Commands in RAM - Support for CLI commands stored in and executed from RAM

• CLI Delay - CLI Delay

Device Initialization

• Clock Initialization - Initialize the clock tree

• DCDC Boost Initialization - Initialize the DC-DC Boost converter

• DCDC Initialization - Initialize the DC-DC converter

• DPLL Initialization - Initialize the Digital PLL

• EMU Initialization - Initialize the Energy Management Unit

• HFRCO Initialization - Initialize the HFRCO oscillator

• HFXO Initialization - Initialize the HFXO oscillator

• LFRCO Initialization - Initialize the LFRCO oscillator

• LFXO Initialization - Initialize the LFXO oscillator

• NVIC Initialization - Initialize the NVIC Interrupt Handlers priority

• RFFPLL Initialization - <docspace-docleaf-version>

• USB PLL Initialization - Initialize the USB PLL

Em2xx_resets

HFXO Manager

HFXO Manager

I/O Stream

I/O Stream can be used to read/write different formats of data to various streams. The source files for I/O Stream platform software module are present under platform/services/iostream

• I/O Stream CPC - I/O Stream CPC

• I/O Stream EUSART - I/O Stream EUSART

• I/O Stream LEUART - I/O Stream LEUART

• I/O Stream RTT - I/O Stream RTT

• I/O Stream STDLIB Configuration - I/O Stream STDLIB Configuration

• I/O Stream SWO - I/O Stream SWO

• I/O Stream UART - I/O Stream UART

• I/O Stream USART - I/O Stream USART

Legacy HAL

The Legacy HAL is an implementation of the Hardware Abstraction Layer (HAL) that was used by the Zigbee EmberZNet and Flex Connect stacks before their transition to the new component-based architecture (Zigbee version 7.0 and Connect version 3.0). This component is not a complete duplicate of the old HAL. It only contains the most commonly used pieces to enable our networking stacks and sample applications and to support porting customer applications to the new component-based implementation. Currently, Zigbee and Connect sample applications are dependent on this component. Eventually, they will be ported to use new HAL components directly so that this component can become optional or be deprecated

• Application Bootloader Interface - Definition of the application bootloader interface

• Button - Sample API functions for using push-buttons

• Common Bootloader - Common bootloader interface defines and functions

• Cyclic Redundancy Check - Functions that provide access to cyclic redundancy code (CRC) calculation. See crc.h for source code

• Diagnostics - Crash and watchdog diagnostic functions

• LED - Sample API funtions for controlling LEDs

• Microcontroller functions - Microcontroller functions

• Random generation - Functions that provide access to random numbers

• Reset Cause Definitions - Definitions for all the reset cause types

• SimEE2 to NVM3 Upgrade

• Simulated EEPROM 1 and 2 - Simulated EEPROM 1 and 2 legacy storage

• Standalone Bootloader - Definition of the standalone bootloader interface

• Library initialization

• Message authentication codes

• Message digests

Microsecond Delay

Microsecond delay function

Power Manager

platform level software module that manages the system's energy modes

RAM execution disable

RAM execution disable utilities can be used to disable execution from RAM and other selected memory regions

RAM interrupt vector initialization

Simple utility to move the interrupt vector table to RAM

Sleep Timer

Sleep Timer can be used for creating timers

System Initialization and Action Processing

System Initialization and Action Processing.

Token Manager

Routines for working with tokens.