Gecko OS Native API
This is a list of all Gecko OS Native API functions, libraries, and utilities available for application development.
Core | This contains all core API functionality |
Memory | Basic memory allocation/loading functions |
Commands | Functions for issuing Gecko OS commands |
Types | Command data types |
Data Streams | Functions for reading, writing, etc data streams |
Logging | Debugging/logging functions |
Macros | Macros related to logging |
Types | API core data types |
Macros | Core macros |
Settings and NVM | Apps can uniquely configure Gecko OS with Gecko OS variables using the Settings API |
Gecko OS Settings | Functions for reading/writing/loading Gecko OS variables |
Macros | Settings specific macros |
Application NVM | Functions for reading/writing/loading NVM entries that are custom defined by Gecko OS applications |
Macros | Settings specific macros |
Device Management Server (DMS) | The following APIs provide DMS related operations |
Types | DMS data types |
Macros | DMS macros |
Telemetry | DMS Telemetry |
Message | DMS device stream messages |
Firmware Update | Firmware update operations |
Activation | DMS activation operations |
Network | This contains all network related functionality |
Interface | Functions for starting/stop WLAN & SoftAP interfaces |
Types | Network Interface Types |
Macros | Network interface specific macros |
Web Setup | Functions for enabling/disabling web setup |
Types | Data types for web setup |
Utility | Network Utility functions |
Types | Network Utility Types |
Protocols | This contains various networking protocol functions |
TCP/TLS Client/Server | TCP/TLS client/server functions |
Types | TCP client/server types |
UDP Client/Server | UDP client/server functions |
Types | UDP client/server data types |
HTTP Client | HTTP client functions |
Types | HTTP client data types |
HTTP Server | HTTP server functions |
Types | HTTP server data types |
Macros | HTTP server macros |
HTTP File Transfer | HTTP file transfer functions |
Types | HTTP file transfer data types |
WebSocket Client/Server | WebSocket client/server functions |
Types | WebSocket data types |
SMTP | SMTP functions |
Types | SMTP data types |
NTP | Network Time Protocol functions |
Types | NTP data types |
Network Discovery | This contains various features for finding the device on a local network Refer to the command API documentation for more information: |
mDNS | MDNS functions |
Types | MDNS data types |
Periodic Broadcast | Periodic Broadcast Functions |
Types | Periodic broadcast data types |
Peripherals | This contains all hardware peripheral related functionality |
GPIO | Functions for using General Purpose Input/Output (GPIO) peripheral |
Types | Hardware GPIO data types |
ADC | Functions for using analog-to-digital (ADC) conversion peripheral |
Types | Hardware ADC data types |
PWM | Functions for using Pulse-Width-Modulation (PWM) peripheral |
I2C Master | Functions for using Inter-Integrated Circuit (I2C) peripheral |
Types | Hardware I2C data types |
Macros | Hardware I2C macros |
SPI Master | Functions for using Serial Peripheral Interface (SPI) peripheral |
Types | Hardware SPI data types |
Macros | Hardware SPI macros |
UART | Functions for using Universal Asynchronous Receive/Transmit (UART) peripheral |
Types | Hardware UART data types |
Button | Button Utility |
Types | Button data types |
CRC | Checksum/CRC Utilities |
Types | Checksum/CRC data types |
Custom Commands | This contains all functionality needed to add/override commands to the Gecko OS Command API |
Types | Command types |
Macros | Command specific macros |
Event Handling | This contains all functionality needed to register/unregister event handlers |
Types | Event data types |
Macros | Event macros |
RTOS | This contains all Real-Time Operating System (RTOS) functions |
Macros | RTOS macros |
Types | RTOS types |
Mutex | RTOS mutex functions |
Semaphore | RTOS semaphore functions |
Queue | RTOS queue functions |
Timer | RTOS timer functions |
Events | RTOS event flag functions |
Miscellaneous | RTOS miscellaneous functions |
File System | This contains all file system related functionality |
Types | File types |
Macros | File specific macros |
Log Files | This contains functional for reading/writing log files |
Types | Log file types |
Macros | Log file specific macros |
System | System APIs contain all functionality required to control device operation |
Time | This contains all time functionality |
Types | Time specific types |
Powersave | Functions that reduce power consumption |
Backup Registers | Functions to read/write battery-backed hardware registers |
Monitor | Functions to monitor system operations |
Miscellaneous | Miscellaneous system functions |
Utilities | This contains various utilities |
String | Functions for processing strings |
JSON | JSON Utilities |
Types | JSON data types |
Macros | JSON macros |
MessagePack | MessagePack Utilities |
Types | MessagePack data types |
Macros | MessagePack macros |
Read | APIs for unpacking MessagePack data into object and reading their values |
Write | APIs for packing data into a MessagePack message |
CSV | CSV Utilities |
Types | CSV data types |
Base64 | Base64 Utilities |
Types | Base64 data types |
Sorting | Sorting Utilities |
Table/Lookup | Table/Lookup Utilities |
Macros | Table/Lookup macros |
Cryptography | Cryptography Utilities |
AES | AES utilities |
Types | AES data types |
MD5 | MD5 utilities |
Types | MD5 data types |
SHA1 | SHA1 utilities |
Types | SHA1 data types |
SHA2 | SHA2 utilities |
Types | SHA2 data types |
Fixed-Point Integer | Fixed-Point Integer Utilities |
Types | Fixed-Point Integer data types |
Macros | Fixed-Point Integer macros |
Delay | Delay Routines |
Functions | Delay Functions |
Api_hw_dma_types | |
Api_hw_dma |