builtin-libraries.rst

Built-in Libraries

The XMC for Arduino platform provides a comprehensive set of built-in libraries that enable developers to easily access and utilize the XMC microcontrollers' features and peripherals. This section lists these libraries, including their functionality and supported boards.

DeviceControl XMC

Examples Supported

Examples	Boards	Description
DieTemperatureMeasurement	XMC1100 XMC 2GO XMC1100 Boot Kit XMC1100 H-Bridge 2GO XMC1300 Boot Kit XMC1400 2GO Kit XMC1400 Arduino Kit XMC4400 Platform 2Go XMC4700 Relax Kit	Simple die temperature measurement for XMC devices which demonstrates themeasure temperature of die using sensor.
HeapMemoryMeasurement	XMC1100 XMC 2GO XMC1100 Boot Kit XMC1100 H-Bridge 2GO XMC1300 Boot Kit XMC1400 2GO Kit XMC1400 Arduino Kit XMC4700 Relax Kit	Simple example to check heap memory during run time for XMC devices which demonstrates the ability to check on free heap memory.
SleepModeXMC1100	XMC1100 XMC 2GO XMC1100 Boot Kit XMC1100 H-Bridge 2GO XMC1300 Boot Kit XMC1400 2GO Kit XMC1400 Arduino Kit	Demonstrates the use of an alarm to wake up an xmc1100 from sleep mode.
SleepModeXMC4700	XMC4700 Relax Kit	Simple Sleep Mode for XMC4700 Relax Kit V1 demonstrates the use of an alarm to wake up an XMC4700 from sleep mode. LED2 will blink fast on active mode. If CCU4 is ON in sleep mode, LED2 will blink slower (because of slower clock) while in sleep mode. If CCU is OFF in sleep mode, LED2 will stop blinking, until device wakes up.
StackMemoryMeasurement	XMC1100 XMC 2GO XMC1100 Boot Kit XMC1100 H-Bridge 2GO XMC1300 Boot Kit XMC4400 Platform 2Go XMC4700 Relax Kit	Simple example to check stack memory during run time for XMC devices which demonstrates the ability to check on free stack memory

DMA

Examples Supported

Examples	Boards	Description
DMA_Memory	XMC4700 Relax Kit	Demonstrates how to setup an DMA, to transfer data between two places in memory.
DMA_UART	XMC4700 Relax Kit	Demonstrates how to setup an DMA, to transfer data between two places in memory.

RTC Library

Examples	Boards	Description
AlarmRTC	XMC4700 Relax Kit	Demonstrates how to set an RTC alarm for the XMC4700 Relax Kit V1.
SimpleRTC	XMC4700 Relax Kit	Demonstrates the use of the RTC library for the XMC4700.

SPI Library

Examples	Boards	Description
SPI_MOSI_to_MISO _SameDevice	XMC1100 XMC 2GO XMC1100 Boot Kit XMC1100 H-Bridge 2GO XMC1300 Boot Kit XMC1400 2GO Kit XMC1400 Arduino Kit XMC4400 Platform 2Go XMC4700 Relax Kit	SPI example which communicates between the MOSI and MISO pin of the same board. Connect the MOSI pin to the MOSI pin as hardware setup.

Wire Library

Examples	Boards	Description
master_reader	XMC1100 XMC 2GO XMC1100 Boot Kit XMC1100 H-Bridge 2GO XMC1300 Boot Kit XMC1400 2GO Kit XMC1400 Arduino Kit XMC4400 Platform 2Go XMC4700 Relax Kit	Demonstrates use of the Wire library. Reads data from an I2C/TWI slave device. Refer to the "Wire Slave Sender" example for use with this. Then it communicates using I2C protocol between two supported XMC boards. Connect the SDA and SCL pins of one board to the SDA and SCL pin of the other board.
master_writer	XMC1100 XMC 2GO XMC1100 Boot Kit XMC1100 H-Bridge 2GO XMC1300 Boot Kit XMC1400 2GO Kit XMC1400 Arduino Kit XMC4400 Platform 2Go XMC4700 Relax Kit	Demonstrates use of the Wire library. Writes data to an I2C/TWI slave device. Refer to the "Wire Slave Receiver" example for use with this. Then it communicates using I2C protocol between two supported XMC boards. Connect the SDA and SCL pins of one board to the SDA and SCL pin of the other board.
slave_receiver	XMC1100 XMC 2GO XMC1100 Boot Kit XMC1100 H-Bridge 2GO XMC1300 Boot Kit XMC1400 2GO Kit XMC1400 Arduino Kit XMC4400 Platform 2Go XMC4700 Relax Kit	Demonstrates use of the Wire library. Receives data as an I2C/TWI slave device. Refer to the "Wire Slave Writer" example for use with this. Then it communicates using I2C protocol between two supported XMC boards. Connect the SDA and SCL pins of one board to the SDA and SCL pin of the other board.
slave_sender	XMC1100 XMC 2GO XMC1100 Boot Kit XMC1100 H-Bridge 2GO XMC1300 Boot Kit XMC1400 2GO Kit XMC1400 Arduino Kit XMC4400 Platform 2Go XMC4700 Relax Kit	Demonstrates use of the Wire library. Receives data as an I2C/TWI slave device. Refer to the "Wire Master Reader" example for use with this. Then it communicates using I2C protocol between two supported XMC boards. Connect the SDA and SCL pins of one board to the SDA and SCL pin of the other board.

I2S Library

This library has been tested with the IM69D130 Microphone Shield2Go with both XMC4700 Relax Kit and XMC1100 XMC2Go. Please refer to the README.md of the I2S library for pin connections.

Limitations

With XMC 2Go (possibly also with other XMC1000 family devices), you might easily overflow the I2S buffer and you should try to reduce the I2S sampling rate if so.

OneWire Library

Library for One wire protocol. It could be used to access 1-wire temperature sensors, memory and other chips.

CAN Library

This library provides support for the CAN protocol. For further details, please refer to the README.md file in the CAN library.

Examples	Boards	Description
CANSender	XMC1400 2GO	This example demonstrates how to send a CAN message. It supports two different message/frame formats: standard and extended. The CAN standard frame uses an 11-bit identifier, while the CAN extended frame uses a 29-bit identifier.
CANReceiver/ CANReceiverCallback	XMC1400 2GO	This example demonstrates how to receive a CAN message. There are two methods for receiving messages: the default method runs a loop that continuously polls for new messages, while the callback method registers a callback function that triggers an interrupt when data is received on the CAN bus. In both examples, messages with any ID transmitted on the CAN bus can be received. Additionally, messages can be filtered for specific IDs using the filter() function.
CANLoopBack	XMC1400 2GO	This example demonstrates the loopback mode of CAN. In this mode, the CAN transmitter is internally connected to its receiver, allowing the message to be sent and received internally without transmission onto the actual CAN bus.