86f075a962
The LoRa and LoRaWAN documentation was not included anywhere, so the Doxygen comments in drivers/lora.h and lorawan/lorawan.h were not rendered. This commit adds a new section for LoRa and LoRaWAN to the documentation. People often confuse the difference between LoRa and LoRaWAN, so it makes sense to combine both in the same doc section. LoRa would otherwise not fit very well into any docs category, as it is a driver, but not really a peripheral. Signed-off-by: Martin Jäger <martin@libre.solar>
339 lines
4.4 KiB
ReStructuredText
339 lines
4.4 KiB
ReStructuredText
.. _api_overview:
|
|
|
|
API Overview
|
|
############
|
|
|
|
The table lists Zephyr's APIs and information about them, including their
|
|
current :ref:`stability level <api_lifecycle>`.
|
|
|
|
.. Keep this list sorted by the name of the API as it appears
|
|
in the HTML, *NOT* the :ref: label
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - API
|
|
- Status
|
|
- Version Introduced
|
|
- Version Modified
|
|
|
|
* - :ref:`adc_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.6
|
|
|
|
* - :ref:`audio_codec_api`
|
|
- Experimental
|
|
- 1.13
|
|
- 1.13
|
|
|
|
* - :ref:`audio_dmic_api`
|
|
- Experimental
|
|
- 1.13
|
|
- 1.13
|
|
|
|
* - :ref:`bluetooth_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.4
|
|
|
|
* - :ref:`clock_control_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.6
|
|
|
|
* - :ref:`coap_sock_interface`
|
|
- Unstable
|
|
- 1.10
|
|
- 2.4
|
|
|
|
* - :ref:`can_api`
|
|
- Unstable
|
|
- 1.14
|
|
- 3.0
|
|
|
|
* - :ref:`counter_api`
|
|
- Unstable
|
|
- 1.14
|
|
- 2.6
|
|
|
|
* - :ref:`crypto_api`
|
|
- Stable
|
|
- 1.7
|
|
- 2.2
|
|
|
|
* - :ref:`dac_api`
|
|
- Experimental
|
|
- 2.3
|
|
- 2.3
|
|
|
|
* - :ref:`dma_api`
|
|
- Stable
|
|
- 1.5
|
|
- 2.6
|
|
|
|
* - :ref:`device_model_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.4
|
|
|
|
* - :ref:`devicetree_api`
|
|
- Stable
|
|
- 2.2
|
|
- 2.6
|
|
|
|
* - :ref:`disk_access_api`
|
|
- Stable
|
|
- 1.6
|
|
- 2.0
|
|
|
|
* - :ref:`display_api`
|
|
- Unstable
|
|
- 1.14
|
|
- 2.2
|
|
|
|
* - :ref:`ec_host_cmd_periph_api`
|
|
- Experimental
|
|
- 2.4
|
|
- 2.4
|
|
|
|
* - :ref:`edac_api`
|
|
- Experimental
|
|
- 2.5
|
|
- 2.5
|
|
|
|
* - :ref:`eeprom_api`
|
|
- Stable
|
|
- 2.1
|
|
- 2.1
|
|
|
|
* - :ref:`entropy_api`
|
|
- Stable
|
|
- 1.10
|
|
- 1.12
|
|
|
|
* - :ref:`file_system_api`
|
|
- Stable
|
|
- 1.5
|
|
- 2.4
|
|
|
|
* - :ref:`flash_api`
|
|
- Stable
|
|
- 1.2
|
|
- 2.6
|
|
|
|
* - :ref:`fcb_api`
|
|
- Stable
|
|
- 1.11
|
|
- 2.1
|
|
|
|
* - :ref:`flash_map_api`
|
|
- Stable
|
|
- 1.11
|
|
- 2.6
|
|
|
|
* - :ref:`gna_api`
|
|
- Experimental
|
|
- 1.14
|
|
- 1.14
|
|
|
|
* - :ref:`gpio_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.6
|
|
|
|
* - :ref:`hwinfo_api`
|
|
- Stable
|
|
- 1.14
|
|
- 2.3
|
|
|
|
* - :ref:`i2c_eeprom_slave_api`
|
|
- Stable
|
|
- 1.13
|
|
- 1.13
|
|
|
|
* - :ref:`i2c_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.6
|
|
|
|
* - :ref:`i2c-slave-api`
|
|
- Experimental
|
|
- 1.12
|
|
- 1.12
|
|
|
|
* - :ref:`i2s_api`
|
|
- Stable
|
|
- 1.9
|
|
- 2.6
|
|
|
|
* - :ref:`ipm_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.4
|
|
|
|
* - :ref:`kscan_api`
|
|
- Stable
|
|
- 2.1
|
|
- 2.6
|
|
|
|
* - :ref:`kernel_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.6
|
|
|
|
* - :ref:`led_api`
|
|
- Stable
|
|
- 1.12
|
|
- 2.6
|
|
|
|
* - :ref:`lwm2m_interface`
|
|
- Unstable
|
|
- 1.9
|
|
- 2.5
|
|
|
|
* - :ref:`logging_api`
|
|
- Stable
|
|
- 1.13
|
|
- 1.14
|
|
|
|
* - :ref:`lora_api`
|
|
- Experimental
|
|
- 2.2
|
|
- 2.2
|
|
|
|
* - :ref:`lorawan_api`
|
|
- Experimental
|
|
- 2.5
|
|
- 2.5
|
|
|
|
* - :ref:`mqtt_socket_interface`
|
|
- Unstable
|
|
- 1.14
|
|
- 2.4
|
|
|
|
* - :ref:`misc_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.2
|
|
|
|
* - :ref:`networking_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.4
|
|
|
|
* - :ref:`nvs_api`
|
|
- Stable
|
|
- 1.12
|
|
- 1.14
|
|
|
|
* - :ref:`peci_api`
|
|
- Stable
|
|
- 2.1
|
|
- 2.6
|
|
|
|
* - :ref:`ps2_api`
|
|
- Stable
|
|
- 2.1
|
|
- 2.6
|
|
|
|
* - :ref:`pwm_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.6
|
|
|
|
* - :ref:`pinctrl_api`
|
|
- Experimental
|
|
- 3.0
|
|
- 3.0
|
|
|
|
* - :ref:`pinmux_api`
|
|
- Stable
|
|
- 1.0
|
|
- 1.11
|
|
|
|
* - :ref:`pm_api`
|
|
- Experimental
|
|
- 1.2
|
|
- 2.2
|
|
|
|
* - :ref:`random_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.1
|
|
|
|
* - :ref:`regulator_api`
|
|
- Experimental
|
|
- 2.4
|
|
- 2.4
|
|
|
|
* - :ref:`spi_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.6
|
|
|
|
* - :ref:`sensor_api`
|
|
- Stable
|
|
- 1.2
|
|
- 2.6
|
|
|
|
* - :ref:`settings_api`
|
|
- Stable
|
|
- 1.12
|
|
- 2.1
|
|
|
|
* - :ref:`shell_api`
|
|
- Stable
|
|
- 1.14
|
|
- 2.4
|
|
|
|
* - :ref:`stream_flash`
|
|
- Experimental
|
|
- 2.3
|
|
- 2.3
|
|
|
|
* - :ref:`task_wdt_api`
|
|
- Experimental
|
|
- 2.5
|
|
- 2.5
|
|
|
|
* - :ref:`tcpc_api`
|
|
- Experimental
|
|
- 3.1
|
|
- 3.1
|
|
|
|
* - :ref:`uart_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.6
|
|
|
|
* - :ref:`UART async <uart_api>`
|
|
- Unstable
|
|
- 1.14
|
|
- 2.2
|
|
|
|
* - :ref:`usb_api`
|
|
- Stable
|
|
- 1.5
|
|
- 2.4
|
|
|
|
* - :ref:`usermode_api`
|
|
- Stable
|
|
- 1.11
|
|
- 1.11
|
|
|
|
* - :ref:`util_api`
|
|
- Experimental
|
|
- 2.4
|
|
- 2.4
|
|
|
|
* - :ref:`video_api`
|
|
- Stable
|
|
- 2.1
|
|
- 2.6
|
|
|
|
* - :ref:`watchdog_api`
|
|
- Stable
|
|
- 1.0
|
|
- 2.0
|