diff --git a/.gitignore b/.gitignore index 455196b0d..940ea4400 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,6 @@ -_doxyxml _build .python-version __pycache__/ *.py[cod] *$py.class -esphomeyaml/.DS_Store diff --git a/Doxygen b/Doxygen index d275ee12a..5b0e58184 100644 --- a/Doxygen +++ b/Doxygen @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "esphomelib" +PROJECT_NAME = "ESPHome" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -76,7 +76,7 @@ CREATE_SUBDIRS = NO # U+3044. # The default value is: NO. -ALLOW_UNICODE_NAMES = NO +ALLOW_UNICODE_NAMES = YES # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this @@ -436,7 +436,7 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -462,7 +462,7 @@ EXTRACT_STATIC = NO # for Java sources. # The default value is: YES. -EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are @@ -791,7 +791,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = $(ESPHOMELIB_PATH)/src +INPUT = $(ESPHOME_CORE_PATH)/src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -908,7 +908,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = $(ESPHOMELIB_PATH)/examples +EXAMPLE_PATH = $(ESPHOME_CORE_PATH)/examples # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -997,7 +997,7 @@ USE_MDFILE_AS_MAINPAGE = # also VERBATIM_HEADERS is set to NO. # The default value is: NO. -SOURCE_BROWSER = NO +SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. @@ -1105,7 +1105,7 @@ IGNORE_PREFIX = # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. -GENERATE_HTML = NO +GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1113,7 +1113,7 @@ GENERATE_HTML = NO # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = html +HTML_OUTPUT = _build/html/api # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). @@ -1937,7 +1937,7 @@ MAN_LINKS = NO # captures the structure of the code including all documentation. # The default value is: NO. -GENERATE_XML = YES +GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/Makefile b/Makefile index 9286d428e..249683e4b 100644 --- a/Makefile +++ b/Makefile @@ -1,41 +1,43 @@ -# Minimal makefile for Sphinx documentation -# +ESPHOME_CORE_PATH = ../esphome-core +ESPHOME_CORE_TAG = v1.10.1 -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXPROJ = esphomelib -SOURCEDIR = . -BUILDDIR = _build -ESPHOMELIB_PATH = ../esphomelib -ESPHOMELIB_TAG = v1.10.1 +.PHONY: html cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png -.PHONY: html cleanhtml doxyg cleandoxyg deploy help webserver Makefile $(ESPHOMELIB_PATH) +html: + sphinx-build -M html . _build $(O) -html: _doxyxml - $(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) +cleanhtml: + rm -rf "_build/html/*" -cleanhtml: cleandoxyg - rm -rf "$(BUILDDIR)/html/*" - -doxyg: cleandoxyg _doxyxml - -cleandoxyg: - rm -rf _doxyxml - -_doxyxml: - ESPHOMELIB_PATH=$(ESPHOMELIB_PATH) doxygen Doxygen - -$(ESPHOMELIB_PATH): - @if [ ! -d "$(ESPHOMELIB_PATH)" ]; then \ - git clone --branch $(ESPHOMELIB_TAG) https://github.com/OttoWinter/esphomelib.git $(ESPHOMELIB_PATH); \ - fi - -convertimages: +svg2png: python3 svg2png.py help: - $(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + sphinx-build -M help . _build $(O) + +api: + mkdir -p _build/html/api + @if [ ! -d "$(ESPHOME_CORE_PATH)" ]; then \ + git clone --branch $(ESPHOME_CORE_TAG) https://github.com/esphome/esphome-core.git $(ESPHOME_CORE_PATH); \ + fi + ESPHOME_CORE_PATH=$(ESPHOME_CORE_PATH) doxygen Doxygen + +netlify-api: netlify-dependencies + mkdir -p _build/html/api + @if [ ! -d "$(ESPHOME_CORE_PATH)" ]; then \ + git clone --branch $(ESPHOME_CORE_TAG) https://github.com/esphome/esphome-core.git $(ESPHOME_CORE_PATH); \ + fi + ESPHOME_CORE_PATH=$(ESPHOME_CORE_PATH) ../doxybin/doxygen Doxygen + +netlify-dependencies: + mkdir -p ../doxybin + curl -L https://github.com/esphome/esphome-docs/releases/download/v1.10.1/doxygen-1.8.13.xz | xz -d >../doxybin/doxygen + chmod +x ../doxybin/doxygen + +copy-svg2png: + cp svg2png/*.png _build/html/_images/ + +netlify: netlify-dependencies netlify-api html copy-svg2png webserver: html cd "$(BUILDDIR)/html" && python3 -m http.server @@ -43,4 +45,4 @@ webserver: html # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + sphinx-build -M $@ . _build $(O) diff --git a/README.md b/README.md index 10ba7cb1f..1be60c246 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,4 @@ The source for https://esphomelib.com/ -For contributing, please see https://esphomelib.com/esphomeyaml/guides/contributing.html#contributing-to-esphomedocs +For contributing, please see https://esphomelib.com/guides/contributing.html#contributing-to-esphomedocs diff --git a/_static/android-chrome-192x192.png b/_static/android-chrome-192x192.png new file mode 100644 index 000000000..9377cd6f8 Binary files /dev/null and b/_static/android-chrome-192x192.png differ diff --git a/_static/android-chrome-512x512.png b/_static/android-chrome-512x512.png new file mode 100644 index 000000000..9d3afb649 Binary files /dev/null and b/_static/android-chrome-512x512.png differ diff --git a/_static/apple-touch-icon.png b/_static/apple-touch-icon.png index 4eff01ca2..5dcf52cc6 100644 Binary files a/_static/apple-touch-icon.png and b/_static/apple-touch-icon.png differ diff --git a/_static/browserconfig.xml b/_static/browserconfig.xml new file mode 100644 index 000000000..bfd6f62d9 --- /dev/null +++ b/_static/browserconfig.xml @@ -0,0 +1,9 @@ + + + + + + #dfdfdf + + + diff --git a/_static/favicon-16x16.png b/_static/favicon-16x16.png new file mode 100644 index 000000000..5efde4f54 Binary files /dev/null and b/_static/favicon-16x16.png differ diff --git a/_static/favicon-32x32.png b/_static/favicon-32x32.png new file mode 100644 index 000000000..674b8d307 Binary files /dev/null and b/_static/favicon-32x32.png differ diff --git a/_static/favicon.ico b/_static/favicon.ico index 5aaaf3fb2..88dcd7e2d 100644 Binary files a/_static/favicon.ico and b/_static/favicon.ico differ diff --git a/_static/logo-full.png b/_static/logo-full.png deleted file mode 100644 index 454124f3e..000000000 Binary files a/_static/logo-full.png and /dev/null differ diff --git a/_static/logo.png b/_static/logo.png deleted file mode 100644 index 554230067..000000000 Binary files a/_static/logo.png and /dev/null differ diff --git a/_static/mstile-150x150.png b/_static/mstile-150x150.png new file mode 100644 index 000000000..e469a3872 Binary files /dev/null and b/_static/mstile-150x150.png differ diff --git a/_static/safari-pinned-tab.svg b/_static/safari-pinned-tab.svg new file mode 100644 index 000000000..0c305ab72 --- /dev/null +++ b/_static/safari-pinned-tab.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/_static/site.webmanifest b/_static/site.webmanifest new file mode 100644 index 000000000..5ceeda435 --- /dev/null +++ b/_static/site.webmanifest @@ -0,0 +1,20 @@ +{ + "name": "ESPHome", + "short_name": "ESPHome", + "icons": [ + { + "src": "/_static/android-chrome-192x192.png", + "sizes": "192x192", + "type": "image/png" + }, + { + "src": "/_static/android-chrome-512x512.png", + "sizes": "512x512", + "type": "image/png" + } + ], + "theme_color": "#dfdfdf", + "background_color": "#dfdfdf", + "start_url": "https://esphome.io/", + "display": "standalone" +} diff --git a/_templates/layout.html b/_templates/layout.html index 67f72ca51..a4b3402ba 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -1,12 +1,29 @@ {% extends 'alabaster/layout.html' %} +{%- block extrahead %} + {{ super() }} + + + + + + + + + + + + + +{% endblock %} + {% block footer %}
Privacy Policy
diff --git a/api/binary_sensor/esp32_touch.rst b/api/binary_sensor/esp32_touch.rst deleted file mode 100644 index 67729fe0c..000000000 --- a/api/binary_sensor/esp32_touch.rst +++ /dev/null @@ -1,31 +0,0 @@ -ESP32 Touch Binary Sensor -========================= - -Example Usage -------------- - -.. code-block:: cpp - - auto *touch = App.make_esp32_touch_component(); - touch->set_setup_mode(true); - touch->set_iir_filter(1000); - App.register_binary_sensor(touch_hub->make_touch_pad("ESP32 Touch Pad 9", TOUCH_PAD_NUM9, 1000)); - -.. cpp:namespace:: nullptr - -See :cpp:func:`Application::make_esp32_touch_component`. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -.. doxygenclass:: binary_sensor::ESP32TouchComponent - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::ESP32TouchBinarySensor - :members: - :protected-members: - :undoc-members: diff --git a/api/binary_sensor/gpio.rst b/api/binary_sensor/gpio.rst deleted file mode 100644 index ff7d3e754..000000000 --- a/api/binary_sensor/gpio.rst +++ /dev/null @@ -1,26 +0,0 @@ -GPIO Binary Sensor -================== - -Example Usage -------------- - -.. code-block:: cpp - - // Basic - App.make_gpio_binary_sensor("Window Open", 36); - // Custom pinMode - App.make_gpio_binary_sensor("Window Open", GPIOInputPin(36, INPUT_PULLUP)); - -.. cpp:namespace:: nullptr - -See :cpp:func:`Application::make_gpio_binary_sensor`. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -.. doxygenclass:: binary_sensor::GPIOBinarySensorComponent - :members: - :protected-members: - :undoc-members: diff --git a/api/binary_sensor/index.rst b/api/binary_sensor/index.rst deleted file mode 100644 index b1a28fab2..000000000 --- a/api/binary_sensor/index.rst +++ /dev/null @@ -1,131 +0,0 @@ -Binary Sensor -============= - -.. cpp:namespace:: binary_sensor - -In esphomelib, every component that exposes a binary state, is a :cpp:class:`BinarySensor`. - -To create your own binary sensor, simply subclass :cpp:class:`BinarySensor` and call -:cpp:func:`BinarySensor::publish_state` to tell the frontend that you have a new state. -Inversion is automatically done for you when publishing state and can be changed by the -user with :cpp:func:`BinarySensor::set_inverted`. - -Supported Binary Sensors ------------------------- - -.. toctree:: - :glob: - - * - -Example Usage -------------- - -.. code-block:: cpp - - // Basic - App.register_binary_sensor(custom_binary_sensor); - // GPIO Binary Sensor - App.make_gpio_binary_sensor("Window Open", 36); - - -.. cpp:namespace:: nullptr - -See :cpp:func:`Application::register_binary_sensor` and :cpp:func:`Application::make_gpio_binary_sensor`. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -BinarySensor -************ - -.. doxygenclass:: binary_sensor::BinarySensor - :members: - :protected-members: - :undoc-members: - -MQTTBinarySensorComponent -************************* - -.. doxygenclass:: binary_sensor::MQTTBinarySensorComponent - :members: - :protected-members: - :undoc-members: - -Filters -******* - -.. doxygenclass:: binary_sensor::Filter - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::DelayedOnFilter - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::DelayedOffFilter - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::HeartbeatFilter - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::InvertFilter - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::LambdaFilter - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::UniqueFilter - :members: - :protected-members: - :undoc-members: - -Triggers -******** - -.. doxygenclass:: binary_sensor::PressTrigger - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::ReleaseTrigger - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::ClickTrigger - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::DoubleClickTrigger - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::MultiClickTrigger - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::BinarySensorCondition - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::CustomBinarySensorConstructor - :members: - :protected-members: - :undoc-members: diff --git a/api/binary_sensor/pn532.rst b/api/binary_sensor/pn532.rst deleted file mode 100644 index a4537bd0a..000000000 --- a/api/binary_sensor/pn532.rst +++ /dev/null @@ -1,19 +0,0 @@ -PN532 NFC/RFID Controller -========================= - -See :cpp:func:`Application::make_pn532_component`. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -.. doxygenclass:: binary_sensor::PN532Component - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::PN532BinarySensor - :members: - :protected-members: - :undoc-members: diff --git a/api/binary_sensor/rdm6300.rst b/api/binary_sensor/rdm6300.rst deleted file mode 100644 index d340dd869..000000000 --- a/api/binary_sensor/rdm6300.rst +++ /dev/null @@ -1,19 +0,0 @@ -RDM6300 NFC/RFID Controller -=========================== - -See :cpp:func:`Application::make_rdm6300_component`. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -.. doxygenclass:: binary_sensor::RDM6300Component - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: binary_sensor::RDM6300BinarySensor - :members: - :protected-members: - :undoc-members: diff --git a/api/binary_sensor/remote_receiver.rst b/api/binary_sensor/remote_receiver.rst deleted file mode 100644 index 3f98cffaa..000000000 --- a/api/binary_sensor/remote_receiver.rst +++ /dev/null @@ -1,112 +0,0 @@ -Remote Receiver -=============== - -.. cpp:namespace:: nullptr - -See :cpp:func:`Application::make_remote_receiver_component` and -:cpp:func:`Application::register_binary_sensor`. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -.. doxygenclass:: remote::RemoteReceiverComponent - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::RemoteReceiver - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::RemoteReceiveDumper - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::LGReceiver - :members: - :protected-members: - :undoc-members: -.. doxygenclass:: remote::LGDumper - :members: - :protected-members: - :undoc-members: -.. doxygenfunction:: remote::decode_lg - -.. doxygenclass:: remote::NECReceiver - :members: - :protected-members: - :undoc-members: -.. doxygenclass:: remote::NECDumper - :members: - :protected-members: - :undoc-members: -.. doxygenfunction:: remote::decode_nec - -.. doxygenclass:: remote::PanasonicReceiver - :members: - :protected-members: - :undoc-members: -.. doxygenclass:: remote::PanasonicDumper - :members: - :protected-members: - :undoc-members: -.. doxygenfunction:: remote::decode_panasonic - -.. doxygenclass:: remote::SonyReceiver - :members: - :protected-members: - :undoc-members: -.. doxygenclass:: remote::SonyDumper - :members: - :protected-members: - :undoc-members: -.. doxygenfunction:: remote::decode_sony - -.. doxygenclass:: remote::RawReceiver - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::RawDumper - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::SamsungReceiver - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::RCSwitchRawReceiver - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::RCSwitchTypeAReceiver - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::RCSwitchTypeBReceiver - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::RCSwitchTypeCReceiver - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::RCSwitchTypeDReceiver - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: remote::RCSwitchDumper - :members: - :protected-members: - :undoc-members: diff --git a/api/binary_sensor/status.rst b/api/binary_sensor/status.rst deleted file mode 100644 index a121565a9..000000000 --- a/api/binary_sensor/status.rst +++ /dev/null @@ -1,26 +0,0 @@ -Node Status Binary Sensor -========================= - -This binary sensor platform allows you to create a switch that uses the birth and last will -messages by the MQTT client to show an ON/OFF state of the node. - -Example Usage -------------- - -.. code-block:: cpp - - App.make_status_binary_sensor("Livingroom Node Status"); - -.. cpp:namespace:: nullptr - -See :cpp:func:`Application::make_status_binary_sensor`. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -.. doxygenclass:: binary_sensor::StatusBinarySensor - :members: - :protected-members: - :undoc-members: diff --git a/api/binary_sensor/template.rst b/api/binary_sensor/template.rst deleted file mode 100644 index d84ce409a..000000000 --- a/api/binary_sensor/template.rst +++ /dev/null @@ -1,16 +0,0 @@ -Template Binary Sensor -====================== - -.. cpp:namespace:: nullptr - -See :cpp:func:`Application::make_template_binary_sensor`. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -.. doxygenclass:: binary_sensor::TemplateBinarySensor - :members: - :protected-members: - :undoc-members: diff --git a/api/core/application.rst b/api/core/application.rst deleted file mode 100644 index 0f5017bd0..000000000 --- a/api/core/application.rst +++ /dev/null @@ -1,38 +0,0 @@ -Application -=========== - -.. cpp:namespace:: nullptr - -The :cpp:class:`Application` class has two objectives: 1. handle all of -your :cpp:class:`Component`\ s and 2. provide helper methods to simplify creating a component. - -.. cpp:namespace:: Application - -In itself, an Application instance doesn't do and store very much. It mostly only keeps track of all Components -(using an internal :cpp:func:`std::vector` containing pointers), so that when the user calls the :cpp:func:`setup` or -:cpp:func:`loop` methods, it can relay those calls to the components. - -In order for the Application to know about your components, each one of them should be registered using the -:cpp:func:`register_component` call. And for subclasses of MQTTComponent, :cpp:func:`register_mqtt_component` -shall be used. - -Apart from the helpers, only one function is really necessary for setting up the Application instance: -:cpp:func:`set_name`. The name provided by this is used throughout the code base to construct various strings -such as MQTT topics or WiFi hostnames. Additionally, some one-time-setup components such as MQTT or WiFi can be -initialized with the `init_` calls. Next, this class provides a bunch of helper methods to create and -register components easily using the `make_` calls. - -Each component can tell the Application with which *priority* it wishes to be called using the `get_loop_priority()` -and `get_setup_priority()` overrides. The Application will then automatically order the components before execution. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -.. doxygenclass:: Application - :members: - :protected-members: - :undoc-members: - -.. doxygenvariable:: App diff --git a/api/core/automation.rst b/api/core/automation.rst deleted file mode 100644 index 9720172c7..000000000 --- a/api/core/automation.rst +++ /dev/null @@ -1,7 +0,0 @@ -Automation -========== - -API Reference -------------- - -.. doxygenfile:: esphomelib/automation.h diff --git a/api/core/component.rst b/api/core/component.rst deleted file mode 100644 index b5090e46e..000000000 --- a/api/core/component.rst +++ /dev/null @@ -1,34 +0,0 @@ -Component -========= - -.. cpp:namespace:: Component - -Every object that should be handled by the Application instance and receive :cpp:func:`setup` and -:cpp:func:`loop` calls must be a subclass of :cpp:class:`Component`. - -API Reference -------------- - -.. cpp:namespace:: nullptr - -Component -********* - -.. doxygenclass:: Component - :members: - :protected-members: - :undoc-members: - -PollingComponent -**************** - -.. doxygenclass:: PollingComponent - :members: - :protected-members: - :undoc-members: - - -Setup Priorities -**************** - -.. doxygennamespace:: setup_priority diff --git a/api/core/controller.rst b/api/core/controller.rst deleted file mode 100644 index 02cca14f2..000000000 --- a/api/core/controller.rst +++ /dev/null @@ -1,23 +0,0 @@ -Controller -========== - -API Reference -------------- - -.. cpp:namespace:: nullptr - -Controller -********** - -.. doxygenclass:: Controller - :members: - :protected-members: - :undoc-members: - -StoringController -***************** - -.. doxygenclass:: StoringController - :members: - :protected-members: - :undoc-members: diff --git a/api/core/deep-sleep.rst b/api/core/deep-sleep.rst deleted file mode 100644 index b4e2ac2ae..000000000 --- a/api/core/deep-sleep.rst +++ /dev/null @@ -1,27 +0,0 @@ -Deep Sleep -========== - -.. cpp:namespace:: DeepSleepComponent - -API Reference -------------- - -.. cpp:namespace:: nullptr - -DeepSleepComponent -****************** - -.. doxygenclass:: DeepSleepComponent - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: EnterDeepSleepAction - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: PreventDeepSleepAction - :members: - :protected-members: - :undoc-members: diff --git a/api/core/helpers.rst b/api/core/helpers.rst deleted file mode 100644 index 7e4b6208d..000000000 --- a/api/core/helpers.rst +++ /dev/null @@ -1,74 +0,0 @@ -Helpers -======= - -esphomelib uses a bunch of helpers to make the library easier to use. - -API Reference -------------- - -helpers.h -********* - -.. doxygenfile:: esphomelib/helpers.h - -util.h -****** - -.. doxygenfile:: esphomelib/uil.h - -optional.h -********** - -.. doxygenfile:: esphomelib/optional.h - -ESPPreferences -************** - -.. doxygenclass:: ESPPreferences - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: ESPPreferenceObject - :members: - :protected-members: - :undoc-members: - -.. doxygenvariable:: global_preferences - -esphal.h -******** - -This header should be used whenever you want to access some `digitalRead`, `digitalWrite`, ... methods. - -.. doxygenclass:: GPIOPin - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: GPIOOutputPin - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: GPIOInputPin - :members: - :protected-members: - :undoc-members: - - -ESPOneWire -********** - -esphomelib has its own implementation of OneWire, because the implementation in the Arduino libraries -seems to have lots of timing issues with the ESP8266/ESP32. That's why ESPOneWire was created. - -.. doxygenclass:: ESPOneWire - :members: - :protected-members: - :undoc-members: - -defines.h -********* - -.. doxygenfile:: esphomelib/defines.h diff --git a/api/core/i2c.rst b/api/core/i2c.rst deleted file mode 100644 index 4983b4ceb..000000000 --- a/api/core/i2c.rst +++ /dev/null @@ -1,20 +0,0 @@ -I2CComponent -============ - -To make i2c devices easier to implement in esphomelib, there's a special I2CComponent implementing -a bunch of i2c helper functions on top of the Arduino Wire library. It is also the preferred way -of using i2c peripherals since it implements timeouts, verbose logs for debugging issues, and -for the ESP32 the ability to have multiple i2c busses in operation at the same time. - -API Reference -------------- - -.. doxygenclass:: I2CComponent - :members: - :protected-members: - :undoc-members: - -.. doxygenclass:: I2CDevice - :members: - :protected-members: - :undoc-members: diff --git a/api/core/index.rst b/api/core/index.rst deleted file mode 100644 index 925f45e8e..000000000 --- a/api/core/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -Core -==== - -.. toctree:: - :maxdepth: 1 - - Application - Component - WiFi - MQTT Client - Over-The-Air Updates - Helpers - Logging Engine - Power Supply - Controller - Web Server - Deep Sleep - I2C - Automation - Time