Skip to content

[web_server] Document viewing logs over the web_server stream#6823

Open
bdraco wants to merge 1 commit into
nextfrom
web-server-logs
Open

[web_server] Document viewing logs over the web_server stream#6823
bdraco wants to merge 1 commit into
nextfrom
web-server-logs

Conversation

@bdraco

@bdraco bdraco commented Jun 21, 2026

Copy link
Copy Markdown
Member

Description

Documents that esphome logs can stream device logs over the web_server /events SSE endpoint, for devices that have web_server: configured but no native API. Updates the web_server log option and adds a transport note to the CLI logs command.

Related issue (if applicable): fixes N/A

Pull request in esphome with YAML changes (if applicable):

Checklist

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /src/content/docs/components/index.mdx when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing component_name with your component name in lower_case format with underscores (e.g., bme280, sht3x, dallas_temp):

    @esphomebot generate image component_name
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the /public/images/ folder of this repository.

  4. Use the image in your component's index table entry in /src/content/docs/components/index.mdx.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image dht22

Note: All images used in ImgTable components must be placed in /public/images/ as the component resolves them to absolute paths.

@netlify

netlify Bot commented Jun 21, 2026

Copy link
Copy Markdown

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 39ef41e
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a38039c8214550008c2ce68
😎 Deploy Preview https://deploy-preview-6823--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@bdraco bdraco marked this pull request as ready for review June 25, 2026 11:18
Copilot AI review requested due to automatic review settings June 25, 2026 11:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents the esphome logs CLI command’s ability to stream logs over the web_server /events SSE endpoint for devices without the native API enabled, and clarifies the web_server logging option accordingly.

Changes:

  • Added a transport selection note to the logs command section in the CLI guide (API → MQTT → web_server /events).
  • Expanded the web_server log option description to mention /events log streaming for esphome logs.
  • Added a cross-reference from web_server docs to the esphome logs CLI documentation.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/content/docs/guides/cli.mdx Adds a note describing which transports esphome logs uses for network logging, including the web_server /events stream.
src/content/docs/components/web_server.mdx Updates log option documentation to mention /events log streaming and adds a “See Also” link to the esphome logs docs.

Comment on lines +344 to +346
For network logging, ESPHome uses the [native API](/components/api/) if configured, then MQTT, then the
[`web_server`](/components/web_server/) `/events` stream. The web_server stream is used for devices that have a
`web_server` but no native API, and reconnects automatically if the connection drops.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants