Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix some typos (#65)

This commit is contained in:
Otto Winter 2018-10-20 15:10:26 +02:00 committed by GitHub
parent 09b2374aef
commit facb424b08
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
29 changed files with 45 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_static/webserver-v1.css
View File

@ -7,7 +7,6 @@
color: #24292e;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-size: 16px;
line-height: 1.5;
word-wrap: break-word;
}

6
_static/webserver-v1.js
View File

@ -31,7 +31,7 @@ let i = 0, row;
for (; row = states.rows[i]; i++) {
if (row.classList.contains("switch")) {
(function(id) {
row.children[2].children[0].addEventListener('click', function (e) {
row.children[2].children[0].addEventListener('click', function () {
const xhr = new XMLHttpRequest();
xhr.open("POST", '/switch/' + id.substr(7) + '/toggle', true);
xhr.send();
@ -40,7 +40,7 @@ for (; row = states.rows[i]; i++) {
}
if (row.classList.contains("fan")) {
(function(id) {
row.children[2].children[0].addEventListener('click', function (e) {
row.children[2].children[0].addEventListener('click', function () {
const xhr = new XMLHttpRequest();
xhr.open("POST", '/fan/' + id.substr(4) + '/toggle', true);
xhr.send();
@ -49,7 +49,7 @@ for (; row = states.rows[i]; i++) {
}
if (row.classList.contains("light")) {
(function(id) {
row.children[2].children[0].addEventListener('click', function (e) {
row.children[2].children[0].addEventListener('click', function () {
const xhr = new XMLHttpRequest();
xhr.open("POST", '/light/' + id.substr(6) + '/toggle', true);
xhr.send();

2
api/core/log.rst
View File

@ -1,7 +1,7 @@
Logging Engine
==============
esphomelib will by default log to both Serial (with baudrate 115200).
esphomelib will by default log to both Serial (with baud rate 115200).
API Reference
-------------

1
api/core/ota.rst
View File

@ -16,7 +16,6 @@ Example Usage
ota->start_safe_mode();
// OTA MD5 password
auto *ota = App.init_ota();
ota->set_auth_password_hash("761d3a8c46989f1d357842e8dedf7712");
ota->start_safe_mode();

10
api/sensor/pulse_counter.rst
View File

@ -12,12 +12,12 @@ Example Usage
.. code-block:: cpp
// Basic
App.make_pulse_counter_sensor("Stromverbrauch Wärmepumpe", 13);
App.make_pulse_counter_sensor("Pulse Counter", 13);
// Unit conversion
auto strom_warme = App.make_pulse_counter_sensor("Stromverbrauch Wärmepumpe", 13);
strom_warme.pcnt->set_unit_of_measurement("kW");
strom_warme.pcnt->clear_filters();
strom_warme.pcnt->add_multiply_filter(0.06f); // convert from Wh pulse to kW
auto pcnt_1 = App.make_pulse_counter_sensor("Pulse Counter 2", 13);
pcnt_1.pcnt->set_unit_of_measurement("kW");
pcnt_1.pcnt->clear_filters();
pcnt_1.pcnt->add_multiply_filter(0.06f); // convert from Wh pulse to kW
.. cpp:namespace:: nullptr

2
esphomeyaml/components/binary_sensor/pn532.rst
View File

@ -30,7 +30,7 @@ See :doc:`/esphomeyaml/components/pn532` for instructions for setting up the con
Configuration variables:
------------------------
- **uid** (**Required**, string): The unique ID of the NFC/RFID tag. This is a hypen-separated list
- **uid** (**Required**, string): The unique ID of the NFC/RFID tag. This is a hyphen-separated list
of hexadecimal values. For example ``74-10-37-94``.
- **name** (**Required**, string): The name of the binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.

2
esphomeyaml/components/esphomeyaml.rst
View File

@ -186,7 +186,7 @@ Configuration variables:
- ``7.5``: MQTT initialization takes place at this priority.
- ``0.0``: This is where most sensors are set up. They are usually set up this late so that they can dump their
configuration in the MQTT logs.
- ``-5.0``: The inidividual frontend counterparts for the backend components are configured at this priority
- ``-5.0``: The individual frontend counterparts for the backend components are configured at this priority
- ``-10.0``: At this priority, pretty much everything should already be initialized.
- See :ref:`Automation <automation>`.

2
esphomeyaml/components/fan/binary.rst
View File

@ -12,7 +12,7 @@ The ``binary`` fan platform lets you represent any binary :ref:`output` as a fan
# Example configuration entry
fan:
- platform: binary
output: myoutput_1
output: my_output_1
name: "Living Room Fan"
Configuration variables:

2
esphomeyaml/components/fan/index.rst
View File

@ -25,7 +25,7 @@ Configuration variables:
- **name** (**Required**, string): The name of the fan.
- **oscillation_state_topic** (*Optional*, string): The topic to
publish fan oscillaiton state changes to.
publish fan oscillation state changes to.
- **oscillation_command_topic** (*Optional*, string): The topic to
receive oscillation commands on.
- **speed_state_topic** (*Optional*, string): The topic to publish fan

2
esphomeyaml/components/fan/speed.rst
View File

@ -13,7 +13,7 @@ supports speed settings.
# Example configuration entry
fan:
- platform: speed
output: myoutput_1
output: my_output_1
name: "Living Room Fan"
Configuration variables:

2
esphomeyaml/components/mqtt.rst
View File

@ -124,7 +124,7 @@ still appearing in Home Assistant’s front-end. This is because in order
to have Home Assistant “discover” your devices on restart, all discovery
MQTT messages need to be retained. Therefore the old entities will also
re-appear on every Home Assistant restart even though they’re in
eshomeyaml anymore.
esphomeyaml anymore.
To fix this, esphomeyaml has a simple helper script that purges stale
retained messages for you:

2
esphomeyaml/components/output/index.rst
View File

@ -20,7 +20,7 @@ Each output platform extends this configuration schema.
# Example configuration entry
output:
- platform: ...
id: myoutput_id
id: my_output_id
power_supply: power_supply_id
inverted: False
max_power: 0.75

2
esphomeyaml/components/power_supply.rst
View File

@ -9,7 +9,7 @@ the output is not on. The power supply component can be attached to any
:ref:`Output Component <output>` and
will automatically switch on if any of the outputs are on. Furthermore,
it also has a cooldown time that keeps the power supply on for a while
after the last ouput has been disabled.
after the last output has been disabled.
.. code:: yaml

2
esphomeyaml/components/remote_receiver.rst
View File

@ -32,7 +32,7 @@ Configuration variables:
- **rc_switch**: Decode and dump RCSwitch RF codes.
- **raw**: Print all remote codes in their raw form. Useful for using arbitrary protocols.
- **tolerance** (*Optional*, int): The percentage that the remote signal lengths can devicate in the
- **tolerance** (*Optional*, int): The percentage that the remote signal lengths can deviate in the
decoding process. Defaults to ``25%``.
- **buffer_size** (*Optional*, int): The size of the internal buffer for storing the remote codes. Defaults to ``10kb``
on the ESP32 and ``1kb`` on the ESP8266.

2
esphomeyaml/components/sensor/custom.rst
View File

@ -4,7 +4,7 @@ Custom Sensor Component
.. warning::
While I do try to keep the esphomeyaml configuration options as stable as possible
and backport them, the esphomelib API is less stable. If something in the APIs needs
and back-port them, the esphomelib API is less stable. If something in the APIs needs
to be changed in order for something else to work, I will do so.
So, you just set up esphomelib for your ESP32/ESP8266, but sadly esphomelib is missing a sensor integration

2
esphomeyaml/components/sensor/dht.rst
View File

@ -8,7 +8,7 @@ The DHT Temperature+Humidity sensor allows you to use your DHT11
`adafruit <https://www.adafruit.com/product/385>`__), AM2302
(`datasheet <https://cdn-shop.adafruit.com/datasheets/Digital+humidity+and+temperature+sensor+AM2302.pdf>`__,
`adafruit <https://www.adafruit.com/product/393>`__) and RHT03
(`datashet <https://cdn.sparkfun.com/datasheets/Sensors/Weather/RHT03.pdf>`__,
(`datasheet <https://cdn.sparkfun.com/datasheets/Sensors/Weather/RHT03.pdf>`__,
`sparkfun <https://cdn.sparkfun.com/datasheets/Sensors/Weather/RHT03.pdf>`__)
sensors with esphomelib.

2
esphomeyaml/components/sensor/hdc1080.rst
View File

@ -49,7 +49,7 @@ Configuration variables:
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``15s``.
See :ref:`sensor-default_filter`.
Currently, the platform doesn’t support activating the built-in heater,
Currently, the platform doesn't support activating the built-in heater,
as it seems to only be rarely of use. If you need it, please open an
issue.

2
esphomeyaml/components/sensor/hx711.rst
View File

@ -36,7 +36,7 @@ Configuration variables:
- **clk_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The CLK pin.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``15s``.
See :ref:`sensor-default_filter`.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for codegeneration.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
See Also

2
esphomeyaml/components/sensor/index.rst
View File

@ -77,7 +77,7 @@ Automations:
Sensor Filters
--------------
esphomeyaml/esphomelib allow you to do some basic preprocessing of
esphomeyaml/esphomelib allow you to do some basic pre-processing of
sensor values before they’re sent to Home Assistant. This is for example
useful if you want to apply some average over the last few values to
relief Home Assistant’s state machine and keep the history graphs in the

2
esphomeyaml/components/sensor/ultrasonic.rst
View File

@ -14,7 +14,7 @@ pulse** on a specific pin and will send out a **echo pulse** once a
measurement has been taken. Because sometimes (for example if no object
is detected) the echo pulse is never returned, this sensor also has a
timeout option which specifies how long to wait for values. During this
timeout period the whole core will be blocked and therefore shouldn’t be
timeout period the whole core will be blocked and therefore shouldn't be
set too high.
.. figure:: images/ultrasonic-full.jpg

2
esphomeyaml/components/sensor/xiaomi_mijia.rst
View File

@ -85,7 +85,7 @@ See Also
- :doc:`/esphomeyaml/components/sensor/xiaomi_miflora`
- :doc:`/esphomeyaml/components/sensor/index`
- :doc:`API Reference </api/misc/esp32_ble_tracker>`
- `Xiaomi Mijia BLE protocl <https://github.com/mspider65/Xiaomi-Mijia-Bluetooth-Temperature-and-Humidity-Sensor>`__ by `@mspider65 <https://github.com/mspider65>`__
- `Xiaomi Mijia BLE protocol <https://github.com/mspider65/Xiaomi-Mijia-Bluetooth-Temperature-and-Humidity-Sensor>`__ by `@mspider65 <https://github.com/mspider65>`__
- `OpenMQTTGateway <https://github.com/1technophile/OpenMQTTGateway>`__ by `@1technophile <https://github.com/1technophile>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/xiaomi_mijia.rst>`__

2
esphomeyaml/devices/sonoff_s20.rst
View File

@ -311,7 +311,7 @@ Step 6: Finishing Up
--------------------
Now you're pretty much done with setting up the Sonoff S20. The only steps left are to
remove any cables within the housing and make sure everyhing in there is clean. If, for
remove any cables within the housing and make sure everything in there is clean. If, for
example, you used wires to connect the UART console, you should definitely remove them to avoid
a short with mains.

14
esphomeyaml/guides/automations.rst
View File

@ -4,7 +4,7 @@ Automations And Templates
=========================
Automations and templates are two very powerful concepts of esphomelib/yaml. Automations
allow you to perfom actions under certain conditions and templates are a way to easily
allow you to perform actions under certain conditions and templates are a way to easily
customize everything about your node without having to dive into the full esphomelib C++
API.
@ -15,18 +15,18 @@ Let's begin with an example to explain these concepts. Suppose you have this con
switch:
- platform: gpio
pin: GPIO3
name: "Living Room Dehumidifer"
name: "Living Room Dehumidifier"
binary_sensor:
- platform: gpio
pin: GPIO4
name: "Living Room Dehumidifer Toggle Button"
name: "Living Room Dehumidifier Toggle Button"
With this file you can already perform some basic tasks. You can control the ON/OFF state
of the dehumidifer in your livingroom from Home Assistant's front-end. But in many cases,
of the dehumidifier in your living room from Home Assistant's front-end. But in many cases,
controlling everything strictly from the frontend is quite a pain. That's why you have
decided to also install a simple push button next to the dehumidifer on pin GPIO4.
A simple push on this button should toggle the state of the dehumidifer.
decided to also install a simple push button next to the dehumidifier on pin GPIO4.
A simple push on this button should toggle the state of the dehumidifier.
You *could* write an automation to do this task in Home Assistant's automation engine, but
ideally the IoT should work without an internet connection and should not break without
@ -49,7 +49,7 @@ For example, this configuration would achieve your desired behavior:
binary_sensor:
- platform: gpio
pin: GPIO4
name: "Living Room Dehumidifer Toggle Button"
name: "Living Room Dehumidifier Toggle Button"
on_press:
then:
- switch.toggle:

8
esphomeyaml/guides/changelog.rst
View File

@ -182,7 +182,7 @@ Other notable changes
- Fixed ESP32BLETracker surpassing the maximum code size
- Fixed ESP32BLETracker/Beacon throwing an exception when a warning occurs.
- Fixed FastLED effects not taking into account the light brightness
- Fixed compatability with Arduino core versions below 2.0.4
- Fixed compatibility with Arduino core versions below 2.0.4
- Added ``output.turn_on``, ``output.turn_off`` and ``output.set_level`` actions.
- Fixed the remote transmitter/receiver using the heap inefficiently on the ESP8266 (was causing reboots)
- Fixed reliability with reading data from BME280s
@ -358,7 +358,7 @@ New Components
<span class="blink-tag">blinking</span>
- The :doc:`pulse counter sensor </esphomeyaml/components/sensor/pulse_counter>` has been backported to the
- The :doc:`pulse counter sensor </esphomeyaml/components/sensor/pulse_counter>` has been back-ported to the
ESP8266, so now you can observe the number of pulses and frequency on any pin 🔢
- A new :doc:`duty cycle sensor </esphomeyaml/components/sensor/duty_cycle>` has been added, allowing you to
@ -461,7 +461,7 @@ Other Contributions
- Remove BMP280 (doesn't work) (`esphomedocs/#8`_) by `@fabaff`_
- Passing inverted to output should be valid, but does not work, use … (`esphomedocs/#7`_) by `@aequitas`_
- Make the example configuration entry copy&paste-friendly (`esphomedocs/#6`_) by `@fabaff`_
- Minor formatting tweaks. (`esphomedocs/#4`_) by `@Landradsh`_
- Minor formatting tweaks. (`esphomedocs/#4`_) by `@Landrash`_
- Details about Sonoff basic (`esphomedocs/#3`_) by `@fabaff`_
- Add missing module (`esphomedocs/#2`_) by `@fabaff`_
- Fix unit name (`esphomedocs/#1`_) by `@fabaff`_
@ -496,7 +496,7 @@ Other Contributions
.. _@fabaff: https://github.com/fabaff
.. _@brandond: https://github.com/brandond
.. _@r-jordan: https://github.com/r-jordan
.. _@Landradsh: https://github.com/Landradsh
.. _@Landrash: https://github.com/Landrash
And last but not least, check out this awesome video by `The Hook Up <https://www.youtube.com/channel/UC2gyzKcHbYfqoXA5xbyGXtQ>`__
for using esphomeyaml to create a simple wireless doorbell:

2
esphomeyaml/guides/contributing.rst
View File

@ -8,7 +8,7 @@ is hosted on GitHub and you can find the sources here:
- `esphomeyaml <https://github.com/OttoWinter/esphomeyaml>`__ (The Python YAML to C++ transpiler)
- `esphomedocs <https://github.com/OttoWinter/esphomedocs>`__ (The documentation which you're reading here)
Just clone the repository locally, do the changes for your new feature/bugfix and submit
Just clone the repository locally, do the changes for your new feature/bug fix and submit
a pull request. I will try to take a look at your PR as soon as possible.
Contributing to esphomedocs

7
esphomeyaml/guides/faq.rst
View File

@ -56,11 +56,6 @@ esphomeyaml generates and insert your own custom components such as sensors in i
a sensor you really want to use, is not supported, you can easily `create a custom component
<https://github.com/OttoWinter/esphomelib/wiki/Custom-Sensor-Component>`__ for it.
Because esphomeyaml runs on a host with lots of resources (as opposed to the ESP node itself),
esphomeyaml will in the future also be able to do some really powerful stuff. I have some ideas
like having an automatic schematic creator or a simple `blockly-like <https://developers.google.com/blockly/>`__
in mind that will hopefully make the user-experience of using ESP32/ESP8266 nodes a lot easier.
Help! Something's not working!1!
--------------------------------
@ -159,7 +154,7 @@ My node keeps reconnecting randomly
-----------------------------------
Jep, that's a known issue. However, it seems to be very low-level and I don't really know
how to solve it. I'm working on possible work-arounds for the issue but currently I do
how to solve it. I'm working on possible workarounds for the issue but currently I do
not have a real solution.
Some steps that can help with the issue:

4
esphomeyaml/guides/getting_started_command_line.rst
View File

@ -8,7 +8,7 @@ basic “node” in a few simple steps.
Installation
------------
Installing epshomeyaml is very easy. All you need to do is have `Python
Installing esphomeyaml is very easy. All you need to do is have `Python
2.7 <https://www.python.org/download/releases/2.7/>`__ installed
(because of platformio 😕) and install the console script script through
``pip``.
@ -59,7 +59,7 @@ GPIO switch </esphomeyaml/components/switch/gpio>` to our app.
switch:
- platform: gpio
name: "Living Room Dehumidifer"
name: "Living Room Dehumidifier"
pin: 5
The configuration format should hopefully immediately seem similar to

4
esphomeyaml/guides/getting_started_hassio.rst
View File

@ -15,7 +15,7 @@ Assistant's UI.
Installation
------------
Installing the epshomeyaml HassIO add-on is easy. Just navigate to the HassIO
Installing the esphomeyaml HassIO add-on is easy. Just navigate to the HassIO
panel in your Home Assistant frontend and add the esphomeyaml add-on repository:
https://github.com/OttoWinter/esphomeyaml
@ -104,7 +104,7 @@ to the configuration like this:
switch:
- platform: gpio
name: "Living Room Dehumidifer"
name: "Living Room Dehumidifier"
pin: 5
In above example, we're simply adding a switch that's called "Living Room Relay" (could control

4
web-api/index.rst
View File

@ -115,8 +115,8 @@ Switch
Switches have the exact same properties as a binary sensor in the state reporting aspect, but they
additionally support setting states with the ``turn_on``, ``turn_off`` and ``toggle`` methods.
Each of these is quite self explanatory. Creating a POST request to ``/switch/dehumidifer/turn_on``
would for example result in the component called "Dehumidifer" to be turned on. The server will respond
Each of these is quite self explanatory. Creating a POST request to ``/switch/dehumidifier/turn_on``
would for example result in the component called "Dehumidifier" to be turned on. The server will respond
with a 200 OK HTTP return code if the call succeeded.
Light