diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000000..ec6e9d4fe39 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,53 @@ +# 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) + +- **Console Command ifconfig Examples**: Demonstrates of console command ifconfig. + Path: [ESP Console Command ifconfig examples](https://github.com/espressif/esp-protocols/tree/master/components/console_cmd_ifconfig/examples) + +- **Console Command WIFI Examples**: Demonstrates of console command wifi. + Path: [ESP Console Command wifi examples](https://github.com/espressif/esp-protocols/tree/master/components/console_cmd_wifi/examples) + +- **Console Command PING Examples**: Demonstrates of console command ping. + Path: [ESP Console Command ping examples](https://github.com/espressif/esp-protocols/tree/master/components/console_cmd_ping/examples) + +These examples serve as a starting point to understand the implementation and usage of various features in your projects.