zephyr/doc/connectivity/networking/api/capture.rst
Benjamin Cabé 994558ef8e samples: net: doc: Use new Sphinx extension to document networking samples
Use the new code-sample directive and roles to document the networking
samples so that they show up as "Related samples" when browsing the
various relevant networking APIs.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-19 15:22:59 +01:00

29 lines
601 B
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 monitoring can be setup either manually
using ``net-shell`` or automatically by using the ``net_capture`` API.
Sample usage
************
See :zephyr:code-sample:`net-capture` sample application and
:ref:`network_monitoring` for details.
API Reference
*************
.. doxygengroup:: net_capture