API Index
A simple interface definition language (IDL) similar to C is provided to help define APIs so they can be used in multiple, different programming languages. See API Files.
The following is a directory of all API's that are included by the Framework and by including default.sdef within your system.
Legato Daemon APIs
The Legato AF Daemons provide full-featured interface access to configure and control services and Apps:
| Daemon | API Guide | API Reference | File Name | Description |
|---|---|---|---|---|
| configTree | Config Tree API | le_cfg API Reference | le_cfg.api | Functions to read and write data into the App's Tree |
| configTree | Config Tree Admin API | le_cfgAdmin API Reference | le_cfgAdmin.api | Tools to facilitate the administration of App's Trees |
| supervisor | App Control API | le_appCtrl API Reference | le_appCtrl.api | Control Legato apps |
| supervisor | Application Information API | le_appInfo API Reference | le_appInfo.api | Legato app info retrieval |
| supervisor | Framework Control API | le_framework API Reference | le_framework.api | Control the Legato Framework |
| supervisor | Linux Kernel Module API | le_kernelModule API Reference | le_kernelModule.api | Module load and unload |
| update | Update API | le_update API Reference | le_update.api | Control the update daemon on the target |
| update | Update Control API | le_updateCtrl API Reference | le_updateCtrl.api | Tools to facilitate the administration of the update daemon |
| update | Install Status API | le_instStat API Reference | le_instStat.api | Notifications when apps are installed and uninstalled |
| watchdog | Watchdog Service | le_wdog API Reference | le_wdog.api | Monitor critical applications and services for deadlocks and other similar faults |
Platform Service APIs
Platform Services provide full-featured interface access to system and modem resources:
Location: $LEGATO_ROOT/interfaces
| Service | API Guide | API Reference | File Name | Description |
|---|---|---|---|---|
| AirVantage | AirVantage Connector API | le_avc API Reference | le_avc.api | Control and configure upgrade and network settings |
| AirVantage | AirVantage Data API | le_avdata API Reference | le_avdata.api | Send and receive data from the AirVantage Server |
| Audio | Audio | le_audio API Reference | le_audio.api | Handles audio interfaces including play and record supported formats |
| Cellular Network | Cellular Network | le_cellnet API Reference | le_cellnet.api | Ensures that the modem is registered on the network when an user application makes a request for network access |
| Data Channels | le_dcs Interface | le_dcs API Reference | le_dcs.api | Creates and manages multiple data channels |
| Data Channels | le_net Interface | le_net API Reference | le_net.api | Manages the network configs of data channels managed by le_dcs |
| Data Channels | le_data Interface | le_data API Reference | le_data.api | Simplified interfaces for servicing a single data connection with no control over connection type & parameters |
| GPIO | GPIO | le_gpio API Reference | le_gpio.api | Controls general-purpose digital input/output pins |
| Modem | ADC Channel API | le_adc API Reference | le_adc.api | Analog to digital converter |
| Modem | Antenna Monitoring | le_antenna API Reference | le_antenna.api | Antenna diagnostics |
| Modem | eCall | le_ecall API Reference | le_ecall.api | EU auto accident assistance program |
| Modem | Input Power Supply Monitoring API | le_ips API Reference | le_ips.api | Input voltage data |
| Modem | Low Power Technologies | le_lpt API Reference | le_lpt.api | Control modem low power technologies |
| Modem | Modem Call Control | le_mcc API Reference | le_mcc.api | Control voice calls |
| Modem | Modem Data Control | le_mdc API Reference | le_mdc.api | Control modem data connections |
| Modem | Modem Information | le_info API Reference | le_info.api | Retrieve modem data information |
| Modem | Modem Radio Control | le_mrc API Reference | le_mrc.api | Modem radio controls |
| Modem | Remote SIM service | le_rsim API Reference | le_rsim.api | Remote SIM service |
| Modem | Ring Indicator Signal | le_riPin API Reference | le_riPin.api | Ring indicator for host wakeup |
| Modem | SIM | le_sim API Reference | le_sim.api | SIM access |
| Modem | Temperature Monitoring | le_temp API Reference | le_temp.api | Temperature monitoring |
| Modem | User Timebase | le_rtc API Reference | le_rtc.api | Set user time base for RTC |
| Positioning | GNSS | le_gnss API Reference | le_gnss.api | GNSS device control |
| Positioning | Positioning | le_pos API Reference | le_pos.api | Device physical position/movement |
| Power | Power Manager | le_pm API Reference | le_pm.api | Device power management |
| Power | Ultra Low Power Mode | le_ulpm API Reference | le_ulpm.api | Ultra-low device power management |
| Power | Boot Reason Query | le_bootReason API Reference | le_bootReason.api | Device power management |
| SecStore | Secure Storage | le_secStore API Reference | le_secStore.api | secure storage access |
| SecStore | Secure Storage Admin | secStoreAdmin API Reference | le_secStoreAdmin.api | secure storage admin control |
| SMS | SMS | le_sms API Reference | le_sms.api | SMS messaging |
| SMS | SMS Inbox | le_smsInbox1 API Reference | le_smsInbox1.api | SMS Inbox Service |
| SPI | SPI | le_spi API Reference | le_spi.api | Serial Port Interface |
| VoiceCall | Voice Call Service | le_voicecall API Reference | le_voicecall.api | Controls the voice call service |
| WiFi | WiFi Access Point Service | le_wifiAp API Reference | le_wifiAp.api | Create an access point that clients can connect to |
| WiFi | WiFi Client Service | le_wifiClient API Reference | le_wifiClient.api | Connect to a WiFi access point. |
| AT | AT Commands Client | le_atClient API Reference | le_atClient.api | AT commands client |
| AT | AT Commands Server | le_atServer API Reference | le_atServer.api | AT commands server |
| Port | Port Service | le_port API Reference | le_port.api | Port service |
| Clock Service | Clock Service's Clock Sync Interface | le_clkSync API Reference | le_clkSync.api | Manages and syncs clock time on a Legato device |
Legato C APIs
Lib Legato available APIs to provide more functionality to your Legato C Code and extend C.
Location: $LEGATO_ROOT/framework/include
| API Guide | API Reference | File Name | Description |
|---|---|---|---|
| Command Line Arguments API | le_args.h | le_args.h | Provides the ability to add arguments from the command line |
| Atomic File Operation API | le_atomFile.h | le_atomFile.h | Provides atomic file access mechanism that can be used to perform file operation (specially file write) in atomic fashion |
| Basic Type and Constant Definitions | le_basics.h | le_basics.h | Provides error codes, portable integer types, and helpful macros that make things easier to use |
| System Clock API | le_clock.h | le_clock.h | Gets/sets date and/or time values, and performs conversions between these values. |
| CRC32 API | le_crc.h | le_crc.h | Provides the ability to compute the CRC of a binary buffer |
| Directory API | le_dir.h | le_dir.h | Provides functions to control directories |
| Doubly Linked List API | le_doublyLinkedList.h | le_doublyLinkedList.h | Provides a data structure that consists of data elements with links to the next node and previous nodes |
| Event Loop API | le_eventLoop.h | le_eventLoop.h | Provides event loop functions to support the event-driven programming model |
| File Descriptor Monitor API | le_fdMonitor.h | le_fdMonitor.h | Provides monitoring of file descriptors, reporting, and related events |
| File Locking API | le_fileLock.h | le_fileLock.h | Provides file locking, a form of IPC used to synchronize multiple processes' access to common files |
| File System service | le_fs.h | le_fs.h | Provides a way to access the file system across different platforms |
| HashMap API | le_hashmap.h | le_hashmap.h | Provides creating, iterating and tracing functions for a hashmap |
| Hex string API | le_hex.h | le_hex.h | Provides conversion between Hex and Binary strings |
| JSON Parsing API | le_json.h | le_json.h | Provides fast parsing of a JSON data stream with very little memory required |
| Logging API | le_log.h | le_log.h | Provides a toolkit allowing code to be instrumented with error, warning, informational, and debugging messages |
| Dynamic Memory Allocation API | le_mem.h | le_mem.h | Provides functions to create, allocate and release data from a memory pool |
| Low-level Messaging API | le_messaging.h | le_messaging.h | Provides support to low level messaging within Legato |
| Mutex API | le_mutex.h | le_mutex.h | Provides standard mutex functionality with added diagnostics capabilities |
| Low-level Pack/Unpack API | le_pack.h | le_pack.h | Provides low-level pack/unpack functions to support the higher level IPC messaging system |
| Path API | le_path.h | le_path.h | Provides support for UTF-8 null-terminated strings and multi-character separators |
| Path Iterator API | le_pathIter.h | le_pathIter.h | Iterate over paths, traverse the path node-by-node, or create and combine paths together |
| Random Number API | le_rand.h | le_rand.h | Used for cryptographic purposes such as encryption keys, initialization vectors, etc. |
| Safe References API | le_safeRef.h | le_safeRef.h | Protect from damaged or stale references being used by clients |
| Semaphore API | le_semaphore.h | le_semaphore.h | Provides standard semaphore functionality, but with added diagnostic capabilities |
| Signals API | le_signals.h | le_signals.h | Provides software interrupts for running processes or threads |
| Singly Linked List API | le_singlyLinkedList.h | le_singlyLinkedList.h | Provides a data structure consisting of a group of nodes linked together linearly |
| Unit Testing API | le_test.h | le_test.h | Provides macros that are used to simplify unit testing |
| Thread Control API | le_thread.h | le_thread.h | Provides controls for creating, ending and joining threads |
| Timer API | le_timer.h | le_timer.h | Provides functions for managing and using timers |
| tty API | le_tty.h | le_tty.h | Provides routines to configure serial ports |
| UTF-8 String Handling API | le_utf8.h | le_utf8.h | Provides safe and easy to use string handling functions for null-terminated strings with UTF-8 encoding |
Copyright (C) Sierra Wireless Inc.