|
| 1 | +.. _external_module_zenoh_pico: |
| 2 | + |
| 3 | +zenoh-pico |
| 4 | +########## |
| 5 | + |
| 6 | +Introduction |
| 7 | +************ |
| 8 | + |
| 9 | +`zenoh-pico`_ is the `Eclipse Zenoh`_ implementation that targets constrained devices, offering a |
| 10 | +native C API. It provides Zero Overhead Pub/sub, Store/Query and Compute capabilities for embedded |
| 11 | +systems and microcontrollers. |
| 12 | + |
| 13 | +zenoh-pico unifies data in motion, data at rest, and computations while retaining time and space |
| 14 | +efficiency well beyond mainstream stacks. It is fully compatible with the main Rust Zenoh |
| 15 | +implementation, providing a lightweight implementation of most functionalities. |
| 16 | + |
| 17 | +zenoh-pico is licensed under the Eclipse Public License 2.0 and Apache License 2.0. |
| 18 | + |
| 19 | +Usage with Zephyr |
| 20 | +***************** |
| 21 | + |
| 22 | +The zenoh-pico repository is a Zephyr :ref:`module <modules>` which provides distributed |
| 23 | +communication capabilities to Zephyr applications. It supports UDP (unicast and multicast), TCP |
| 24 | +transport layers over IPv4, IPv6, and 6LoWPAN networks with WiFi, Ethernet, Thread, and Serial data |
| 25 | +link layers. |
| 26 | + |
| 27 | +To pull in zenoh-pico as a Zephyr module, either add it as a West project in the ``west.yaml`` |
| 28 | +file or pull it in by adding a submanifest (e.g. ``zephyr/submanifests/zenoh-pico.yaml``) file |
| 29 | +with the following content and run ``west update``: |
| 30 | + |
| 31 | +.. code-block:: yaml |
| 32 | +
|
| 33 | + manifest: |
| 34 | + projects: |
| 35 | + - name: zenoh-pico |
| 36 | + url: https://github.com/eclipse-zenoh/zenoh-pico.git |
| 37 | + revision: main |
| 38 | + path: modules/lib/zenoh-pico # adjust the path as needed |
| 39 | +
|
| 40 | +For more detailed instructions and API documentation, refer to the `zenoh-pico documentation`_ as |
| 41 | +well as the provided `Zephyr examples`_. |
| 42 | + |
| 43 | +References |
| 44 | +********** |
| 45 | + |
| 46 | +.. target-notes:: |
| 47 | + |
| 48 | +.. _zenoh-pico: |
| 49 | + https://github.com/eclipse-zenoh/zenoh-pico |
| 50 | + |
| 51 | +.. _Eclipse Zenoh: |
| 52 | + https://zenoh.io |
| 53 | + |
| 54 | +.. _zenoh-pico documentation: |
| 55 | + https://zenoh-pico.readthedocs.io/en/latest/ |
| 56 | + |
| 57 | +.. _Zephyr examples: |
| 58 | + https://github.com/eclipse-zenoh/zenoh-pico/tree/main/examples/zephyr |
0 commit comments