Skip to content

Commit

Permalink
docs(common): Enhance documentation clarity in the examples directory
Browse files Browse the repository at this point in the history
  • Loading branch information
suren-gabrielyan-espressif committed Jan 31, 2024
1 parent 5ba7cfa commit 9357b3e
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Examples

## Overview

This directory showcases a variety of examples, illustrating the use of different interfaces and functionalities. Navigate through these examples to understand how to implement and integrate various components and features in your projects.

## Detailed Examples

1. **Multiple Network Interfaces Example**: Demonstrates the integration and management of multiple network interfaces.
Location: [multiple_netifs](esp_netif/multiple_netifs)

2. **SLIP Device Client**: Provides a detailed example of a SLIP (Serial Line Internet Protocol) device client implementation.
Location: [slip_custom_netif](esp_netif/slip_custom_netif/)

3. **MQTT Demo on Linux**: A comprehensive demonstration of an MQTT (Message Queuing Telemetry Transport) application designed to run on a Linux environment.
Location: [mqtt](mqtt)

## Additional Resources and Examples

For an extensive collection of additional examples, especially those related to specific components, please visit the upper layer directory and navigate to the respective component's example directory.

**Important**: To explore more, check the path: `components/*component_name/examples`

### Examples Include:

- **MDNS Examples**: Multicast DNS service discovery.
Path: [mdns examples](https://github.com/espressif/esp-protocols/tree/master/components/mdns/examples)

- **ESP Modem Examples**: Demonstrates the usage of ESP modem functionalities.
Path: [esp_modem examples](https://github.com/espressif/esp-protocols/tree/master/components/esp_modem/examples)

- **ESP WebSocket Client Examples**: Showcases the implementation of an ESP WebSocket client.
Path: [esp_websocket_client examples](https://github.com/espressif/esp-protocols/tree/master/components/esp_websocket_client/examples)

- **ASIO Examples**: Showcases consistent asynchronous model using a modern C++ approach.
Path: [ASIO examples](https://github.com/espressif/esp-protocols/tree/master/components/asio/examples)

- **ESP MQTT CXX Examples**: Demonstrates ESP MQTT C++ client.
Path: [MQTT CXX examples](https://github.com/espressif/esp-protocols/tree/master/components/esp_mqtt_cxx/examples)

- **Simple Console Initializer Examples**: Demonstrates initialisation over ESP Console.
Path: [ESP Console examples](https://github.com/espressif/esp-protocols/tree/master/components/console_simple_init/examples)

These examples serve as a starting point to understand the implementation and usage of various features in your projects.

0 comments on commit 9357b3e

Please sign in to comment.