Commit Graph

87 Commits

Author SHA1 Message Date
Wauter
d2dec1923b
Documentation for templated output (#641)
* - Creating documentation for templated output
- Adding template output to the main index page

* Update components/output/template.rst

* fixed bad cookbook link

Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>
2020-06-13 19:35:55 -03:00
ryanalden
b300dd373d
Adding ESP32 leak detector cookbook (#568) 2020-06-12 22:09:22 -03:00
Fabian Affolter
4906a02e86
Rename to Home Assistant (#642)
* Rename to Home Assistant

* Upate titles
2020-06-09 21:25:51 -03:00
Matthew Edwards
9b6170ac60
Fix typos (#561) 2020-05-10 16:27:59 -03:00
Tommy Jonsson
00abf8b483
ifan02 cookbook (#218)
* ifan02 cookbook

* removed spaces

* removed spaces

* indent codeblock, newline at end

* fixes

* add seo :image:

* spaces...

* Complete the example code & fix compilation errors

Tried compiling this code today using ESPHome 1.13.6.. it would not compile. 

* The ifan02.h file was the main culprit and I was able to fix the issue.

* The .yaml example was missing a few declarations at the beginning so I added them.
* I fixed an error related to using ```light``` for the light id since that is a reserved name.
* I added an ```on_boot``` declaration to turn off the light as early as possible after power is restored. (if mains power is restored in the middle of the night and the light turns on while you are sleeping it can be quite annoying, this turns it off during the boot process).

* removed blank spaces on line 66

Those blank spaces get me every time ;-)

* fix doc links (hopefully)

I think my last PR was made against the wrong fork/branch/etc... sorry, I'm still learning github.
I currently have the time and really want to see this make it into the cookbook. I think if you add me as a collaborator I would be able to push the changes and help get the errors sorted more quickly; if not, no worries, I'll take no offense and do my best to continue helping as we are doing now.

* fix fan link

replace
```
:doc:`/components/fan`
```
with
```
:doc:`/components/fan/index`
```

Co-authored-by: mjoshd <35782597+mjoshd@users.noreply.github.com>
Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>
2020-04-05 13:49:52 -03:00
Ben Suffolk
b3d811d5a3 Cookbook for Sonoff Light Switches (#407)
* Cookbook for Sonoff Light Switches

Cookbook for various Sonoff Light Switch options including Basic, Dual and T1-3

* Removed references to myself

All references to I have been removed and re worded into a more generic text

* Fixed Formatting issues to Pass Travis Checks

* Update cookbook/sonoff-basic-light-switch.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/sonoff-dual-light-switch.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/sonoff-dual-light-switch.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/sonoff-dual-light-switch.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/sonoff-dual-light-switch.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/sonoff-dual-light-switch.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/sonoff-dual-light-switch.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/sonoff-dual-light-switch.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/sonoff-dual-light-switch.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* YAML updates

Removed fast_connect, UART swotches from Dual R1, and reference to an issue that no longer exists
2019-11-29 18:27:26 +01:00
Otto Winter
98fee94118
DIY Examples page (#395) 2019-11-02 15:48:35 +01:00
Otto Winter
b2de20cf32
PZEM/VL53L0x/ADE7953 docs 2019-10-20 19:35:37 +02:00
Otto Winter
6b8177668b
Make dfplayer page match integration name 2019-10-20 19:35:37 +02:00
Thomas Eckerstorfer
2469943bb7
AS3935 Lightning sensor (#294)
* Added TX20/TX23 sensor documentation

* Update tx20.rst

* updated documentation to new structure for tx20

* added missing files

* fixed missing newline

* fixed/updated documentation

* added as3935 sensor

* Update as3935.rst

* Update as3935.rst

* Undo change

* Shrink image


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-20 19:30:12 +02:00
Michiel van Turnhout
d5bb10924b
SX1509 device documentation (#315)
* add sx1509 docs

* add table

* sx1509 docs

* added to index

* fixed table

* text fixes

* Formatting

* Use standardized section header keys

* Spelling

* Properly size index file

* Use short name for index page (table view)

* fixed review issues

* Add API Reference


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-20 19:30:12 +02:00
Samuel Sieb
111a40a7b6
Add documentation for new Tuya dimmer component (#353)
* Add documentation for new Tuya dimmer component

* add more info and change configuration names

* Rename file to match platform name

* Move default gamma_correct/transition_length handling to code


Co-authored-by: Samuel Sieb <samuel@sieb.net>
Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-20 19:30:11 +02:00
Guillermo Ruffino
ec78f828fb
Add DFPlayer docs (#306)
* Add DFPlayer docs

* lint


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-20 19:30:11 +02:00
Nad
b8edd462b7
Add documentation for STS3x Temperature sensors (#300)
* Add documentation for STS3x Temperature sensors

* Updated formatting

* Updated index and other temperature sensors with link to STS3x sensor

* Added STS31 sensor photo

* Updated documentation with flattened config.

* Remove from some pages

Those sensors aren't really similar to this one, so removing them

* Remove references

Same, plus I don't want to fix all the merge conflicts


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-20 19:30:11 +02:00
Nad
2552e8070e
Add documentation for SHTCx Temperature sensors (#305)
* Add documentation for STS3x Temperature sensors

* Updated formatting

* Updated index and other temperature sensors with link to STS3x sensor

* Added STS31 sensor photo

* Add documentation for SHTCx Temperature sensors

* Fixed reference to a sensor thumbnail

* Cleaned up changes leaked from STS3x feature

* Remove references on other pages

It's already getting too cluttered...

* Remove references


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-20 19:30:10 +02:00
Nad
34f6817423
Add documentation for SGP30 eCO2 and TVOC sensors (#308)
* Add documentation for SGP30 eCO2 and TVOC sensors

* Fixed image path and identation error;

* Fixet bullet block

* Updated SGP30 documentation for configuring Temperature and Humidity compensation sources; Removed uptime sensor

* Compress sgp30.png

* Fix build errors

* Remove uptime mention


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-20 19:30:10 +02:00
Evan Coleman
d8d5e81a7d
Add documentation for SSD1325 OLED displays (#347)
* add ssd1325 docs

* Fix line length

* Fix duplicate target name warning

* Reduce image size


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-20 19:30:10 +02:00
Otto Winter
471c9f773a
Merge branch 'current' into beta 2019-10-20 19:29:31 +02:00
Guillermo Ruffino
9e003f2010
Cookbook ape (#334)
* cookbook-ape

* Optimize SVG

* Update cookbook/arduino_port_extender.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/arduino_port_extender.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/arduino_port_extender.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update cookbook/arduino_port_extender.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* updates

* fixed indents

* whitespace

* whitespace

* Minor corrections
2019-10-19 17:24:47 -03:00
cryptelli
52cbfe59cd Cookbook Guide for Zemismart LED RGBW Downlights (#297)
* Cookbook Guide for Zemismart LED RGBW Downlights

* Linting
2019-10-19 22:18:52 +02:00
Otto Winter
d2f1c23ebf
Merge branch 'current' into next 2019-10-19 17:07:29 +02:00
Nikolay Vasilchuk
1b1f06056f SenseAir S8 CO2 sensor support (#330)
* Docs

* CI fix
2019-10-17 21:37:56 +02:00
TomFahey
efec2a7fbf Updated MCP23017 Component To Cover 8 & 16 Port Chips (#277)
* Updated MCP23017 Component To Cover 8 & 16 Port Chips

* Made requested changes, adding short paragraph at top of MCP230xx.rst
explaining the page is for MCP23008 and MCP23017, also deleted now
obsolete MCP23017.rst

* Added separate sections for MCP23017, MCP23008

* Remove MCP23017 page (merged with new one)


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-17 16:28:53 +02:00
Nebula
c66462a2fb Added cookbook for Teckin SB50 Bulb (#360)
* Added cookbook for Teckin SB50 Bulb

* Added comments to YAML file


Co-authored-by: root <root@centos.nebula.local>
2019-10-17 14:06:16 +02:00
Alexander Leisentritt
9ff3e95aab Xiaomi refactor (#361)
* refactored xiaomi sensors

* sorted xiaomi sensor alphabetically

* updated xiaomi docs to mention marketing names

* fixed old changelog

* fix ref links

* fix bar length
2019-10-16 13:30:31 +02:00
Sergio Mayoral Martínez
8834354dd8 Add Xiaomi Cleargrass Sensor Documentation (#346)
* Add index for new Xiaomi ClearGrass E-Ink Sensor

* Add Xiaomi Cleargrass Sensor Documentation

Add all the needed documentation, such as index,
references and main page of this sensor

* Fix images width

Adjust images width to a better fit in the page

* Fix apiref of Xiaomi Sensors

The apiref of Cleargrass and LYWSD02 models point
to the mijia's api, so I fix this

* Fix Xiaomi Cleargrass documentation mistake

Line 43 of xiaomi_cleargrass.rst references to
Xiaomi Mijia's sensor. It should reference to
Xiaomi Cleargrass.

Also I change titles of this sensor in order to
avoid the title uses 2 lines
2019-10-14 13:25:04 +02:00
Levente Tamas
ac28efde9c ADD TLC59208F documentation (#338) 2019-10-14 11:38:20 +02:00
Otto Winter
c5ee042d56
Merge branch 'next' of https://github.com/esphome/esphome-docs into next 2019-09-01 11:24:35 +02:00
Nad
1e4660f023 Add documentation for Sensirion SCD30 CO2 sensors (#333)
* Add documentation for Sensirion SCD30 CO2 sensors

* Minor text fixes and photo optimization
2019-08-31 19:24:41 +02:00
mr G1K
87327c6b34 LYWSD02 docs (#292)
* Add xiaomi_lywsd02

* Fix, Title underline too short.

* Fix, img link
2019-08-29 15:42:42 +02:00
Otto Winter
8d91d657dc
Updates 2019-07-28 12:41:15 +02:00
Otto Winter
da052a7838
Merge branch 'current' into next 2019-07-03 17:35:48 +02:00
Jonathan Jefferies
40aaaf9e09 Add description next to title (#227)
There wasn't really a description anwhere of what ESPHome actually is.
2019-07-03 16:48:49 +02:00
Thomas Eckerstorfer
9bbfbb6956 Added TX20/TX23 sensor documentation (#150)
* Added TX20/TX23 sensor documentation

* Update tx20.rst

* updated documentation to new structure for tx20

* added missing files

* fixed missing newline

* fixed/updated documentation
2019-07-03 16:41:16 +02:00
Nikolay Vasilchuk
ec4ecf6b71 ZyAura CO2 / Temperature / Humidity Sensor (#281)
* Docs ready

* Small fix

* Small fix

* Update components/sensor/zyaura.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update components/sensor/zyaura.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Review fix

* Update components/sensor/zyaura.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>
2019-07-03 16:00:04 +02:00
Guillermo Ruffino
77e2ad4886 Add SIM800L docs (#257)
* Add SIM800L docs

* Update components/sim800l.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update components/sim800l.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update components/sim800l.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* review and adding getting started

* Updates

* Update components/sim800l.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* Update components/sim800l.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>
2019-06-17 16:58:16 +02:00
Andrew Thompson
56e505fc0d Add docs for atm90e32 sensor (#271)
* Add docs for atm90e32 sensor

* Correct name for CT4

* fix title bar length

* use correct subsubsections chars

* add newlines before figure

* Update components/sensor/atm90e32.rst

Co-Authored-By: Otto Winter <otto@otto-winter.com>

* move required setting to top

* Update atm90e32.rst

Add note about SPI, and fix line_freq


Co-authored-by: Andrew Thompson <andrew@whosonlocation.com>
Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-06-16 15:23:12 +02:00
Mario Di Raimondo
0a3ad5416f Add Yashima Climate component docs (#275)
* new yashima climate component docs

* updated main index
2019-06-15 18:01:08 +02:00
Kevin Lewis
2f8e05b88a Add documentation for SM16716 output component. (#217)
* Add documentation for SM16716 output component.

It still needs the sm16716.svg image file.

* Remove update on boot documentation.

* Update sm16716.rst

* Create sm16716.svg

* Lint
2019-05-31 15:06:16 +02:00
Jesse Hills
441e4b44a0
Add docs for CT Clamp (#256)
* Add docs for CT Clamp

* Fix title bar

* Fix reference

* 2 many changes

* Update docs for new configuration

* Compress index image

* Update for config changes

- Also remove 3.3V message, because if the user needs to calibrate anyway, then the 3.3V is also part of the calibration process.
- Use calibrate_linear instead of multiply, more user-friendly
- Update SEO image
-


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-05-29 11:22:16 +02:00
Jesse Hills
961bf33861 Add docs for CT Clamp (#256)
* Add docs for CT Clamp

* Fix title bar

* Fix reference

* 2 many changes

* Update docs for new configuration

* Compress index image

* Update for config changes

- Also remove 3.3V message, because if the user needs to calibrate anyway, then the 3.3V is also part of the calibration process.
- Use calibrate_linear instead of multiply, more user-friendly
- Update SEO image
-


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-05-29 11:15:12 +02:00
Michiel van Turnhout
bb6c1ce6a7
Documentation for binary_sensor_map (#199)
* Add mpr121 docs and images

* add images

* update mpr121 docs

* Title bar same length as text

* wrong size and location

* wrong size and location

* wrong location

* wrong size and location

* wrong size and location

* Added binary_sensor_map

* tabs to spaces

* added to index

* add image

* text changes

* remove linefeed

* image is jpg not png

* preview fail??

* Update binary_sensor_map.rst

- Make use case and function more clear
- Remove options that do not exist yet.
- Fix incorrect sensor link in configuration variables
- Fix required values labeled optional
- Less literal text with backslash. Was hard to read.
- Move config example essential part up.
- Remove disqus

* Update binary_sensor_map.rst

* Fix


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-05-28 21:37:34 +02:00
Michiel van Turnhout
57a4a4f3a8 Documentation for binary_sensor_map (#199)
* Add mpr121 docs and images

* add images

* update mpr121 docs

* Title bar same length as text

* wrong size and location

* wrong size and location

* wrong location

* wrong size and location

* wrong size and location

* Added binary_sensor_map

* tabs to spaces

* added to index

* add image

* text changes

* remove linefeed

* image is jpg not png

* preview fail??

* Update binary_sensor_map.rst

- Make use case and function more clear
- Remove options that do not exist yet.
- Fix incorrect sensor link in configuration variables
- Fix required values labeled optional
- Less literal text with backslash. Was hard to read.
- Move config example essential part up.
- Remove disqus

* Update binary_sensor_map.rst

* Fix


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-05-28 20:41:02 +02:00
Otto Winter
639f095393
Add NTC/resistance sensor docs
Ref https://github.com/esphome/esphome/pull/560
2019-05-28 15:43:56 +02:00
Guillermo Ruffino
57f73adc47 Add Coolix Tcl112 Climate (#247)
* Add Coolix Tcl112 Climate

* Update coolix.rst

* Update tcl112.rst

* Update coolix.rst

* Update tcl112.rst


Co-authored-by: Guillermo Ruffino <guillermo.ruffino@pampatech.net>
Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-05-27 20:18:50 +02:00
Teemu Mikkonen
ed800a9fa0 Documentation for AM2320 component (#249)
* Added documentation for AM2320

* Added new files for AM2320

* Fixed too long row

* Update am2320.rst


Co-authored-by: Mikkonen Teemu <teemu.mikkonen@iki.fi>
Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-05-27 20:03:33 +02:00
Otto Winter
367e8576bc
Pulse Width 2019-05-25 09:08:05 +02:00
Otto Winter
fb22c082c8
Custom stuff 2019-05-15 10:54:51 +02:00
Otto Winter
52cd23c733
Remote + Dev docs update 2019-05-13 21:51:04 +02:00
Otto Winter
ef49ff813d
CCS811, GPS, TTP229-BSF 2019-05-13 13:10:12 +02:00