From facb424b08d78ff6bbc9567c35a263f077eaed4f Mon Sep 17 00:00:00 2001 From: Otto Winter Date: Sat, 20 Oct 2018 15:10:26 +0200 Subject: [PATCH] Fix some typos (#65) --- _static/webserver-v1.css | 1 - _static/webserver-v1.js | 6 +++--- api/core/log.rst | 2 +- api/core/ota.rst | 1 - api/sensor/pulse_counter.rst | 10 +++++----- esphomeyaml/components/binary_sensor/pn532.rst | 2 +- esphomeyaml/components/esphomeyaml.rst | 2 +- esphomeyaml/components/fan/binary.rst | 2 +- esphomeyaml/components/fan/index.rst | 2 +- esphomeyaml/components/fan/speed.rst | 2 +- esphomeyaml/components/mqtt.rst | 2 +- esphomeyaml/components/output/index.rst | 2 +- esphomeyaml/components/power_supply.rst | 2 +- esphomeyaml/components/remote_receiver.rst | 2 +- esphomeyaml/components/sensor/custom.rst | 2 +- esphomeyaml/components/sensor/dht.rst | 2 +- esphomeyaml/components/sensor/hdc1080.rst | 2 +- esphomeyaml/components/sensor/hx711.rst | 2 +- esphomeyaml/components/sensor/index.rst | 2 +- esphomeyaml/components/sensor/ultrasonic.rst | 2 +- esphomeyaml/components/sensor/xiaomi_mijia.rst | 2 +- esphomeyaml/devices/sonoff_s20.rst | 2 +- esphomeyaml/guides/automations.rst | 14 +++++++------- esphomeyaml/guides/changelog.rst | 8 ++++---- esphomeyaml/guides/contributing.rst | 2 +- esphomeyaml/guides/faq.rst | 7 +------ .../guides/getting_started_command_line.rst | 4 ++-- esphomeyaml/guides/getting_started_hassio.rst | 4 ++-- web-api/index.rst | 4 ++-- 29 files changed, 45 insertions(+), 52 deletions(-) diff --git a/_static/webserver-v1.css b/_static/webserver-v1.css index 517d690b0..84bb3a0e7 100644 --- a/_static/webserver-v1.css +++ b/_static/webserver-v1.css @@ -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; } diff --git a/_static/webserver-v1.js b/_static/webserver-v1.js index a9f29a76e..0b4744a1c 100644 --- a/_static/webserver-v1.js +++ b/_static/webserver-v1.js @@ -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(); diff --git a/api/core/log.rst b/api/core/log.rst index 75e24046b..7c21b8bef 100644 --- a/api/core/log.rst +++ b/api/core/log.rst @@ -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 ------------- diff --git a/api/core/ota.rst b/api/core/ota.rst index 13abb1123..f0cfadce5 100644 --- a/api/core/ota.rst +++ b/api/core/ota.rst @@ -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(); diff --git a/api/sensor/pulse_counter.rst b/api/sensor/pulse_counter.rst index b52a848a1..e4cf8cd71 100644 --- a/api/sensor/pulse_counter.rst +++ b/api/sensor/pulse_counter.rst @@ -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 diff --git a/esphomeyaml/components/binary_sensor/pn532.rst b/esphomeyaml/components/binary_sensor/pn532.rst index fe7f59969..90070e1f4 100644 --- a/esphomeyaml/components/binary_sensor/pn532.rst +++ b/esphomeyaml/components/binary_sensor/pn532.rst @@ -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. diff --git a/esphomeyaml/components/esphomeyaml.rst b/esphomeyaml/components/esphomeyaml.rst index 3146b4adf..1ba7c3890 100644 --- a/esphomeyaml/components/esphomeyaml.rst +++ b/esphomeyaml/components/esphomeyaml.rst @@ -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 `. diff --git a/esphomeyaml/components/fan/binary.rst b/esphomeyaml/components/fan/binary.rst index 9ec794a8b..ee07165fe 100644 --- a/esphomeyaml/components/fan/binary.rst +++ b/esphomeyaml/components/fan/binary.rst @@ -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: diff --git a/esphomeyaml/components/fan/index.rst b/esphomeyaml/components/fan/index.rst index 5ac71282a..bd9ac9731 100644 --- a/esphomeyaml/components/fan/index.rst +++ b/esphomeyaml/components/fan/index.rst @@ -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 diff --git a/esphomeyaml/components/fan/speed.rst b/esphomeyaml/components/fan/speed.rst index d1694f153..5f208c236 100644 --- a/esphomeyaml/components/fan/speed.rst +++ b/esphomeyaml/components/fan/speed.rst @@ -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: diff --git a/esphomeyaml/components/mqtt.rst b/esphomeyaml/components/mqtt.rst index 765ed248c..2f7f3b02c 100644 --- a/esphomeyaml/components/mqtt.rst +++ b/esphomeyaml/components/mqtt.rst @@ -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: diff --git a/esphomeyaml/components/output/index.rst b/esphomeyaml/components/output/index.rst index 82f18763c..c4be23a44 100644 --- a/esphomeyaml/components/output/index.rst +++ b/esphomeyaml/components/output/index.rst @@ -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 diff --git a/esphomeyaml/components/power_supply.rst b/esphomeyaml/components/power_supply.rst index c10d6a881..d1ce29a3d 100644 --- a/esphomeyaml/components/power_supply.rst +++ b/esphomeyaml/components/power_supply.rst @@ -9,7 +9,7 @@ the output is not on. The power supply component can be attached to any :ref:`Output Component ` 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 diff --git a/esphomeyaml/components/remote_receiver.rst b/esphomeyaml/components/remote_receiver.rst index a3d8d5986..291c9b2ed 100644 --- a/esphomeyaml/components/remote_receiver.rst +++ b/esphomeyaml/components/remote_receiver.rst @@ -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. diff --git a/esphomeyaml/components/sensor/custom.rst b/esphomeyaml/components/sensor/custom.rst index 18ceb613d..423907c14 100644 --- a/esphomeyaml/components/sensor/custom.rst +++ b/esphomeyaml/components/sensor/custom.rst @@ -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 diff --git a/esphomeyaml/components/sensor/dht.rst b/esphomeyaml/components/sensor/dht.rst index 4ce3a2985..38bc7936d 100644 --- a/esphomeyaml/components/sensor/dht.rst +++ b/esphomeyaml/components/sensor/dht.rst @@ -8,7 +8,7 @@ The DHT Temperature+Humidity sensor allows you to use your DHT11 `adafruit `__), AM2302 (`datasheet `__, `adafruit `__) and RHT03 -(`datashet `__, +(`datasheet `__, `sparkfun `__) sensors with esphomelib. diff --git a/esphomeyaml/components/sensor/hdc1080.rst b/esphomeyaml/components/sensor/hdc1080.rst index 29817e6c8..729aac741 100644 --- a/esphomeyaml/components/sensor/hdc1080.rst +++ b/esphomeyaml/components/sensor/hdc1080.rst @@ -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. diff --git a/esphomeyaml/components/sensor/hx711.rst b/esphomeyaml/components/sensor/hx711.rst index 571f93ba6..79e4b0789 100644 --- a/esphomeyaml/components/sensor/hx711.rst +++ b/esphomeyaml/components/sensor/hx711.rst @@ -36,7 +36,7 @@ Configuration variables: - **clk_pin** (**Required**, :ref:`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 ` and :ref:`MQTT Component `. See Also diff --git a/esphomeyaml/components/sensor/index.rst b/esphomeyaml/components/sensor/index.rst index 382f371c6..2cfa91c3d 100644 --- a/esphomeyaml/components/sensor/index.rst +++ b/esphomeyaml/components/sensor/index.rst @@ -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 diff --git a/esphomeyaml/components/sensor/ultrasonic.rst b/esphomeyaml/components/sensor/ultrasonic.rst index b094d4475..e9b0dde1a 100644 --- a/esphomeyaml/components/sensor/ultrasonic.rst +++ b/esphomeyaml/components/sensor/ultrasonic.rst @@ -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 diff --git a/esphomeyaml/components/sensor/xiaomi_mijia.rst b/esphomeyaml/components/sensor/xiaomi_mijia.rst index 45d399031..2cb4e5a0f 100644 --- a/esphomeyaml/components/sensor/xiaomi_mijia.rst +++ b/esphomeyaml/components/sensor/xiaomi_mijia.rst @@ -85,7 +85,7 @@ See Also - :doc:`/esphomeyaml/components/sensor/xiaomi_miflora` - :doc:`/esphomeyaml/components/sensor/index` - :doc:`API Reference ` -- `Xiaomi Mijia BLE protocl `__ by `@mspider65 `__ +- `Xiaomi Mijia BLE protocol `__ by `@mspider65 `__ - `OpenMQTTGateway `__ by `@1technophile `__ - `Edit this page on GitHub `__ diff --git a/esphomeyaml/devices/sonoff_s20.rst b/esphomeyaml/devices/sonoff_s20.rst index c04341ce6..d002c5f5a 100644 --- a/esphomeyaml/devices/sonoff_s20.rst +++ b/esphomeyaml/devices/sonoff_s20.rst @@ -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. diff --git a/esphomeyaml/guides/automations.rst b/esphomeyaml/guides/automations.rst index 70b2f4b37..16f8fd882 100644 --- a/esphomeyaml/guides/automations.rst +++ b/esphomeyaml/guides/automations.rst @@ -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: diff --git a/esphomeyaml/guides/changelog.rst b/esphomeyaml/guides/changelog.rst index 3e6de9cee..1f728f0c5 100644 --- a/esphomeyaml/guides/changelog.rst +++ b/esphomeyaml/guides/changelog.rst @@ -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 blinking -- The :doc:`pulse counter sensor ` has been backported to the +- The :doc:`pulse counter sensor ` 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 ` 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 `__ for using esphomeyaml to create a simple wireless doorbell: diff --git a/esphomeyaml/guides/contributing.rst b/esphomeyaml/guides/contributing.rst index f9d7191ac..7dbcedae7 100644 --- a/esphomeyaml/guides/contributing.rst +++ b/esphomeyaml/guides/contributing.rst @@ -8,7 +8,7 @@ is hosted on GitHub and you can find the sources here: - `esphomeyaml `__ (The Python YAML to C++ transpiler) - `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 diff --git a/esphomeyaml/guides/faq.rst b/esphomeyaml/guides/faq.rst index 219f1ce89..183f44ff8 100644 --- a/esphomeyaml/guides/faq.rst +++ b/esphomeyaml/guides/faq.rst @@ -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 `__ 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 `__ -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: diff --git a/esphomeyaml/guides/getting_started_command_line.rst b/esphomeyaml/guides/getting_started_command_line.rst index dc62af03e..a46751c04 100644 --- a/esphomeyaml/guides/getting_started_command_line.rst +++ b/esphomeyaml/guides/getting_started_command_line.rst @@ -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 `__ installed (because of platformio 😕) and install the console script script through ``pip``. @@ -59,7 +59,7 @@ GPIO switch ` 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 diff --git a/esphomeyaml/guides/getting_started_hassio.rst b/esphomeyaml/guides/getting_started_hassio.rst index fe751817c..ce2e483e5 100644 --- a/esphomeyaml/guides/getting_started_hassio.rst +++ b/esphomeyaml/guides/getting_started_hassio.rst @@ -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 diff --git a/web-api/index.rst b/web-api/index.rst index f73430426..0d9675e2e 100644 --- a/web-api/index.rst +++ b/web-api/index.rst @@ -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