diff --git a/.github/workflows/publish-docs-component.yml b/.github/workflows/publish-docs-component.yml index 44a38496bd..ae6390acfb 100644 --- a/.github/workflows/publish-docs-component.yml +++ b/.github/workflows/publish-docs-component.yml @@ -46,6 +46,6 @@ jobs: - name: Upload components to component service uses: espressif/github-actions/upload_components@master with: - directories: "components/esp_modem;components/esp_websocket_client;components/mdns;components/asio" + directories: "components/esp_modem;components/esp_websocket_client;components/mdns;components/asio;components/esp_mqtt_cxx" namespace: "espressif" api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }} diff --git a/README.md b/README.md index bf00eb726d..3b5b47a425 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,8 @@ * Brief introduction [README](components/asio/README.md) * Full html [documentation](https://docs.espressif.com/projects/esp-protocols/docs/latest/asio/index.html) + +### esp_mqtt_cxx + +* Brief introduction [README](components/esp_mqtt_cxx/README.md) +* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/docs/latest/esp_mqtt_cxx/index.html) diff --git a/components/esp_mqtt_cxx/README.md b/components/esp_mqtt_cxx/README.md new file mode 100644 index 0000000000..75961805d7 --- /dev/null +++ b/components/esp_mqtt_cxx/README.md @@ -0,0 +1,13 @@ +# esp_mqtt_cxx + +[![Component Registry](https://components.espressif.com/components/espressif/esp_mqtt_cxx/badge.svg)](https://components.espressif.com/components/espressif/esp_mqtt_cxx) + +The ESP MQTT client is a wrapper over the esp_mqtt client with the goal of providing a higher level API. + +## Examples + +Get started with [examples](examples) + +## Documentation + +* View the full [html documentation](https://docs.espressif.com/projects/esp-protocols/docs/latest/esp_mqtt_cxx/index.html) diff --git a/docs/esp_mqtt_cxx/en/index.rst b/docs/esp_mqtt_cxx/en/index.rst index 0c4814a75a..9416aa2ee4 100644 --- a/docs/esp_mqtt_cxx/en/index.rst +++ b/docs/esp_mqtt_cxx/en/index.rst @@ -36,8 +36,8 @@ Events are dispatched throug calls to member functions each one dedicated to a t Application Example ------------------- -* :example:`tcp <../examples/tcp>` -* :example:`ssl <../examples/ssl>` +* :example:`tcp <../../components/esp_mqtt_cxx/examples/tcp>` +* :example:`ssl <../../components/esp_mqtt_cxx/examples/ssl>` API Reference -------------