esphome-docs/components/web_server.rst

52 lines
1.8 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Web Server Component
====================
2018-11-14 22:12:27 +01:00
.. seo::
2019-02-16 23:25:23 +01:00
:description: Instructions for setting up a web server in ESPHome.
:image: http.png
2018-11-14 22:12:27 +01:00
:keywords: web server, http, REST API
2018-05-13 11:37:02 +02:00
The ``web_server`` component creates a simple web server on the node that can be accessed
through any browser and a simple `REST API`_. Please note that enabling this component
will take up *a lot* of memory and can lead to problems, especially on the ESP8266.
To navigate to the web server in your browser, either use the IP address of the node or
use ``<node_name>.local/`` (note the trailing forward slash) via mDNS.
To conserve flash size, the CSS and JS files used on the root page to show a simple user
2019-02-16 23:25:23 +01:00
interface are hosted by esphome.io. If you want to use your own service, use the
2018-05-13 11:37:02 +02:00
``css_url`` and ``js_url`` options in your configuration.
.. _REST API: /web-api/index.html
.. figure:: /components/images/web_server.png
2018-05-13 11:37:02 +02:00
:align: center
Example web server frontend.
.. code-block:: yaml
2018-05-13 11:37:02 +02:00
# Example configuration entry
web_server:
port: 80
Configuration variables:
2018-08-24 22:44:01 +02:00
------------------------
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
- **port** (*Optional*, int): The port the web server should open its socket on.
- **css_url** (*Optional*, url): The URL that should be used for the CSS stylesheet. Defaults
2019-02-16 23:25:23 +01:00
to https://esphome.io/_static/webserver-v1.min.css (updates will go to ``v2``, ``v3``, etc).
2018-06-01 18:10:00 +02:00
- **js_url** (*Optional*, url): The URL that should be used for the JS script. Defaults
2019-02-16 23:25:23 +01:00
to https://esphome.io/_static/webserver-v1.min.js.
2018-06-01 18:10:00 +02:00
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
2018-11-09 20:06:40 +01:00
.. note::
Starting with version 1.9.0, you can also upload firmware files OTA with the web server.
2018-06-01 18:10:00 +02:00
See Also
--------
2019-05-12 22:44:59 +02:00
- :apiref:`web_server/web_server.h`
- :ghedit:`Edit`