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
.. _trickle_interface:
Trickle Timer Library
#####################
.. contents::
:local:
:depth: 2
Overview
********
The Trickle timer library implements
`IETF RFC6206 (Trickle Algorithm) <path_to_url`_.
The Trickle algorithm allows nodes in a lossy shared medium (e.g.,
low-power and lo... | /content/code_sandbox/doc/connectivity/networking/api/trickle.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 114 |
```restructuredtext
.. _net_l2_interface:
L2 Layer Management
###################
.. contents::
:local:
:depth: 2
Overview
********
The L2 stack is designed to hide the whole networking link-layer part
and the related device drivers from the upper network stack. This is made
through a :c:struct:`net_if` dec... | /content/code_sandbox/doc/connectivity/networking/api/net_l2.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,233 |
```restructuredtext
.. _net_buf_interface:
Network Buffer
##############
.. contents::
:local:
:depth: 2
Overview
********
Network buffers are a core concept of how the networking stack
(as well as the Bluetooth stack) pass data around. The API for them is
defined in :zephyr_file:`include/zephyr/net/buf.h`... | /content/code_sandbox/doc/connectivity/networking/api/net_buf.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,116 |
```restructuredtext
.. _net_mgmt_interface:
Network Management
##################
.. contents::
:local:
:depth: 2
Overview
********
The Network Management APIs allow applications, as well as network
layer code itself, to call defined network routines at any level in
the IP stack, or receive notifications on... | /content/code_sandbox/doc/connectivity/networking/api/net_mgmt.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,763 |
```restructuredtext
.. _net_tech:
Networking Technologies
#######################
.. toctree::
:maxdepth: 1
ethernet.rst
ieee802154.rst
thread.rst
ppp.rst
wifi.rst
``` | /content/code_sandbox/doc/connectivity/networking/api/net_tech.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 54 |
```restructuredtext
.. _net_if_interface:
Network Interface
#################
.. contents::
:local:
:depth: 2
Overview
********
The network interface is a nexus that ties the network device drivers
and the upper part of the network stack together. All the sent and received
data is transferred via a network ... | /content/code_sandbox/doc/connectivity/networking/api/net_if.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,265 |
```restructuredtext
.. _net_system_mgmt:
Network System Management
#########################
.. toctree::
:maxdepth: 1
net_config.rst
dhcpv4.rst
dhcpv6.rst
net_hostname.rst
net_core.rst
net_if.rst
net_l2.rst
net_offload.rst
net_linkaddr.rst
ethernet_mgmt.rst
traffic-class.rst
n... | /content/code_sandbox/doc/connectivity/networking/api/system_mgmt.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 117 |
```restructuredtext
.. _net_buf_mgmt:
Network Buffer Management
#########################
.. toctree::
:maxdepth: 1
net_buf.rst
net_pkt.rst
``` | /content/code_sandbox/doc/connectivity/networking/api/buf_mgmt.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 38 |
```restructuredtext
.. _ptp_time_interface:
Precision Time Protocol (PTP) time format
#########################################
.. contents::
:local:
:depth: 2
Overview
********
The PTP time struct can store time information in high precision
format (nanoseconds). The extended timestamp format can store th... | /content/code_sandbox/doc/connectivity/networking/api/ptp_time.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 106 |
```restructuredtext
.. _ppp:
Point-to-Point Protocol (PPP) Support
#####################################
.. contents::
:local:
:depth: 2
Overview
********
`Point-to-Point Protocol
<path_to_url`_ (PPP) is a data link
layer (layer 2) communications protocol used to establish a direct connection
between two no... | /content/code_sandbox/doc/connectivity/networking/api/ppp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 324 |
```restructuredtext
.. _net_context_interface:
Networking Context
##################
The net_context API is not meant for application use. Application should use
:ref:`bsd_sockets_interface` API instead.
``` | /content/code_sandbox/doc/connectivity/networking/api/net_context.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 38 |
```restructuredtext
.. _net_apis:
Network APIs
############
.. toctree::
:maxdepth: 1
sockets.rst
ip_4_6.rst
dns_resolve.rst
net_mgmt.rst
net_stats.rst
net_timeout.rst
net_context.rst
promiscuous.rst
sntp.rst
socks5.rst
trickle.rst
websocket.rst
capture.rst
``` | /content/code_sandbox/doc/connectivity/networking/api/apis.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 103 |
```restructuredtext
.. _dns_resolve_interface:
DNS Resolve
###########
.. contents::
:local:
:depth: 2
Overview
********
The DNS resolver implements a basic DNS resolver according
to `IETF RFC1035 on Domain Implementation and Specification <path_to_url`_.
Supported DNS answers are IPv4/IPv6 addresses and CN... | /content/code_sandbox/doc/connectivity/networking/api/dns_resolve.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 322 |
```restructuredtext
.. _net_timeout_interface:
Network Timeout
###############
.. contents::
:local:
:depth: 2
Overview
********
Zephyr's network infrastructure mostly uses the millisecond-resolution uptime
clock to track timeouts, with both deadlines and durations measured with
32-bit unsigned values. The... | /content/code_sandbox/doc/connectivity/networking/api/net_timeout.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 546 |
```restructuredtext
.. _http_client_interface:
HTTP Client
###########
.. contents::
:local:
:depth: 2
Overview
********
The HTTP client library allows you to send HTTP requests and
parse HTTP responses. The library communicates over the sockets
API but it does not create sockets on its own.
It can be enabl... | /content/code_sandbox/doc/connectivity/networking/api/http_client.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 516 |
```restructuredtext
.. _ethernet_interface:
Ethernet
########
.. contents::
:local:
:depth: 2
.. toctree::
:maxdepth: 1
vlan.rst
lldp.rst
8021Qav.rst
Overview
********
Ethernet is a networking technology commonly used in local area networks (LAN).
For more information, see this
`Ethernet Wikip... | /content/code_sandbox/doc/connectivity/networking/api/ethernet.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 290 |
```restructuredtext
.. _net_linkaddr_interface:
Link Layer Address Handling
###########################
.. contents::
:local:
:depth: 2
Overview
********
The link layer addresses are set for network interfaces so that L2
connectivity works correctly in the network stack. Typically the link layer
addresses a... | /content/code_sandbox/doc/connectivity/networking/api/net_linkaddr.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 106 |
```restructuredtext
.. _net_hostname_interface:
Hostname Configuration
######################
.. contents::
:local:
:depth: 2
Overview
********
A networked device might need a hostname, for example, if the device
is configured to be a mDNS responder (see :ref:`dns_resolve_interface` for
details) and needs t... | /content/code_sandbox/doc/connectivity/networking/api/net_hostname.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 389 |
```restructuredtext
.. _net_tsn:
Time Sensitive Networking
#########################
.. toctree::
:maxdepth: 1
gptp.rst
net_time.rst
ptp_time.rst
ptp.rst
``` | /content/code_sandbox/doc/connectivity/networking/api/tsn.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 53 |
```restructuredtext
.. _net_pkt_interface:
Packet Management
#################
.. contents::
:local:
:depth: 2
Overview
********
Network packets are the main data the networking stack manipulates.
Such data is represented through the net_pkt structure which provides
a means to hold the packet, write and rea... | /content/code_sandbox/doc/connectivity/networking/api/net_pkt.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,858 |
```restructuredtext
.. _gptp_interface:
generic Precision Time Protocol (gPTP)
######################################
.. contents::
:local:
:depth: 2
Overview
********
This gPTP stack supports the protocol and procedures as defined in
the `IEEE 802.1AS-2011 standard`_ (Timing and Synchronization for
Time-Se... | /content/code_sandbox/doc/connectivity/networking/api/gptp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 545 |
```restructuredtext
.. _vlan_interface:
Virtual LAN (VLAN) Support
##########################
.. contents::
:local:
:depth: 2
Overview
********
`Virtual LAN <path_to_url`_ (VLAN) is a
partitioned and isolated computer network at the data link layer
(OSI layer 2). For ethernet network this refers to
`IEEE 80... | /content/code_sandbox/doc/connectivity/networking/api/vlan.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 528 |
```restructuredtext
.. _net_offload_interface:
Network Traffic Offloading
==========================
.. contents::
:local:
:depth: 2
Network Offloading
##################
Overview
********
The network offloading API provides hooks that a device vendor can use
to provide an alternate implementation for an I... | /content/code_sandbox/doc/connectivity/networking/api/net_offload.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 223 |
```restructuredtext
.. _mqtt_socket_interface:
MQTT
####
.. contents::
:local:
:depth: 2
Overview
********
MQTT (Message Queuing Telemetry Transport) is an application layer protocol
which works on top of the TCP/IP stack. It is a lightweight
publish/subscribe messaging transport for machine-to-machine comm... | /content/code_sandbox/doc/connectivity/networking/api/mqtt.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,372 |
```restructuredtext
.. _zperf:
zperf: Network Traffic Generator
################################
.. contents::
:local:
:depth: 2
Overview
********
zperf is a shell utility which allows to generate network traffic in Zephyr. The
tool may be used to evaluate network bandwidth.
zperf is compatible with iPerf_... | /content/code_sandbox/doc/connectivity/networking/api/zperf.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 628 |
```restructuredtext
.. _wifi_mgmt:
Wi-Fi Management
################
Overview
========
The Wi-Fi management API is used to manage Wi-Fi networks. It supports below modes:
* IEEE802.11 Station (STA)
* IEEE802.11 Access Point (AP)
Only personal mode security is supported with below types:
* Open
* WPA2-PSK
* WPA3-P... | /content/code_sandbox/doc/connectivity/networking/api/wifi.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 440 |
```restructuredtext
.. _promiscuous_interface:
Promiscuous Mode
################
.. contents::
:local:
:depth: 2
Overview
********
Promiscuous mode is a mode for a network interface controller that
causes it to pass all traffic it receives to the application rather than
passing only the frames that the cont... | /content/code_sandbox/doc/connectivity/networking/api/promiscuous.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 476 |
```restructuredtext
.. _bsd_sockets_interface:
BSD Sockets
###########
.. contents::
:local:
:depth: 2
Overview
********
Zephyr offers an implementation of a subset of the BSD Sockets API (a part
of the POSIX standard). This API allows to reuse existing programming experience
and port existing simple networ... | /content/code_sandbox/doc/connectivity/networking/api/sockets.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,633 |
```restructuredtext
.. _mqtt_sn_socket_interface:
MQTT-SN
#######
.. contents::
:local:
:depth: 2
Overview
********
MQTT-SN is a variant of the well-known MQTT protocol - see :ref:`mqtt_socket_interface`.
In contrast to MQTT, MQTT-SN does not require a TCP transport, but is designed to be used
over any mes... | /content/code_sandbox/doc/connectivity/networking/api/mqtt_sn.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,175 |
```restructuredtext
.. _8021Qav:
IEEE 802.1Qav
#############
Overview
********
Credit-based shaping is an alternative scheduling algorithm used in
network schedulers to achieve fairness when sharing a limited network
resource. Zephyr has support for configuring a credit-based shaper
described in the `IEEE 802.1Qav-... | /content/code_sandbox/doc/connectivity/networking/api/8021Qav.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 813 |
```restructuredtext
.. _conn_mgr_docs:
Connection Manager
##################
.. toctree::
:maxdepth: 1
main.rst
implementation.rst
``` | /content/code_sandbox/doc/connectivity/networking/conn_mgr/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 35 |
```restructuredtext
.. _conn_mgr_overview:
Overview
########
Connection Manager is a collection of optional Zephyr features that aim to allow applications to monitor and control connectivity (access to IP-capable networks) with minimal concern for the specifics of underlying network technologies.
Using Connection Ma... | /content/code_sandbox/doc/connectivity/networking/conn_mgr/main.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,010 |
```restructuredtext
.. _conn_mgr_impl:
Connectivity Implementations
############################
.. _conn_mgr_impl_overview:
Overview
========
Connectivity implementations are technology-specific modules that allow specific Zephyr ifaces to support :ref:`Connectivity Control <conn_mgr_control>`.
They are responsibl... | /content/code_sandbox/doc/connectivity/networking/conn_mgr/implementation.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,349 |
```unknown
<mxfile host="Electron" modified="2023-08-28T23:41:19.284Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.8 Chrome/114.0.5735.289 Electron/25.5.0 Safari/537.36" etag="LLGj6geb5OPwGWt5pcNY" version="21.6.8" type="device">
<diagram id="W1R5wPltpbE_ZV7s-k... | /content/code_sandbox/doc/connectivity/networking/conn_mgr/figures/integration_diagram_simplified.drawio | unknown | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,954 |
```restructuredtext
.. _can_isotp:
ISO-TP Transport Protocol
#########################
.. contents::
:local:
:depth: 2
Overview
********
ISO-TP is a transport protocol defined in the ISO-Standard ISO15765-2 Road
vehicles - Diagnostic communication over Controller Area Network (DoCAN).
Part2: Transport proto... | /content/code_sandbox/doc/connectivity/canbus/isotp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 407 |
```restructuredtext
.. _canbus:
Controller Area Network (CAN) Bus Protocols
###########################################
.. toctree::
:maxdepth: 2
isotp.rst
``` | /content/code_sandbox/doc/connectivity/canbus/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 37 |
```restructuredtext
.. _usb:
USB
###
**USB device support**
.. toctree::
:maxdepth: 1
device/usb_device.rst
device/api/index.rst
**New experimental USB support**
.. toctree::
:maxdepth: 1
device_next/usb_device.rst
device_next/api/index.rst
host/api/index.rst
**USB Power Delivery support**
... | /content/code_sandbox/doc/connectivity/usb/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 139 |
```unknown
<mxfile host="Electron" modified="2023-08-28T23:43:21.842Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.8 Chrome/114.0.5735.289 Electron/25.5.0 Safari/537.36" etag="tYLSXPfTSRMTc84KCMcT" version="21.6.8" type="device">
<diagram id="W1R5wPltpbE_ZV7s-k... | /content/code_sandbox/doc/connectivity/networking/conn_mgr/figures/integration_diagram_detailed.drawio | unknown | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 7,528 |
```restructuredtext
.. _usb_dc_api:
USB device controller driver API
################################
The USB device controller driver API is described in
:zephyr_file:`include/zephyr/drivers/usb/usb_dc.h` and sometimes referred to
as the ``usb_dc`` API.
This API has some limitations by design, it does not follow :r... | /content/code_sandbox/doc/connectivity/usb/device/api/usb_dc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 105 |
```restructuredtext
.. _usb_api:
USB device support APIs
#######################
.. toctree::
:maxdepth: 1
usb_dc.rst
usb_device.rst
usb_device_hid.rst
usb_device_bos.rst
``` | /content/code_sandbox/doc/connectivity/usb/device/api/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 54 |
```restructuredtext
.. _usb_bos_api:
Binary Device Object Store (BOS) support API
############################################
API reference
*************
.. doxygengroup:: usb_bos
``` | /content/code_sandbox/doc/connectivity/usb/device/api/usb_device_bos.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 38 |
```restructuredtext
.. _usb_device_stack_api:
USB device stack API
####################
API reference
*************
There are two ways to transmit data, using the 'low' level read/write API or
the 'high' level transfer API.
Low level API
To transmit data to the host, the class driver should call usb_write().
Up... | /content/code_sandbox/doc/connectivity/usb/device/api/usb_device.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 248 |
```restructuredtext
.. _usb_hid_device:
USB HID Class API
#################
USB device specific part for HID support defined in
:zephyr_file:`include/zephyr/usb/class/usb_hid.h`.
API Reference
*************
.. doxygengroup:: usb_hid_device_api
``` | /content/code_sandbox/doc/connectivity/usb/device/api/usb_device_hid.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 59 |
```restructuredtext
.. _usbc_api:
USB-C device stack
##################
The USB-C device stack is a hardware independent interface between a
Type-C Port Controller (TCPC) and customer applications. It is a port of
the Google ChromeOS Type-C Port Manager (TCPM) stack.
It provides the following functionalities:
* Uses... | /content/code_sandbox/doc/connectivity/usb/pd/ucds.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,738 |
```restructuredtext
.. _usb_device_stack:
USB device support
##################
.. contents::
:local:
:depth: 3
Overview
********
The USB device stack is a hardware independent interface between USB
device controller driver and USB device class drivers or customer applications.
It is a port of the LPCUSB de... | /content/code_sandbox/doc/connectivity/usb/device/usb_device.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 5,816 |
```restructuredtext
.. _usbd_msc_device:
USB Mass Storage Class device API
#################################
USB Mass Storage Class device API defined in
:zephyr_file:`include/zephyr/usb/class/usbd_msc.h`.
API Reference
*************
.. doxygengroup:: usbd_msc_device
``` | /content/code_sandbox/doc/connectivity/usb/device_next/api/usbd_msc_device.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 64 |
```restructuredtext
.. _usb_device_next_api:
New USB device support APIs
###########################
.. toctree::
:maxdepth: 1
udc.rst
usbd.rst
usbd_hid_device.rst
uac2_device.rst
usbd_msc_device.rst
``` | /content/code_sandbox/doc/connectivity/usb/device_next/api/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 66 |
```restructuredtext
.. _uac2_device:
Audio Class 2 device API
########################
USB Audio Class 2 device specific API defined in :zephyr_file:`include/zephyr/usb/class/usbd_uac2.h`.
API Reference
*************
.. doxygengroup:: uac2_device
``` | /content/code_sandbox/doc/connectivity/usb/device_next/api/uac2_device.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 64 |
```restructuredtext
.. _usbd_hid_device:
HID device API
##############
HID device specific API defined in :zephyr_file:`include/zephyr/usb/class/usbd_hid.h`.
API Reference
*************
.. doxygengroup:: usbd_hid_device
``` | /content/code_sandbox/doc/connectivity/usb/device_next/api/usbd_hid_device.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 57 |
```restructuredtext
.. _usbd_api:
USB device stack (next) API
###########################
New USB device stack API is experimental and is subject to change without notice.
API reference
*************
.. doxygengroup:: usbd_api
.. doxygengroup:: usbd_msg_api
``` | /content/code_sandbox/doc/connectivity/usb/device_next/api/usbd.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 60 |
```restructuredtext
.. _udc_api:
USB device controller (UDC) driver API
######################################
The USB device controller driver API is described in
:zephyr_file:`include/zephyr/drivers/usb/udc.h` and referred to
as the ``UDC driver`` API.
UDC driver API is experimental and is subject to change withou... | /content/code_sandbox/doc/connectivity/usb/device_next/api/udc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 162 |
```restructuredtext
.. _usb_host_api:
USB host support APIs
#####################
.. toctree::
:maxdepth: 1
uhc.rst
``` | /content/code_sandbox/doc/connectivity/usb/host/api/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 34 |
```restructuredtext
.. _usb_device_stack_next:
New USB device support
######################
Overview
********
USB device support consists of the USB device controller (UDC) drivers
, :ref:`udc_api`, and USB device stack, :ref:`usbd_api`.
The :ref:`udc_api` provides a generic and vendor independent interface to USB
... | /content/code_sandbox/doc/connectivity/usb/device_next/usb_device.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,300 |
```restructuredtext
.. _uhc_api:
USB host controller (UHC) driver API
####################################
The USB host controller driver API is described in
:zephyr_file:`include/zephyr/drivers/usb/uhc.h` and referred to
as the ``UHC driver`` API.
UHC driver API is experimental and is subject to change without noti... | /content/code_sandbox/doc/connectivity/usb/host/api/uhc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 92 |
```restructuredtext
.. _usb_hid_common:
Human Interface Devices (HID)
#############################
Common USB HID part that can be used outside of USB support, defined in
header file :zephyr_file:`include/zephyr/usb/class/hid.h`.
HID types reference
*******************
.. doxygengroup:: usb_hid_definitions
HID it... | /content/code_sandbox/doc/connectivity/usb/api/hid.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 132 |
```restructuredtext
.. _bluetooth-qual:
Qualification
#############
Qualification setup
*******************
.. _auto_pts_repository:
path_to_url
The Zephyr Bluetooth host can be qualified using Bluetooth's PTS (Profile Tuning
Suite) software. It is originally a manual process, but is automated by using
the `Auto... | /content/code_sandbox/doc/connectivity/bluetooth/bluetooth-qual.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 213 |
```restructuredtext
.. _bluetooth-ctlr-arch:
LE Controller
#############
Overview
********
.. image:: img/ctlr_overview.png
#. HCI
* Host Controller Interface, Bluetooth standard
* Provides Zephyr Bluetooth HCI Driver
#. HAL
* Hardware Abstraction Layer
* Vendor Specific, and Zephyr Driver usage
#. ... | /content/code_sandbox/doc/connectivity/bluetooth/bluetooth-ctlr-arch.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,863 |
```restructuredtext
.. _bluetooth:
Bluetooth
#########
This section contains information regarding the Bluetooth stack of the
Zephyr OS. You can use this information to understand the principles behind the
operation of the layers and how they were implemented.
Zephyr includes a complete Bluetooth Low Energy stack fr... | /content/code_sandbox/doc/connectivity/bluetooth/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 168 |
```restructuredtext
.. _bluetooth-arch:
Stack Architecture
##################
Overview
********
This page describes the software architecture of Zephyr's Bluetooth protocol
stack.
.. note::
Zephyr supports mainly Bluetooth Low Energy (BLE), the low-power
version of the Bluetooth specification. Zephyr also has... | /content/code_sandbox/doc/connectivity/bluetooth/bluetooth-arch.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,138 |
```restructuredtext
.. _bluetooth_le_host:
LE Host
#######
The Bluetooth Host implements all the higher-level protocols and
profiles, and most importantly, provides a high-level API for
applications. The following diagram depicts the main protocol & profile
layers of the host.
.. figure:: img/ble_host_layers.png
... | /content/code_sandbox/doc/connectivity/bluetooth/bluetooth-le-host.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,711 |
```restructuredtext
.. _bluetooth-features:
Supported features
##################
.. contents::
:local:
:depth: 2
Since its inception, Zephyr has had a strong focus on Bluetooth and, in
particular, on Bluetooth Low Energy (BLE). Through the contributions of
several companies and individuals involved in exist... | /content/code_sandbox/doc/connectivity/bluetooth/features.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 794 |
```restructuredtext
.. _bluetooth-dev:
Application Development
#######################
Bluetooth applications are developed using the common infrastructure and
approach that is described in the :ref:`application` section of the
documentation.
Additional information that is only relevant to Bluetooth applications can... | /content/code_sandbox/doc/connectivity/bluetooth/bluetooth-dev.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,708 |
```restructuredtext
.. _bluetooth_shell:
Shell
#####
The Bluetooth Shell is an application based on the :ref:`shell_api` module. It offer a collection of
commands made to easily interact with the Bluetooth stack.
Bluetooth Shell Setup and Usage
*******************************
First you need to build and flash your ... | /content/code_sandbox/doc/connectivity/bluetooth/bluetooth-shell.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,464 |
```restructuredtext
.. _bluetooth-tools:
Tools
#####
This page lists and describes tools that can be used to assist during Bluetooth
stack or application development in order to help, simplify and speed up the
development process.
.. contents::
:local:
:depth: 2
.. _bluetooth-mobile-apps:
Mobile applicatio... | /content/code_sandbox/doc/connectivity/bluetooth/bluetooth-tools.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,029 |
```restructuredtext
.. _autopts-linux:
AutoPTS on Linux
################
This tutorial shows how to setup AutoPTS client on Linux with AutoPTS server running on Windows 10
virtual machine. Tested with Ubuntu 20.4 and Linux Mint 20.4.
You must have a Zephyr development environment set up. See
:ref:`getting_started` f... | /content/code_sandbox/doc/connectivity/bluetooth/autopts/autopts-linux.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,296 |
```restructuredtext
.. _autopts-win10:
AutoPTS on Windows 10 with nRF52 board
#######################################
This tutorial shows how to setup AutoPTS client and server to run both on
Windows 10. We use WSL1 with Ubuntu only to build a Zephyr project to
an elf file, because Zephyr SDK is not available on Wind... | /content/code_sandbox/doc/connectivity/bluetooth/autopts/autopts-win10.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,528 |
```xml
<mxfile modified="2019-03-10T18:05:58.030Z" host="www.draw.io" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36" version="10.4.0" etag="qj9h1H4cknFImv2OSCJO" type="device"><diagram id="6d4cab90-ed26-a4b1-f389-1cd79fba1c83" name="Page... | /content/code_sandbox/doc/connectivity/bluetooth/img/ble_host_layers.xml | xml | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 418 |
```xml
<mxfile userAgent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.113 Safari/537.36" version="7.3.5" editor="www.draw.io" type="dropbox"><diagram id="f687c37f-e7c2-666e-7406-977a52d8b595" name="Page-1">7VhNc9owEP01zLSHdGwLDByBJk1nkplMObTpTdjC1kRYriwH6K/vWh/Gls2E... | /content/code_sandbox/doc/connectivity/bluetooth/img/ble_cfg_single.xml | xml | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 478 |
```xml
<mxfile modified="2019-03-07T14:48:10.055Z" host="www.draw.io" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36" version="10.3.5" etag="e-D3ClfASJyunx5gBdFe" type="dropbox"><diagram id="3d368da2-d055-8685-6f25-468c73dcbdd0" name="Page-1">7... | /content/code_sandbox/doc/connectivity/bluetooth/img/ble_cfg_dual.xml | xml | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 748 |
```restructuredtext
.. _bt_sdp:
Service Discovery Protocol (SDP)
################################
API Reference
**************
.. doxygengroup:: bt_sdp
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/sdp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 32 |
```restructuredtext
.. _bt_crypto:
Cryptography
############
API Reference
*************
.. doxygengroup:: bt_crypto
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/crypto.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 26 |
```restructuredtext
.. _bluetooth_mesh:
Bluetooth Mesh Profile
######################
The Bluetooth Mesh profile adds secure wireless multi-hop communication for
Bluetooth Low Energy. This module implements the
`Bluetooth Mesh Protocol Specification v1.1 <path_to_url`_.
Read more about Bluetooth Mesh on the
`Bluetoo... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 158 |
```restructuredtext
.. _bt_hci_drivers:
HCI Drivers
###########
API Reference
*************
.. doxygengroup:: bt_hci_driver
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/hci_drivers.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 32 |
```restructuredtext
.. _bt_uuid_api:
Universal Unique Identifiers (UUIDs)
#####################################
API Reference
*************
.. doxygengroup:: bt_uuid
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/uuid.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 33 |
```restructuredtext
.. _bt_hci_raw:
HCI RAW channel
###############
Overview
********
HCI RAW channel API is intended to expose HCI interface to the remote entity.
The local Bluetooth controller gets owned by the remote entity and host
Bluetooth stack is not used. RAW API provides direct access to packets which
are... | /content/code_sandbox/doc/connectivity/bluetooth/api/hci_raw.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 87 |
```restructuredtext
.. _bluetooth_api:
API
###
Bluetooth Classic Host and profiles
===================================
.. toctree::
:maxdepth: 1
hfp.rst
rfcomm.rst
sdp.rst
Bluetooth LE Audio
==================
.. toctree::
:maxdepth: 1
audio/audio.rst
audio/bap.rst
audio/cap.rst
audio/... | /content/code_sandbox/doc/connectivity/bluetooth/api/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 373 |
```restructuredtext
.. _bt_hfp:
Hands Free Profile (HFP)
########################
API Reference
*************
.. doxygengroup:: bt_hfp
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/hfp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 32 |
```restructuredtext
.. _bluetooth_connection_mgmt:
Connection Management
#####################
The Zephyr Bluetooth stack uses an abstraction called :c:struct:`bt_conn`
to represent connections to other devices. The internals of this struct
are not exposed to the application, but a limited amount of information
(such... | /content/code_sandbox/doc/connectivity/bluetooth/api/connection_mgmt.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 297 |
```restructuredtext
.. _bt_att:
Attribute Protocol (ATT)
########################
API Reference
*************
.. doxygengroup:: bt_att
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/att.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 28 |
```restructuredtext
.. _bt_gatt:
Generic Attribute Profile (GATT)
################################
GATT layer manages the service database providing APIs for service registration
and attribute declaration.
Services can be registered using :c:func:`bt_gatt_service_register` API
which takes the :c:struct:`bt_gatt_ser... | /content/code_sandbox/doc/connectivity/bluetooth/api/gatt.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 951 |
```restructuredtext
.. _bluetooth_services:
Bluetooth standard services
###########################
Battery Service
***************
.. doxygengroup:: bt_bas
Heart Rate Service
******************
.. doxygengroup:: bt_hrs
Immediate Alert Service
***********************
.. doxygengroup:: bt_ias
Object Transfer Ser... | /content/code_sandbox/doc/connectivity/bluetooth/api/services.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 82 |
```restructuredtext
.. _bt_data_buffers:
Data Buffers
#############
API Reference
*************
.. doxygengroup:: bt_buf
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/data_buffer.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 28 |
```restructuredtext
.. _bt_l2cap:
Logical Link Control and Adaptation Protocol (L2CAP)
####################################################
L2CAP layer enables connection-oriented channels which can be enable with the
configuration option: :kconfig:option:`CONFIG_BT_L2CAP_DYNAMIC_CHANNEL`. This channels
support segme... | /content/code_sandbox/doc/connectivity/bluetooth/api/l2cap.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 418 |
```restructuredtext
.. _bluetooth_controller:
Bluetooth Controller
####################
API Reference
*************
.. doxygengroup:: bt_ctrl
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/controller.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 28 |
```restructuredtext
.. _bt_rfcomm:
Serial Port Emulation (RFCOMM)
##############################
API Reference
*************
.. doxygengroup:: bt_rfcomm
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/rfcomm.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 35 |
```restructuredtext
.. _bt_gap:
Generic Access Profile (GAP)
############################
API Reference
*************
.. doxygengroup:: bt_gap
.. doxygengroup:: bt_addr
.. doxygengroup:: bt_gap_defines
``` | /content/code_sandbox/doc/connectivity/bluetooth/api/gap.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 52 |
```restructuredtext
.. _bluetooth_mesh_od_cli:
On-Demand Private Proxy Client
##############################
The On-Demand Private Proxy Client model is a foundation model defined by the Bluetooth Mesh
specification. The model is optional, and is enabled with the
:kconfig:option:`CONFIG_BT_MESH_OD_PRIV_PROXY_CLI` opt... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/od_cli.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 307 |
```restructuredtext
.. _bluetooth_mesh_sar_cfg_cli:
SAR Configuration Client
########################
The SAR Configuration Client model is a foundation model defined by the Bluetooth Mesh
specification. It is an optional model, enabled with the
:kconfig:option:`CONFIG_BT_MESH_SAR_CFG_CLI` configuration option.
The ... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/sar_cfg_cli.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 400 |
```restructuredtext
.. _bluetooth_mesh_blob_cli:
BLOB Transfer Client
####################
The Binary Large Object (BLOB) Transfer Client is the sender of the BLOB transfer. It supports
sending BLOBs of any size to any number of Target nodes, in both Push BLOB Transfer Mode and Pull
BLOB Transfer Mode.
Usage
*****
... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/blob_cli.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,196 |
```restructuredtext
.. _bluetooth_mesh_models_cfg_cli:
Configuration Client
####################
The Configuration Client model is a foundation model defined by the Bluetooth Mesh
specification. It provides functionality for configuring most parameters of a
mesh node, including encryption keys, model configuration an... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/cfg_cli.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 197 |
```restructuredtext
.. _bluetooth_mesh_sar_cfg_srv:
SAR Configuration Server
########################
The SAR Configuration Server model is a foundation model defined by the Bluetooth Mesh
specification. It is an optional model, enabled with the
:kconfig:option:`CONFIG_BT_MESH_SAR_CFG_SRV` configuration option.
The ... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/sar_cfg_srv.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 271 |
```restructuredtext
.. _bluetooth_mesh_models_health_srv:
Health Server
#############
The Health Server model provides attention callbacks and node diagnostics for
:ref:`bluetooth_mesh_models_health_cli` models. It is primarily used to report
faults in the mesh node and map the mesh nodes to their physical location.
... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/health_srv.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 510 |
```restructuredtext
.. _bluetooth_mesh_dfu_srv:
Firmware Update Server
######################
The Firmware Update Server model implements the Target node functionality of the
:ref:`bluetooth_mesh_dfu` subsystem. It extends the :ref:`bluetooth_mesh_blob_srv`, which it uses to
receive the firmware image binary from the... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/dfu_srv.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,282 |
```restructuredtext
.. _bluetooth_mesh_models_op_agg_cli:
Opcodes Aggregator Client
#########################
The Opcodes Aggregator Client model is a foundation model defined by the Bluetooth Mesh
specification. It is an optional model, enabled with the :kconfig:option:`CONFIG_BT_MESH_OP_AGG_CLI`
option.
The Opcode... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/op_agg_cli.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 259 |
```restructuredtext
.. _bluetooth_mesh_blob_flash:
BLOB Flash
##########
The BLOB Flash Readers and Writers implement BLOB reading to and writing from flash partitions
defined in the :ref:`flash map <flash_map_api>`.
BLOB Flash Reader
*****************
The BLOB Flash Reader interacts with the BLOB Transfer Client ... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/blob_flash.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 294 |
```restructuredtext
.. _bluetooth_mesh_lcd_srv:
Large Composition Data Server
#############################
The Large Composition Data Server model is a foundation model defined by the Bluetooth Mesh
specification. The model is optional, and is enabled through the
:kconfig:option:`CONFIG_BT_MESH_LARGE_COMP_DATA_SRV` ... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/lcd_srv.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 391 |
```restructuredtext
.. _bluetooth_mesh_dfu:
Device Firmware Update (DFU)
############################
Bluetooth Mesh supports the distribution of firmware images across a mesh network. The Bluetooth
mesh DFU subsystem implements the Bluetooth Mesh Device Firmware Update Model specification version
1.0.
Bluetooth Mes... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/dfu.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,279 |
```restructuredtext
.. _bluetooth_mesh_models_priv_beacon_cli:
Private Beacon Client
#####################
The Private Beacon Client model is a foundation model defined by the Bluetooth
mesh specification. It is enabled with the
:kconfig:option:`CONFIG_BT_MESH_PRIV_BEACON_CLI` option.
The Private Beacon Client model... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/priv_beacon_cli.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 299 |
```restructuredtext
.. _bluetooth_mesh_models:
Mesh models
###########
Foundation models
*****************
The Bluetooth Mesh specification defines foundation models that can be
used by network administrators to configure and diagnose mesh nodes.
.. toctree::
:maxdepth: 1
cfg_cli
cfg_srv
health_cli
... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/models.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 198 |
```restructuredtext
.. _bluetooth_mesh_blob:
BLOB Transfer models
####################
The Binary Large Object (BLOB) Transfer models implement the Bluetooth Mesh Binary Large Object
Transfer Model specification version 1.0 and provide functionality for sending large binary objects
from a single source to many Target... | /content/code_sandbox/doc/connectivity/bluetooth/api/mesh/blob.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,953 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.