Gecko OS Native API

This is a list of all Gecko OS Native API functions, libraries, and utilities available for application development.
CoreThis contains all core API functionality
TypesAPI core data types
MacrosCore macros
MemoryBasic memory allocation/loading functions
CommandsFunctions for issuing Gecko OS commands
TypesCommand data types
Data StreamsFunctions for reading, writing, etc data streams
LoggingDebugging/logging functions
MacrosMacros related to logging
Kernel CallbacksApplication functions that are called BY the Kernel
Settings and NVMApps can uniquely configure Gecko OS with Gecko OS variables using the Settings API
Gecko OS SettingsFunctions for reading/writing/loading Gecko OS variables
MacrosSettings specific macros
Application NVMFunctions for reading/writing/loading NVM entries that are custom defined by Gecko OS applications
MacrosSettings specific macros
Device Management Server (DMS)The following APIs provide DMS related operations
TypesDMS data types
MacrosDMS macros
TelemetryDMS Telemetry
MessageDMS device stream messages
Firmware UpdateFirmware update operations
ActivationDMS activation operations
NetworkThis contains all network related functionality
InterfaceFunctions for starting/stop WLAN & SoftAP interfaces
TypesNetwork Interface Types
MacrosNetwork interface specific macros
Web SetupFunctions for enabling/disabling web setup
TypesData types for web setup
UtilityNetwork Utility functions
TypesNetwork Utility Types
ProtocolsThis contains various networking protocol functions
TCP/TLS Client/ServerTCP/TLS client/server functions
TypesTCP client/server types
UDP Client/ServerUDP client/server functions
TypesUDP client/server data types
HTTP ClientHTTP client functions
TypesHTTP client data types
HTTP ServerHTTP server functions
TypesHTTP server data types
MacrosHTTP server macros
HTTP File TransferHTTP file transfer functions
TypesHTTP file transfer data types
HTTP Server Data StreamHTTP server APIs to transfer data between a client and device application h1. Features
TypesHTTP server stream data types
General APIHTTP server stream general API for both REST and Websocket clients
Websocket APIHTTP server stream general API for Websocket clients
WebSocket Client/ServerWebSocket client/server functions
TypesWebSocket data types
SMTPSMTP functions
TypesSMTP data types
NTPNetwork Time Protocol functions
TypesNTP data types
Network DiscoveryThis contains various features for finding the device on a local network Refer to the command API documentation for more information:
mDNSMDNS functions
TypesMDNS data types
Periodic BroadcastPeriodic Broadcast Functions
TypesPeriodic broadcast data types
PeripheralsThis contains all hardware peripheral related functionality
GPIOFunctions for using General Purpose Input/Output (GPIO) peripheral
TypesHardware GPIO data types
ADCFunctions for using analog-to-digital (ADC) conversion peripheral
TypesHardware ADC data types
PWMFunctions for using Pulse-Width-Modulation (PWM) peripheral
I2C MasterFunctions for using Inter-Integrated Circuit (I2C) peripheral
TypesHardware I2C data types
MacrosHardware I2C macros
SPI MasterFunctions for using Serial Peripheral Interface (SPI) peripheral
TypesHardware SPI data types
MacrosHardware SPI macros
Stream APIsAPIs for accessing SPI master 'stream' functionality
Direct APIsAPIs for directly accessing SPI master peripheral
UARTFunctions for using Universal Asynchronous Receive/Transmit (UART) peripheral
TypesHardware UART data types
ButtonButton Utility
TypesButton data types
CRCChecksum/CRC Utilities
TypesChecksum/CRC data types
DMADirect Memory Access (DMA) APIs
TypesDMA data types
Custom CommandsThis contains all functionality needed to add/override commands to the Gecko OS Command API
TypesCommand types
MacrosCommand specific macros
Event HandlingThis contains all functionality needed to register/unregister event handlers
TypesEvent data types
MacrosEvent macros
RTOSThis contains all Real-Time Operating System (RTOS) functions
MacrosRTOS macros
TypesRTOS types
MutexRTOS mutex functions
SemaphoreRTOS semaphore functions
QueueRTOS queue functions
TimerRTOS timer functions
EventsRTOS event flag functions
MiscellaneousRTOS miscellaneous functions
File SystemThis contains all file system related functionality
TypesFile types
MacrosFile specific macros
Log FilesThis contains functional for reading/writing log files
TypesLog file types
MacrosLog file specific macros
SystemSystem APIs contain all functionality required to control device operation
TimeThis contains all time functionality
TypesTime specific types
IndicatorThis contains functionality to manage the system indicators
TypesSystem indicator types
PowersaveFunctions that reduce power consumption
Backup RegistersFunctions to read/write battery-backed hardware registers
MonitorFunctions to monitor system operations
MiscellaneousMiscellaneous system functions
TypesData types
UtilitiesThis contains various utilities
StringFunctions for processing strings
BitstringBitstring utility
TypesBitstring data types
JSONJSON Utilities
TypesJSON data types
MacrosJSON macros
MessagePackMessagePack Utilities
TypesMessagePack data types
MacrosMessagePack macros
ReadAPIs for unpacking MessagePack data into object and reading their values
WriteAPIs for packing data into a MessagePack message
Buffered WriterAPIs for writing (i.e. packing) data into a dynamic buffer
CSVCSV Utilities
TypesCSV data types
Base64Base64 Utilities
Decode StreamBase64 stream decoding
Encode StreamBase64 stream encoding
SortingSorting Utilities
Table/LookupTable/Lookup Utilities
MacrosTable/Lookup macros
CryptographyCryptography Utilities
AESAES utilities
TypesAES data types
MD5MD5 utilities
TypesMD5 data types
SHA1SHA1 utilities
TypesSHA1 data types
SHA256SHA256 utilities
TypesSHA256 data types
SHA512SHA512 utilities
TypesSHA512 data types
Secure Element (SE)Secure element utilities
TypesSecure element data types
Fixed-Point IntegerFixed-Point Integer Utilities
TypesFixed-Point Integer data types
MacrosFixed-Point Integer macros
DelayDelay Routines
Thread-Safe ObjectsThis utility contains mutable objects that are thread safe
Singly-Linked ListSingly-Linked List
TypesSingly-Linked List data types
MacrosSingly-Linked List data macros
Circular QueueCircular Queue
TypesCircular Queue data types
Dynamic BufferUtilities for populating a buffer of variable length
TypesDynamic Buffer data types
SDK Utilities and ComponentsSDK utilities and components
Example App UtilitiesUtilities for SDK example apps
Board-SpecificBoard-specific APIs
Secure ElementSecure Element Components
Microchip ATCAComponent for Microchip CryptoAuth devices
TypesATCA data types
Key PairElliptic Curve keypair APIs
CertificatesCertificate APIs
ConfigurationChip configuration APIs
ProfilerProfiling utility
TypesProfiler data types
MacrosProfiler macros