The reference is the exhaustive description of the whole library's API, with a description of every module. All you need to know in order to make your project is here.
Carbide
Carbide
— helper functions when using the standard Carbide boardCore, clocks and power management
Core
— interrupts, SysTick, reset, …DMA
— Direct Memory AccessPM
and BPM
— Power managementSCIF
and BSCIF
— Clock managementFlash
— Access to internal Flash memoryInput/output
GPIO
— General purpose digital input/output pinsADC
— Analog voltage inputDAC
— Analog voltage outputGLOC
— Glue logic (truth tables) controllerEIC
— External interrupts controllerCommunication ports
USART
— Serial portI2C
— simple and common communication busSPI
— quick communication protocolUSB
— Host and device USB communicationTimer/counters
TC
— Generic timer/counters, useful for PWMAST
— Asynchronous Timer, used by Core
for time()
and sleep()
WDT
— Watchdog timerCore
)Miscellanous
Utils modules
Modules below are not based on a peripheral in the microcontroller but are instead common-use classes that can be used to speed up development. They are compiled using the UTILS_MODULES
option in the Makefile.
RingBuffer
— Ring buffer implementationServo
— Helper class to control a servomotorThis tutorial explains how to install everything you need, how to build your first project and how to flash it to the microcontroller. You should start here!
This is a more advanced read for those who want to know how the library works and how to customize it. It is by no means necessary to make something great with libtungsten.