Skip to content

Commit dd32551

Browse files
OttoWinterOttoWinter
committed
Documentation update
1 parent d421b90 commit dd32551

File tree

234 files changed

+5653
-2007
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

234 files changed

+5653
-2007
lines changed

‎Doxygen‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = "esphomelib"
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = 1.5.1
41+
PROJECT_NUMBER = 1.5.3
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

‎api/binary_sensor/index.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ Supported Binary Sensors
1515

1616
.. toctree::
1717

18-
GPIO Binary Sensor <gpio>
19-
Node Status Binary Sensor <status>
20-
ESP32 Touch Binary Sensor <esp32_touch>
18+
gpio
19+
status
20+
esp32_touch
21+
template
2122

2223
Example Usage
2324
-------------

‎api/binary_sensor/template.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Template Binary Sensor
2+
======================
3+
4+
.. cpp:namespace:: nullptr
5+
6+
See :cpp:func:`Application::make_template_binary_sensor`.
7+
8+
API Reference
9+
-------------
10+
11+
.. cpp:namespace:: nullptr
12+
13+
.. doxygenclass:: binary_sensor::TemplateBinarySensor
14+
:members:
15+
:protected-members:
16+
:undoc-members:

‎api/core/automation.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Automation
2+
==========
3+
4+
API Reference
5+
-------------
6+
7+
.. doxygenfile:: esphomelib/automation.h

‎api/core/helpers.rst‎

Lines changed: 4 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -9,83 +9,12 @@ API Reference
99
helpers.h
1010
*********
1111

12-
.. doxygentypedef:: json_parse_t
12+
.. doxygenfile:: esphomelib/helpers.h
1313

14-
.. doxygentypedef:: json_build_t
15-
16-
.. doxygenvariable:: HOSTNAME_CHARACTER_WHITELIST
17-
18-
.. doxygenfunction:: get_mac_address
19-
20-
.. doxygenfunction:: generate_hostname
21-
22-
.. doxygenfunction:: sanitize_hostname
23-
24-
.. doxygenfunction:: truncate_string
25-
26-
.. doxygenfunction:: is_empty
27-
28-
.. doxygenfunction:: reboot
29-
30-
.. doxygenfunction:: add_shutdown_hook
31-
32-
.. doxygenfunction:: safe_reboot
33-
34-
.. doxygenfunction:: add_safe_shutdown_hook
35-
36-
.. doxygenfunction:: to_lowercase_underscore
37-
38-
.. doxygenfunction:: build_json
39-
40-
.. doxygenfunction:: parse_json
41-
42-
.. doxygenfunction:: clamp
43-
44-
.. doxygenfunction:: lerp
45-
46-
.. doxygenfunction:: make_unique
47-
48-
.. doxygenfunction:: random_uint32
49-
50-
.. doxygenfunction:: random_double
51-
52-
.. doxygenfunction:: random_float
53-
54-
.. doxygenfunction:: gamma_correct
55-
56-
.. doxygenfunction:: value_accuracy_to_string
57-
58-
.. doxygenfunction:: uint64_to_string
59-
.. doxygenfunction:: uint32_to_string
60-
61-
.. doxygenfunction:: sanitize_string_whitelist
62-
63-
.. doxygenfunction:: disable_interrupts
64-
.. doxygenfunction:: enable_interrupts
65-
66-
.. doxygenfunction:: crc8
67-
68-
.. doxygenclass:: Optional
69-
:members:
70-
:protected-members:
71-
:undoc-members:
72-
73-
.. doxygenfunction:: parse_on_off
74-
75-
.. doxygenclass:: SlidingWindowMovingAverage
76-
:members:
77-
:protected-members:
78-
:undoc-members:
79-
80-
.. doxygenclass:: ExponentialMovingAverage
81-
:members:
82-
:protected-members:
83-
:undoc-members:
14+
optional.h
15+
**********
8416

85-
.. doxygenclass:: CallbackManager
86-
:members:
87-
:protected-members:
88-
:undoc-members:
17+
.. doxygenfile:: esphomelib/optional.h
8918

9019
ESPPreferences
9120
**************

‎api/core/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ Core
1616
Web Server <web-server>
1717
Deep Sleep <deep-sleep>
1818
I2C <i2c>
19+
Automation <automation>

‎api/cover/index.rst‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
Cover
2+
=====
3+
4+
Supported Covers
5+
----------------
6+
7+
.. toctree::
8+
9+
template
10+
11+
Example Usage
12+
-------------
13+
14+
See :cpp:func:`Application::register_cover`.
15+
16+
API Reference
17+
-------------
18+
19+
.. cpp:namespace:: nullptr
20+
21+
Cover
22+
*****
23+
24+
.. doxygenclass:: cover::Cover
25+
:members:
26+
:protected-members:
27+
:undoc-members:
28+
29+
.. doxygenenum:: cover::CoverState
30+
31+
.. doxygenclass:: cover::OpenAction
32+
:members:
33+
:protected-members:
34+
:undoc-members:
35+
36+
.. doxygenclass:: cover::CloseAction
37+
:members:
38+
:protected-members:
39+
:undoc-members:
40+
41+
.. doxygenclass:: cover::StopAction
42+
:members:
43+
:protected-members:
44+
:undoc-members:
45+
46+
MQTTCoverComponent
47+
******************
48+
49+
.. doxygenclass:: cover::MQTTCoverComponent
50+
:members:
51+
:protected-members:
52+
:undoc-members:

‎api/cover/template.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Template Cover
2+
==============
3+
4+
.. cpp:namespace:: nullptr
5+
6+
See :cpp:func:`Application::make_template_cover`.
7+
8+
API Reference
9+
-------------
10+
11+
.. cpp:namespace:: nullptr
12+
13+
.. doxygenclass:: cover::TemplateCover
14+
:members:
15+
:protected-members:
16+
:undoc-members:

‎api/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ API Reference
1111
Fan <fan/index>
1212
Light <light/index>
1313
Switch <switch/index>
14+
Cover <cover/index>
1415
Miscellaneous <misc/index>

‎api/output/esp8266-pwm.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ ESP8266 Software PWM
44
Software PWM for the ESP8266. Warning: This is a *software* PWM and therefore can have noticeable flickering.
55
Additionally, this software PWM can't output values higher than 80%. That's a known limitation.
66

7+
.. _esp8266_pwm-example_usage:
8+
79
Example Usage
810
-------------
911

0 commit comments

Comments
 (0)