text stringlengths 9 39.2M | dir stringlengths 25 226 | lang stringclasses 163
values | created_date timestamp[s] | updated_date timestamp[s] | repo_name stringclasses 751
values | repo_full_name stringclasses 752
values | star int64 1.01k 183k | len_tokens int64 1 18.5M |
|---|---|---|---|---|---|---|---|---|
```restructuredtext
.. _haptics_api:
Haptics
#######
Overview
********
The haptics API allows for the control of haptic driver devices for the
purposes of performing haptic feedback events.
During a haptic feedback event the haptic device drives a signal to an
actuator. The source of the haptic event signal varies ... | /content/code_sandbox/doc/hardware/peripherals/haptics.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 166 |
```restructuredtext
.. _dac_api:
Digital-to-Analog Converter (DAC)
#################################
Overview
********
The DAC API provides access to Digital-to-Analog Converter (DAC) devices.
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_DAC`
API Reference
... | /content/code_sandbox/doc/hardware/peripherals/dac.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 70 |
```restructuredtext
.. _mbox_api:
Multi-Channel Inter-Processor Mailbox (MBOX)
############################################
Overview
********
An MBOX device is a peripheral capable of passing signals (and data depending
on the peripheral) between CPUs and clusters in the system. Each MBOX instance
is providing one o... | /content/code_sandbox/doc/hardware/peripherals/mbox.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 98 |
```restructuredtext
.. _spi_api:
Serial Peripheral Interface (SPI) Bus
#####################################
Overview
********
API Reference
*************
.. doxygengroup:: spi_interface
``` | /content/code_sandbox/doc/hardware/peripherals/spi.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 36 |
```restructuredtext
.. _coredump_device_api:
Coredump Device
###############
Overview
********
The coredump device is a pseudo-device driver with two types.A COREDUMP_TYPE_MEMCPY
type exposes device tree bindings for memory address/size values to be included in
any dump. And the driver exposes an API to add/remove d... | /content/code_sandbox/doc/hardware/peripherals/coredump.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 174 |
```restructuredtext
.. _bbram_api:
Battery Backed RAM (BBRAM)
##########################
The BBRAM APIs allow interfacing with the unique properties of this memory region. The following
common types of BBRAM properties are easily accessed via this API:
- IBBR (invalid) state - check that the BBRAM is not corrupt.
- ... | /content/code_sandbox/doc/hardware/peripherals/bbram.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 217 |
```restructuredtext
.. _mdio_api:
Management Data Input/Output (MDIO)
###################################
Overview
********
MDIO is a bus that is commonly used to communicate with ethernet PHY devices.
Many ethernet MAC controllers also provide hardware to communicate over MDIO
bus with a peripheral device.
This AP... | /content/code_sandbox/doc/hardware/peripherals/mdio.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 94 |
```restructuredtext
.. _sdhc_api:
Secure Digital High Capacity (SDHC)
###################################
The SDHC api offers a generic interface for interacting with an SD host
controller device. It is used by the SD subsystem, and is not intended to be
directly used by the application
Basic Operation
************... | /content/code_sandbox/doc/hardware/peripherals/sdhc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 376 |
```restructuredtext
.. _i2c_eeprom_target_api:
I2C EEPROM Target
#################
Overview
********
API Reference
**************
.. doxygengroup:: i2c_eeprom_target_api
``` | /content/code_sandbox/doc/hardware/peripherals/i2c_eeprom_target.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 43 |
```restructuredtext
.. _dma_api:
Direct Memory Access (DMA)
##########################
Overview
********
Direct Memory Access (Controller) is a commonly provided type of co-processor that can typically
offload transferring data to and from peripherals and memory.
The DMA API is not a portable API and really cannot ... | /content/code_sandbox/doc/hardware/peripherals/dma.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 625 |
```restructuredtext
.. _can_transceiver_api:
CAN Transceiver
###############
.. contents::
:local:
:depth: 2
Overview
********
A CAN transceiver is an external device that converts the logic level signals
from the CAN controller to the bus-levels. The bus lines are called
CAN High (CAN H) and CAN Low (CAN L... | /content/code_sandbox/doc/hardware/peripherals/can/transceiver.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 295 |
```restructuredtext
.. _can:
Controller Area Network (CAN)
#############################
.. toctree::
:maxdepth: 2
controller.rst
transceiver.rst
shell.rst
``` | /content/code_sandbox/doc/hardware/peripherals/can/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 42 |
```restructuredtext
.. _can_shell:
CAN Shell
#########
.. contents::
:local:
:depth: 1
Overview
********
The CAN shell provides a ``can`` command with a set of subcommands for the :ref:`shell <shell_api>`
module. It allows for testing and exploring the :ref:`can_api` driver API through an interactive
interf... | /content/code_sandbox/doc/hardware/peripherals/can/shell.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,597 |
```c
/*
*
*/
#include <zephyr/drivers/sensor.h>
#define TEMP_CHANNEL {SENSOR_CHAN_AMBIENT_TEMP, 0}
const struct device *const temp0 = DEVICE_DT_GET(DT_ALIAS(temp0));
SENSOR_DT_READ_IODEV(temp_iodev, DT_ALIAS(temp0), {TEMP_CHANNEL});
RTIO_DEFINE(temp_ctx, 1, 1);
int main(void)
{
int rc;
uint8_t buf[8];
uint32_... | /content/code_sandbox/doc/hardware/peripherals/sensor/temp_polling.c | c | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 271 |
```restructuredtext
Power Management
================
Power management of sensors is often a non-trivial task as sensors may have multiple power states
for various channels. Some sensors may allow for low noise, low power, or suspending channels
potentially saving quite a bit of power at the cost of noise or sampling ... | /content/code_sandbox/doc/hardware/peripherals/sensor/power_management.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 248 |
```restructuredtext
.. _can_api:
CAN Controller
##############
.. contents::
:local:
:depth: 2
Overview
********
Controller Area Network is a two-wire serial bus specified by the
Bosch CAN Specification, Bosch CAN with Flexible Data-Rate specification and the
ISO 11898-1:2003 standard.
CAN is mostly known f... | /content/code_sandbox/doc/hardware/peripherals/can/controller.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,639 |
```c
/*
*
*/
#include <zephyr/drivers/sensor.h>
const struct device *const accel0 = DEVICE_DT_GET(DT_ALIAS(accel0));
static struct tap_count_state {
struct sensor_trigger trig;
uint32_t count;
} tap_count_state = {
.trig = {
.chan = SENSOR_CHAN_ACCEL_XYZ,
.type = SENSOR_TRIG_TAP,
},
.count = 0,
};
void ... | /content/code_sandbox/doc/hardware/peripherals/sensor/tap_count.c | c | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 225 |
```restructuredtext
Device Tree
###########
In the context of sensors device tree provides the initial hardware configuration
for sensors on a per device level. Each device must specify a device tree binding
in Zephyr, and ideally, a set of hardware configuration options for things such
as channel power modes, data ra... | /content/code_sandbox/doc/hardware/peripherals/sensor/device_tree.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 351 |
```restructuredtext
.. _sensor-attribute:
Sensor Attributes
#################
:dfn:`Attributes`, enumerated in :c:enum:`sensor_attribute`, are immutable and
mutable properties of a sensor and its channels.
Attributes allow for obtaining metadata and changing configuration of a sensor.
Common configuration parameters... | /content/code_sandbox/doc/hardware/peripherals/sensor/attributes.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 331 |
```restructuredtext
.. _sensor:
Sensors
#######
The sensor driver API provides functionality to uniformly read, configure,
and setup event handling for devices that take real world measurements in
meaningful units.
Sensors range from very simple temperature-reading devices that must be polled
with a fixed scale to c... | /content/code_sandbox/doc/hardware/peripherals/sensor/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 917 |
```restructuredtext
.. _sensor-fetch-and-get:
Fetch and Get
#############
The stable and long existing APIs for reading sensor data and handling triggers
are:
* :c:func:`sensor_sample_fetch`
* :c:func:`sensor_sample_fetch_chan`
* :c:func:`sensor_channel_get`
* :c:func:`sensor_trigger_set`
These functions work toget... | /content/code_sandbox/doc/hardware/peripherals/sensor/fetch_and_get.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 627 |
```c
/*
*
*/
#include <zephyr/drivers/sensor.h>
#define ACCEL_TRIGGERS \
{ SENSOR_TRIG_DRDY, SENSOR_STREAM_DATA_INCLUDE }, \
{ SENSOR_TRIG_TAP, SENSOR_STREAM_DATA_NOP }
#define ACCEL_ALIAS(id) DT_ALIAS(CONCAT(accel, id))
#define ACCEL_IODEV_SYM(id) CONCAT(accel_iodev, id)
#define ACCEL_IODEV_PTR(id) &ACCEL_I... | /content/code_sandbox/doc/hardware/peripherals/sensor/accel_stream.c | c | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 796 |
```c
/*
*
*/
#include <zephyr/drivers/sensor.h>
#define TEMP_CHANNELS \
{ SENSOR_CHAN_AMBIENT_TEMP, 0 }, \
{ SENSOR_CHAN_AMBIENT_TEMP, 1 }
#define TEMP_ALIAS(id) DT_ALIAS(CONCAT(temp, id))
#define TEMP_IODEV_SYM(id) CONCAT(temp_iodev, id)
#define TEMP_IODEV_PTR(id) &TEMP_IODEV_SYM(id)
#define TEMP_DEFINE_IODEV... | /content/code_sandbox/doc/hardware/peripherals/sensor/multiple_temp_polling.c | c | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 810 |
```restructuredtext
.. _sensor-trigger:
Sensor Triggers
###############
:dfn:`Triggers`, enumerated in :c:enum:`sensor_trigger_type`, are sensor
generated events. Typically sensors allow setting up these events to cause
digital line signaling for easy capture by a micro controller. The events can
then commonly be ins... | /content/code_sandbox/doc/hardware/peripherals/sensor/triggers.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 107 |
```restructuredtext
.. _sensor-channel:
Sensor Channels
###############
:dfn:`Channels`, enumerated in :c:enum:`sensor_channel`, are quantities that
a sensor device can measure.
Sensors may have multiple channels, either to represent different axes of
the same physical property (e.g. acceleration); or because they c... | /content/code_sandbox/doc/hardware/peripherals/sensor/channels.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 199 |
```restructuredtext
.. _sensor-read-and-decode:
Read and Decode
###############
The quickly stabilizing experimental APIs for reading sensor data are:
* :c:func:`sensor_read`
* :c:func:`sensor_read_async_mempool`
* :c:func:`sensor_get_decoder`
* :c:func:`sensor_decode`
Benefits over :ref:`sensor-fetch-and-get`
***... | /content/code_sandbox/doc/hardware/peripherals/sensor/read_and_decode.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 893 |
```restructuredtext
.. _eeprom:
Electrically Erasable Programmable Read-Only Memory (EEPROM)
############################################################
Overview
********
EEPROMs have an erase block size of 1 byte, a long lifetime, and allow
overwriting data on byte-by-byte access.
.. toctree::
:maxdepth: 2
... | /content/code_sandbox/doc/hardware/peripherals/eeprom/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 79 |
```restructuredtext
.. _eeprom_api:
EEPROM API
##########
Overview
********
The EEPROM API provides read and write access to Electrically Erasable
Programmable Read-Only Memory (EEPROM) devices.
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_EEPROM`
API Refer... | /content/code_sandbox/doc/hardware/peripherals/eeprom/api.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 81 |
```restructuredtext
.. _dai_api:
Digital Audio Interface (DAI)
#############################
Overview
********
The DAI (Digital Audio Interface) is a generic high level API for audio drivers.
It can be configured with bespoke data for vendor specific configuration.
Configuration Options
*********************
Relat... | /content/code_sandbox/doc/hardware/peripherals/audio/dai.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 85 |
```restructuredtext
.. _audio_codec_api:
Audio Codec
###########
Overview
********
The Audio Codec API provides access to digital audio codecs.
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_AUDIO_CODEC`
API Reference
*************
.. doxygengroup:: audio_co... | /content/code_sandbox/doc/hardware/peripherals/audio/codec.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 63 |
```restructuredtext
.. _audio_reference:
Audio
#####
.. toctree::
:maxdepth: 1
codec.rst
dmic.rst
i2s.rst
dai.rst
``` | /content/code_sandbox/doc/hardware/peripherals/audio/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 46 |
```restructuredtext
.. _eeprom_shell:
EEPROM Shell
############
.. contents::
:local:
:depth: 1
Overview
********
The EEPROM shell provides an ``eeprom`` command with a set of subcommands for the :ref:`shell
<shell_api>` module. It allows testing and exploring the :ref:`EEPROM <eeprom_api>` driver API
throu... | /content/code_sandbox/doc/hardware/peripherals/eeprom/shell.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 905 |
```restructuredtext
.. _audio_dmic_api:
Digital Microphone (DMIC)
#########################
Overview
********
The audio DMIC interface provides access to digital microphones.
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_AUDIO_DMIC`
API Reference
***********... | /content/code_sandbox/doc/hardware/peripherals/audio/dmic.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 71 |
```restructuredtext
.. _i2s_api:
Inter-IC Sound (I2S) Bus
########################
Overview
********
The I2S (Inter-IC Sound) API provides support for the standard I2S interface
as well as common non-standard extensions such as PCM Short/Long Frame Sync
and Left/Right Justified Data Formats.
Configuration Options
*... | /content/code_sandbox/doc/hardware/peripherals/audio/i2s.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 109 |
```restructuredtext
.. comment
not documenting
.. doxygengroup:: display_interfaces
.. _display_api:
Display Interface
#################
API Reference
*************
Generic Display Interface
=========================
.. doxygengroup:: display_interface
Grove LCD Display
=================
.. doxygengroup:: ... | /content/code_sandbox/doc/hardware/peripherals/display/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 109 |
```restructuredtext
.. _edac_api:
Error Detection And Correction (EDAC)
#####################################
Error Detection And Correction is a mechanism used to detect and correct errors
while storing or reading data.
.. toctree::
:maxdepth: 1
ibecc.rst
Configuration option
********************
Related c... | /content/code_sandbox/doc/hardware/peripherals/edac/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 92 |
```restructuredtext
.. _edac_ibecc:
In Band Error Correction Code (IBECC)
#####################################
Overview
********
The mechanism initially found in Intel Elkhart Lake SOCs and later boards is
an integrated memory controller with IBECC.
The In-Band Error Correction Code (IBECC) improves reliability by... | /content/code_sandbox/doc/hardware/peripherals/edac/ibecc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 644 |
```restructuredtext
.. _cache-guide:
Cache Interface
###############
This is a high-level guide to cache interface and Kconfig options related to
cache controllers. See :ref:`cache_api` for API reference material.
Zephyr has different Kconfig options to control how the cache controller is
implemented and controlled.... | /content/code_sandbox/doc/hardware/cache/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 550 |
```restructuredtext
.. _porting:
Porting
#######
These pages document how to port Zephyr to new hardware.
.. toctree::
:maxdepth: 1
arch.rst
soc_porting.rst
board_porting.rst
shields.rst
``` | /content/code_sandbox/doc/hardware/porting/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 61 |
```restructuredtext
.. _architecture_porting_guide:
Architecture Porting Guide
##########################
An architecture port is needed to enable Zephyr to run on an :abbr:`ISA
(instruction set architecture)` or an :abbr:`ABI (Application Binary
Interface)` that is not currently supported.
The following are example... | /content/code_sandbox/doc/hardware/porting/arch.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 9,382 |
```restructuredtext
.. _board_porting_guide:
Board Porting Guide
###################
To add Zephyr support for a new :term:`board`, you at least need a *board
directory* with various files in it. Files in the board directory inherit
support for at least one SoC and all of its features. Therefore, Zephyr must
support ... | /content/code_sandbox/doc/hardware/porting/board_porting.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 9,208 |
```restructuredtext
.. _shields:
Shields
#######
Shields, also known as "add-on" or "daughter boards", attach to a board
to extend its features and services for easier and modularized prototyping.
In Zephyr, the shield feature provides Zephyr-formatted shield
descriptions for easier compatibility with applications.
... | /content/code_sandbox/doc/hardware/porting/shields.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,962 |
```restructuredtext
.. _barriers_api:
Barriers API
************
.. doxygengroup:: barrier_apis
``` | /content/code_sandbox/doc/hardware/barriers/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 24 |
```restructuredtext
.. _soc_porting_guide:
SoC Porting Guide
###################
This page describes how to add support for a new :term:`SoC` in Zephyr, be it in
the upstream Zephyr project or locally in your own repository.
SoC Definitions
***************
It is expected that you are familiar with the board concept... | /content/code_sandbox/doc/hardware/porting/soc_porting.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,444 |
```restructuredtext
.. _hardware_arch_arc_support_status:
Zephyr support status on ARC processors
#######################################
Overview
********
This page describes current state of Zephyr for ARC processors and some future
plans. Please note that
* plans are given without exact deadlines
* software fe... | /content/code_sandbox/doc/hardware/arch/arc-support-status.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,460 |
```restructuredtext
.. _arch:
Architecture-related Guides
###########################
.. toctree::
:maxdepth: 1
arc-support-status.rst
arm_cortex_m.rst
risc-v.rst
semihost.rst
x86.rst
xtensa.rst
arm-scmi.rst
``` | /content/code_sandbox/doc/hardware/arch/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 72 |
```restructuredtext
.. _x86_developer_guide:
x86 Developer Guide
###################
Overview
********
This page contains information on certain aspects when developing for
x86-based platforms.
Virtual Memory
**************
During very early boot, page tables are loaded so technically the kernel
is executing in vi... | /content/code_sandbox/doc/hardware/arch/x86.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,231 |
```restructuredtext
Zephyr support status on RISC-V processors
##########################################
Overview
********
This page describes current state of Zephyr for RISC-V processors.
Currently, there's support for some boards, as well as Qemu support
and support for some FPGA implementations such as neorv32 a... | /content/code_sandbox/doc/hardware/arch/risc-v.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 299 |
```restructuredtext
.. _semihost_guide:
Semihosting Guide
#################
Overview
********
Semihosting is a mechanism that enables code running on ARM and RISC-V targets
to communicate and use the Input/Output facilities on a host computer that is
running a debugger or emulator.
More complete documentation on th... | /content/code_sandbox/doc/hardware/arch/semihost.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 463 |
```restructuredtext
.. _xtensa_developer_guide:
Xtensa Developer Guide
######################
Overview
********
This page contains information on certain aspects when developing for
Xtensa-based platforms.
HiFi Audio Engine DSP
*********************
The kernel allows threads to use the HiFi Audio Engine DSP regist... | /content/code_sandbox/doc/hardware/arch/xtensa.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 548 |
```restructuredtext
.. _arm_scmi:
ARM System Control and Management Interface
###########################################
Overview
********
What is SCMI?
*************
System Control and Management Interface (SCMI) is a specification developed by
ARM, which describes a set of OS-agnostic software interfaces used to... | /content/code_sandbox/doc/hardware/arch/arm-scmi.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,891 |
```restructuredtext
.. _emulators:
Zephyr's device emulators/simulators
####################################
Overview
========
Zephyr includes in its codebase a set of device emulators/simulators.
With this we refer to SW components which are built together with the embedded SW
and present themselves as devices of a... | /content/code_sandbox/doc/hardware/emulator/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,014 |
```restructuredtext
.. _bus_emul:
External Bus and Bus Connected Peripherals Emulators
####################################################
Overview
========
Zephyr supports a simple emulator framework to support testing of external peripheral drivers
without requiring real hardware.
Emulators are used to emulate e... | /content/code_sandbox/doc/hardware/emulator/bus_emulators.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,843 |
```restructuredtext
.. _connectivity:
Connectivity
############
.. toctree::
:maxdepth: 1
bluetooth/index.rst
canbus/index.rst
networking/index.rst
lora_lorawan/index.rst
usb/index.rst
``` | /content/code_sandbox/doc/connectivity/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 59 |
```restructuredtext
.. _lora_api:
.. _lorawan_api:
LoRa and LoRaWAN
################
Overview
********
LoRa (abbrev. for Long Range) is a proprietary low-power wireless
communication protocol developed by the `Semtech Corporation`_.
LoRa acts as the physical layer (PHY) based on the chirp spread spectrum
(CSS) modu... | /content/code_sandbox/doc/connectivity/lora_lorawan/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 560 |
```restructuredtext
.. _networking_with_user_qemu:
Networking with QEMU User
#############################
.. contents::
:local:
:depth: 2
This page is intended to serve as a starting point for anyone interested in
using QEMU SLIRP with Zephyr.
Introduction
*************
SLIRP is a network backend which pr... | /content/code_sandbox/doc/connectivity/networking/qemu_user_setup.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 826 |
```restructuredtext
.. _networking_with_eth_qemu:
Networking with QEMU Ethernet
#############################
.. contents::
:local:
:depth: 2
This page describes how to set up a virtual network between a (Linux) host
and a Zephyr application running in QEMU.
In this example, the :zephyr:code-sample:`sockets... | /content/code_sandbox/doc/connectivity/networking/qemu_eth_setup.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 627 |
```restructuredtext
.. _networking_with_armfvp:
Networking with Arm FVP User Mode
#################################
.. contents::
:local:
:depth: 2
This page is intended to serve as a starting point for anyone interested in
using Arm FVP user mode networking with Zephyr.
Introduction
*************
User mod... | /content/code_sandbox/doc/connectivity/networking/armfvp_user_networking_setup.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 435 |
```restructuredtext
.. _arm_cortex_m_developer_guide:
Arm Cortex-M Developer Guide
############################
Overview
********
This page contains detailed information about the status of the Arm Cortex-M
architecture porting in the Zephyr RTOS and describes key aspects when
developing Zephyr applications for Arm ... | /content/code_sandbox/doc/hardware/arch/arm_cortex_m.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 8,308 |
```restructuredtext
.. _ip_stack_overview:
Overview
########
.. contents::
:local:
:depth: 2
Supported Features
******************
The networking IP stack is modular and highly configurable via build-time
configuration options. You can minimize system memory consumption by enabling
only those network featur... | /content/code_sandbox/doc/connectivity/networking/overview.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,932 |
```restructuredtext
.. _networking:
Networking
##########
The networking section contains information regarding the network stack of the
Zephyr kernel. Use the information to understand the principles behind the
operation of the stacks and how they were implemented.
.. toctree::
:maxdepth: 1
overview.rst
n... | /content/code_sandbox/doc/connectivity/networking/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 114 |
```restructuredtext
.. _networking_with_native_sim:
Networking with native_sim board
################################
.. contents::
:local:
:depth: 2
Using virtual/TAP Ethernet driver
*********************************
This paragraph describes how to set up a virtual network between a (Linux) host
and a Zeph... | /content/code_sandbox/doc/connectivity/networking/native_sim_setup.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 975 |
```restructuredtext
.. _networking_with_ieee802154_qemu:
Networking with QEMU and IEEE 802.15.4
######################################
.. contents::
:local:
:depth: 2
This page describes how to set up a virtual network between two QEMUs that
are connected together via UART and are running IEEE 802.15.4 link ... | /content/code_sandbox/doc/connectivity/networking/qemu_802154_setup.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 574 |
```restructuredtext
.. _network_monitoring:
Monitor Network Traffic
#######################
.. contents::
:local:
:depth: 2
It is useful to be able to monitor the network traffic especially when
debugging a connectivity issues or when developing new protocol support in
Zephyr. This page describes how to set ... | /content/code_sandbox/doc/connectivity/networking/network_monitoring.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,419 |
```restructuredtext
.. _network_tracing:
Network Tracing
###############
.. contents::
:local:
:depth: 2
User can enable network core stack and socket API calls tracing.
The :kconfig:option:`CONFIG_TRACING_NET_CORE` option contols the core network
stack tracing. This option is enabled by default if tracing ... | /content/code_sandbox/doc/connectivity/networking/network_tracing.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 228 |
```restructuredtext
.. _network_configuration_guide:
Network Configuration Guide
###########################
.. contents::
:local:
:depth: 2
This document describes how various network configuration options can be
set according to available resources in the system.
Network Buffer Configuration Options
*****... | /content/code_sandbox/doc/connectivity/networking/net_config_guide.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,916 |
```restructuredtext
.. _networking_with_multiple_instances:
Networking with multiple Zephyr instances
#########################################
.. contents::
:local:
:depth: 2
This page describes how to set up a virtual network between multiple
Zephyr instances. The Zephyr instances could be running inside Q... | /content/code_sandbox/doc/connectivity/networking/networking_with_multiple_instances.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,957 |
```restructuredtext
.. _networking_with_host:
Networking with the host system
###############################
.. toctree::
:maxdepth: 1
:hidden:
native_sim_setup.rst
qemu_eth_setup.rst
qemu_setup.rst
usbnet_setup.rst
qemu_user_setup.rst
networking_with_multiple_instances.rst
qemu_802154_se... | /content/code_sandbox/doc/connectivity/networking/networking_with_host.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 805 |
```restructuredtext
.. _networking_with_qemu:
Networking with QEMU
####################
.. contents::
:local:
:depth: 2
This page describes how to set up a virtual network between a (Linux) host
and a Zephyr application running in a QEMU virtual machine (built for Zephyr
targets such as qemu_x86 and qemu_cor... | /content/code_sandbox/doc/connectivity/networking/qemu_setup.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,084 |
```restructuredtext
.. _network_stack_architecture:
Network Stack Architecture
##########################
.. toctree::
:maxdepth: 1
:hidden:
net_pkt_processing_stats.rst
The Zephyr network stack is a native network stack specifically designed
for Zephyr OS. It consists of layers, each meant to provide cert... | /content/code_sandbox/doc/connectivity/networking/net-stack-architecture.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,640 |
```restructuredtext
.. _net_pkt_processing_stats:
Network Packet Processing Statistics
####################################
.. contents::
:local:
:depth: 2
This page describes how to get information about network packet processing
statistics inside network stack.
Network stack contains infrastructure to fig... | /content/code_sandbox/doc/connectivity/networking/net_pkt_processing_stats.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 889 |
```restructuredtext
.. _usb_device_networking_setup:
USB Device Networking
#####################
.. contents::
:local:
:depth: 2
This page describes how to set up networking between a Linux host
and a Zephyr application running on USB supported devices.
The board is connected to Linux host using USB cable
a... | /content/code_sandbox/doc/connectivity/networking/usbnet_setup.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 915 |
```restructuredtext
.. _net_shell:
Network Shell
#############
Network shell provides helpers for figuring out network status,
enabling/disabling features, and issuing commands like ping or DNS resolving.
Note that ``net-shell`` should probably not be used in production code
as it will require extra memory. See also ... | /content/code_sandbox/doc/connectivity/networking/api/net_shell.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 596 |
```restructuredtext
.. _sntp_interface:
Simple Network Time Protocol Library
####################################
.. contents::
:local:
:depth: 2
Overview
********
The SNTP library implements
`IETF RFC4330 (Simple Network Time Protocol v4) <path_to_url`_.
SNTP provides a way to synchronize clocks in comput... | /content/code_sandbox/doc/connectivity/networking/api/sntp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 88 |
```restructuredtext
.. _net_pkt_filter_interface:
Network Packet Filtering
########################
.. contents::
:local:
:depth: 2
Overview
********
The Network Packet Filtering facility provides the infrastructure to
construct custom rules for accepting and/or denying packet transmission
and reception. Th... | /content/code_sandbox/doc/connectivity/networking/api/net_pkt_filter.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 794 |
```restructuredtext
.. _ethernet_mgmt_interface:
Ethernet Management
###################
.. contents::
:local:
:depth: 2
Overview
********
Ethernet management API provides functions to manage the Ethernet
network interface low level status. The caller of these functions can:
* raise ``carrier ON`` or ``car... | /content/code_sandbox/doc/connectivity/networking/api/ethernet_mgmt.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 194 |
```restructuredtext
.. _net_config_interface:
Network Configuration Library
#############################
.. contents::
:local:
:depth: 2
Overview
********
The network configuration library sets up networking devices in a
semi-automatic way during the system boot, based on user-supplied
Kconfig options.
Th... | /content/code_sandbox/doc/connectivity/networking/api/net_config.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 920 |
```restructuredtext
.. _tls_credentials_shell:
TLS Credentials Shell
#####################
The TLS Credentials shell provides a command-line interface for managing installed TLS credentials.
Commands
********
.. _tls_credentials_shell_buf_cred:
Buffer Credential (``buf``)
===========================
Buffer data i... | /content/code_sandbox/doc/connectivity/networking/api/tls_credentials_shell.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,233 |
```restructuredtext
.. _net_capture_interface:
Network Packet Capture
######################
.. contents::
:local:
:depth: 2
Overview
********
The ``net_capture`` API allows user to monitor the network
traffic in one of the Zephyr network interfaces and send that traffic to
external system for analysis. The... | /content/code_sandbox/doc/connectivity/networking/api/capture.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,040 |
```restructuredtext
.. _dhcpv6_interface:
DHCPv6
######
.. contents::
:local:
:depth: 2
Overview
********
The Dynamic Host Configuration Protocol (DHCP) for IPv6 is a network management protocol
used on IPv6 based networks. A DHCPv6 server dynamically assigns an IPv6 address
and other network configuration ... | /content/code_sandbox/doc/connectivity/networking/api/dhcpv6.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 147 |
```restructuredtext
.. _coap_client_interface:
CoAP client
###########
.. contents::
:local:
:depth: 2
Overview
********
The CoAP client library allows application to send CoAP requests and parse CoAP responses.
The library can be enabled with :kconfig:option:`CONFIG_COAP_CLIENT` Kconfig option.
The applica... | /content/code_sandbox/doc/connectivity/networking/api/coap_client.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 907 |
```restructuredtext
.. _net_stats_interface:
Network Statistics
##################
.. contents::
:local:
:depth: 2
Overview
********
Network statistics are collected if :kconfig:option:`CONFIG_NET_STATISTICS` is set.
Individual component statistics for IPv4 or IPv6 can be turned off
if those statistics are ... | /content/code_sandbox/doc/connectivity/networking/api/net_stats.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 296 |
```restructuredtext
.. _tftp_interface:
TFTP
####
Zephyr provides a simple TFTP client library that can enabled with
:kconfig:option:`CONFIG_MQTT_SN_LIB` Kconfig option.
See :zephyr:code-sample:`TFTP client sample application <tftp-client>` for
more information about the library usage.
API Reference
*************
... | /content/code_sandbox/doc/connectivity/networking/api/tftp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 87 |
```restructuredtext
.. _websocket_interface:
Websocket Client API
####################
.. contents::
:local:
:depth: 2
Overview
********
The Websocket client library allows Zephyr to connect to a Websocket server.
The Websocket client API can be used directly by application to establish
a Websocket connecti... | /content/code_sandbox/doc/connectivity/networking/api/websocket.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 526 |
```restructuredtext
.. _lldp_interface:
Link Layer Discovery Protocol
#############################
.. contents::
:local:
:depth: 2
Overview
********
The Link Layer Discovery Protocol (LLDP) is a vendor-neutral link layer
protocol used by network devices for advertising their identity, capabilities,
and nei... | /content/code_sandbox/doc/connectivity/networking/api/lldp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 103 |
```restructuredtext
.. _lwm2m_interface:
Lightweight M2M (LWM2M)
#######################
.. contents::
:local:
:depth: 2
Overview
********
Lightweight Machine to Machine (LwM2M) is an application layer protocol
designed with device management, data reporting and device actuation in mind.
Based on CoAP/UDP, ... | /content/code_sandbox/doc/connectivity/networking/api/lwm2m.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,993 |
```restructuredtext
.. _coap_server_interface:
CoAP server
###########
.. contents::
:local:
:depth: 2
Overview
********
Zephyr comes with a batteries-included CoAP server, which uses services to listen for CoAP
requests. The CoAP services handle communication over sockets and pass requests to registered
Co... | /content/code_sandbox/doc/connectivity/networking/api/coap_server.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,166 |
```restructuredtext
.. _socks5_interface:
SOCKS5 Proxy Support
####################
.. contents::
:local:
:depth: 2
Overview
********
The SOCKS library implements SOCKS5 support, which allows Zephyr to connect
to peer devices via a network proxy.
See this
`SOCKS5 Wikipedia article <path_to_url#SOCKS5>`_
fo... | /content/code_sandbox/doc/connectivity/networking/api/socks5.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 327 |
```restructuredtext
.. _net_core_interface:
Network Core Helpers
####################
.. contents::
:local:
:depth: 2
Overview
********
The network subsystem contains two functions for sending and receiving
data from the network. The ``net_recv_data()`` is typically used by network
device driver when the re... | /content/code_sandbox/doc/connectivity/networking/api/net_core.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 160 |
```restructuredtext
.. _dhcpv4_interface:
DHCPv4
######
.. contents::
:local:
:depth: 2
Overview
********
The Dynamic Host Configuration Protocol (DHCP) is a network management protocol
used on IPv4 networks. A DHCPv4 server dynamically assigns an IPv4 address
and other network configuration parameters to e... | /content/code_sandbox/doc/connectivity/networking/api/dhcpv4.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 165 |
```restructuredtext
.. _ip_4_6_interface:
IPv4/IPv6 Primitives and Helpers
################################
.. contents::
:local:
:depth: 2
Overview
********
Miscellaneous defines and helper functions for IP addresses and IP protocols.
API Reference
*************
.. doxygengroup:: ip_4_6
``` | /content/code_sandbox/doc/connectivity/networking/api/ip_4_6.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 71 |
```restructuredtext
.. _traffic-class-support:
Traffic Classification
#######################
Overview
********
`Traffic classification <path_to_url`_
is an automated process that categorizes computer network traffic according to
various parameters. For Zephyr, the VLAN priority code point (PCP) is used
to classify ... | /content/code_sandbox/doc/connectivity/networking/api/traffic-class.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 308 |
```restructuredtext
.. _ieee802154_interface:
IEEE 802.15.4
#############
.. contents::
:local:
:depth: 2
Introduction
************
IEEE 802.15.4 is a technical standard which defines the operation of low-rate
wireless personal area networks (LR-WPANs). For a more detailed overview of this
standard, see the... | /content/code_sandbox/doc/connectivity/networking/api/ieee802154.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 822 |
```restructuredtext
.. _net_time_interface:
Network time representation in the network stack
################################################
API Reference
*************
.. doxygengroup:: net_time
``` | /content/code_sandbox/doc/connectivity/networking/api/net_time.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 32 |
```restructuredtext
.. _coap_sock_interface:
CoAP
#####
.. contents::
:local:
:depth: 2
Overview
********
The Constrained Application Protocol (CoAP) is a specialized web transfer
protocol for use with constrained nodes and constrained (e.g., low-power,
lossy) networks. It provides a convenient API for REST... | /content/code_sandbox/doc/connectivity/networking/api/coap.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,713 |
```restructuredtext
.. _net_protocols:
Protocols
##########
.. toctree::
:maxdepth: 1
coap
coap_client
coap_server
http_client
http_server
lwm2m
mqtt
mqtt_sn
ptp
tftp
``` | /content/code_sandbox/doc/connectivity/networking/api/protocols.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 69 |
```restructuredtext
.. _http_server_interface:
HTTP Server
###########
.. contents::
:local:
:depth: 2
Overview
********
Zephyr provides an HTTP server library, which allows to register HTTP services
and HTTP resources associated with those services. The server creates a listening
socket for every registere... | /content/code_sandbox/doc/connectivity/networking/api/http_server.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,692 |
```restructuredtext
.. _thread_protocol_interface:
Thread protocol
###############
.. contents::
:local:
:depth: 2
Overview
********
Thread is a low-power mesh networking technology, designed specifically for home
automation applications. It is an IPv6-based standard, which uses 6LoWPAN
technology over IEEE ... | /content/code_sandbox/doc/connectivity/networking/api/thread.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 491 |
```restructuredtext
.. _ptp_interface:
Precision Time Protocol (PTP)
#############################
.. contents::
:local:
:depth: 2
Overview
********
PTP is a network protocol implemented in the application layer, used to synchronize
clocks in a computer network. It's accurate up to less than a microsecond.
... | /content/code_sandbox/doc/connectivity/networking/api/ptp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,319 |
```restructuredtext
.. _networking_api:
Networking APIs
###############
Zephyr provides support for the standard BSD socket APIs (defined in
:zephyr_file:`include/zephyr/net/socket.h`) for the applications to
use. See :ref:`BSD socket API <bsd_sockets_interface>` for more details.
Apart of the standard API, Zephyr p... | /content/code_sandbox/doc/connectivity/networking/api/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 183 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.