Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-02-24 03:02:12 +01:00
Code Issues Projects Releases Wiki Activity

format-fixes (#1169)

Browse Source 
* Update bh1750 docs

* format fixes

* more format fixes

Co-authored-by: Yuval Aboulafia <yuval.abou@gmail.com>
This commit is contained in:
Guillermo Ruffino 2021-05-14 20:31:31 -03:00 committed by GitHub
parent 88c850959a
commit d8646a5f7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 82 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
components/ble_client.rst
View File

@ -44,8 +44,8 @@ client devices.
Configuration variables:
------------------------
- **mac_address** (*Required*, MAC Address): The MAC address of the BLE device to connect to.
- **id** (*Required*, :ref:`config-id`): The ID to use for code generation, and for reference by dependent components.
- **mac_address** (**Required**, MAC Address): The MAC address of the BLE device to connect to.
- **id** (**Required**, :ref:`config-id`): The ID to use for code generation, and for reference by dependent components.
Automations:
@ -139,14 +139,14 @@ Once the connection is established, referencing each
service/characteristic/descriptor by the full UUID would take a
considerable portion of the small (~23 byte) packet. So the
characteristics and descriptors also provide a small 2-byte
*handle* (alias) to maximise available data space.
*handle* (alias) to maximize available data space.
Setting Up Devices
------------------
Whilst the component can connect to most BLE devices (that do not
require authentication/pin), useful functionality is only obtained
through dependent components, such as :doc:`/components/sensor/ble_sensor`.
through dependent components, such as :doc:`/components/sensor/ble_client`.
See the documentation for these components for details on setting up
specific devices.
@ -203,12 +203,12 @@ display them in the log:
The discovered services can then be used to enable and configure other
ESPHome components, for example Service UUID 0xFFE0 is used for iTag style
keychain button events, used by the :doc:`/components/sensor/ble_sensor` component.
keychain button events, used by the :doc:`/components/sensor/ble_client` component.
See Also
--------
- :doc:`/components/sensor/ble_sensor`
- :doc:`/components/sensor/ble_client`
- :ref:`Automation <automation>`
- :apiref:`ble_client/ble_client.h`
- :ghedit:`Edit`

8
components/climate/tuya.rst
View File

@ -49,10 +49,12 @@ Configuration variables:
- **target_temperature_datapoint** (**Required**, int): The datapoint id number of the target temperature.
- **current_temperature_datapoint** (**Required**, int): The datapoint id number of the current temperature.
- **temperature_multiplier** (*Optional*, float): A multiplier to modify the incoming and outgoing temperature values - :ref:`see below <temperature-multiplier>`.
If the device has different multipliers for current and target temperatures, **temperature_multiplier** can be replaced with both of:
- **current_temperature_multiplier** (*Optional*, float): A multiplier to modify the current temperature value.
- **target_temperature_multiplier** (*Optional*, float): A multiplier to modify the target temperature value.
If the device has different multipliers for current and target temperatures, **temperature_multiplier** can be replaced with both of:
- **current_temperature_multiplier** (*Optional*, float): A multiplier to modify the current temperature value.
- **target_temperature_multiplier** (*Optional*, float): A multiplier to modify the target temperature value.
- All other options from :ref:`Climate <config-climate>`.
.. _temperature-multiplier:

4
components/display/waveshare_epaper.rst
View File

@ -8,7 +8,7 @@ Waveshare E-Paper Display
The ``waveshare_epaper`` display platform allows you to use
some E-Paper displays sold by `Waveshare <https://www.waveshare.com/product/displays/e-paper.htm>`__
with ESPHome. The 2.13" `TTGO module <https://github.com/lewisxhe/TTGO-EPaper-Series>`__ with an ESP32 on the board is supported as well.
Depending on your specific revision of the board you might need to try out the `-b73` or `-b1` version (see below).
Depending on your specific revision of the board you might need to try out the ``-b73`` or ``-b1`` version (see below).
Similar modules sold by other vendors might also work but not have been tested yet. Currently only
single-color E-Ink displays are implemented and of those only a few modules.
@ -53,7 +53,7 @@ configuration.
- file: 'fonts/Comic Sans MS.ttf'
id: font1
size: 8
spi:
clk_pin: D0
mosi_pin: D1

2
components/esphome.rst
View File

@ -50,7 +50,7 @@ Advanced options:
to include in the project. See `platformio lib install <https://docs.platformio.org/en/latest/userguide/lib/cmd_install.html>`__.
- **comment** (*Optional*, string): Additional text information about this node. Only for display in UI.
- **name_add_mac_suffix** (*Optional*, boolean): Appends the last 6 bytes of the mac address of the device to
the name in the form `<name>-aabbcc`. Defaults to ``False``.
the name in the form ``<name>-aabbcc``. Defaults to ``False``.
See :ref:`esphome-mac_suffix`.
ESP8266 Options:

2
components/fan/tuya.rst
View File

@ -55,7 +55,7 @@ Configuration variables:
- **switch_datapoint** (**Required**, int): The datapoint id number of the fan switch.
- **oscillation_datapoint** (*Optional*, int): The datapoint id number of the oscillation
switch. Probably not supported on any Tuya controllers currently, but it's there if need be.
- **direction_datapoint** (**Optional**, int): The datapoint id number of the direction
- **direction_datapoint** (*Optional*, int): The datapoint id number of the direction
switch. Supported by some ceiling fans.
- **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. Defaults to ``3``.
- All other options from :ref:`Fan <config-fan>`.

22
components/fingerprint_grow.rst
View File

@ -19,8 +19,9 @@ The ``fingerprint_grow`` component allows you to use your R307, R503, ZFM-20, ..
R503 Capacitive Fingerprint Reader with Bi-Color Aura LED (`datasheet <https://cdn-shop.adafruit.com/product-files/4651/4651_R503+fingerprint+module+user+manual.pdf>`__, `Adafruit <https://www.adafruit.com/product/4651>`__). Image by `Adafruit <https://www.adafruit.com/product/4651>`__.
Overview
--------
Component/Hub
-------------
The reader can be powered by the 3.3V output of an NodeMCU. As the communication with the reader is done using UART (default baud rate is 57600), you need to have an :ref:`UART bus <uart>` in your configuration with the ``rx_pin`` connected to the reader's ``TX`` and the ``tx_pin`` connected to the reader's ``RX``.
@ -60,25 +61,25 @@ If available on your reader model, it's recommended to connect 3.3VT (touch indu
- text_sensor.template.publish:
id: fingerprint_state
state: "Failed to enroll fingerprint"
# Optional template text sensor for visual feedback
text_sensor:
- platform: template
id: fingerprint_state
name: "Fingerprint State"
# Optional component (GPIO switch, lock etc.) to control in on_finger_scan_matched trigger
switch:
- platform: gpio
pin: GPIO14
id: gate
# Optional sensors
binary_sensor:
- platform: fingerprint_grow
id: fingerprint_enrolling
name: "Fingerprint Enrolling"
sensor:
- platform: fingerprint_grow
fingerprint_count:
@ -96,7 +97,6 @@ If available on your reader model, it's recommended to connect 3.3VT (touch indu
Configuration variables:
------------------------
The configuration is made up of three parts: The central component, optional individual sensors, and the optional enrolling binary sensor.
@ -113,7 +113,10 @@ Base Configuration:
- **on_enrollment_done** (*Optional*, :ref:`Automation <automation>`): An action to be performed when a fingerprint is enrolled. See :ref:`fingerprint_grow-on_enrollment_done`.
- **on_enrollment_failed** (*Optional*, :ref:`Automation <automation>`): An action to be performed when a fingerprint enrollment failed. See :ref:`fingerprint_grow-on_enrollment_failed`.
Optional Binary Sensor Configuration:
Binary Sensor
-------------
Configuration variables:
- **name** (**Required**, string): The name for the enrolling binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
@ -121,7 +124,8 @@ Optional Binary Sensor Configuration:
Optional Sensor Configuration:
Available sensors:
Sensor
------
- **fingerprint_count**: The number of enrolled fingerprints stored on the reader.

12
components/output/sm2135.rst
View File

@ -7,8 +7,8 @@ SM2135 LED driver
.. _sm2135-component:
Component
---------
Component/Hub
-------------
The SM2135 component represents a SM2135 LED diver chain
(`SM2135 description <https://github.com/arendst/Sonoff-Tasmota/files/3656603/SM2135E_zh-CN_en-US_translated.pdf>`__,
@ -17,7 +17,7 @@ ESPHome. Communication is done with two GPIO pins (MOSI and SCLK).
It is used in some smart light bulbs:
- Calex Smart RGB Reflector LED lamp (GU10)
- LSC Smart GU10
- LSC Smart GU10
To use the channels of this components, you first need to setup the
global ``sm2135`` hub and give it an id, and then define the
@ -65,8 +65,8 @@ Configuration variables:
.. _sm2135-output:
Driver Output
-------------
Output
------
The SM2135 output component exposes a SM2135 channel of a global
:ref:`sm2135-component` as a float output.
@ -114,7 +114,7 @@ Configuration variables:
.. note::
The white LEDs are much brighter than the color LEDs. To get uniform brightness
The white LEDs are much brighter than the color LEDs. To get uniform brightness
for both color and white you will need to limit the white led power.
.. note::

8
components/sensor/bh1750.rst
View File

@ -28,12 +28,12 @@ your configuration for this sensor to work.
- platform: bh1750
name: "BH1750 Illuminance"
address: 0x23
measurement_time: 69
measurement_duration: 69
update_interval: 60s
By default the **measurement_time** is set to ``69`` which will result into measurements up
By default the **measurement_duration** is set to ``69`` which will result into measurements up
to 54612.5 lx for this sensor. For low-light situtations consider to choose a higher
measurement_time up to ``254`` which will result in a maximum measurement range up to 14835 lx.
measurement_duration up to ``254`` which will result in a maximum measurement range up to 14835 lx.
For sunny scenes (for example outdoors with sunlight) use lower values down to ``31`` which will
give you the maximum measurement range up to 121556 lx.
@ -44,7 +44,7 @@ Configuration variables:
- **address** (*Optional*, int): Manually specify the I²C address of the sensor.
Defaults to ``0x23`` (address if address pin is pulled low). If the address pin is pulled high,
the address is ``0x5C``.
- **measurement_time** (*Optional*, int): Manually specify the measurement time between ``31``
- **measurement_duration** (*Optional*, int): Manually specify the measurement duration between ``31``
and ``254``. Defaults to ``69``.
- **resolution** (*Optional*, string): The resolution of the sensor in lx. One of ``4.0``,
``1.0``, ``0.5``. Defaults to ``0.5`` (the maximum resolution).

6
components/sensor/ble_sensor.rst → components/sensor/ble_client.rst
View File

@ -1,11 +1,11 @@
BLE Sensor
==========
BLE Client Sensor
=================
.. seo::
:description: Fetch numeric values from BLE devices.
:image: bluetooth.svg
The ``ble_sensor`` component is a sensor platform that can
The ``ble_client`` component is a sensor platform that can
query BLE devices for specific values of service characteristics.
For more information on BLE services and characteristics, see

23
components/sensor/bme680_bsec.rst
View File

@ -6,6 +6,9 @@ BME680 Temperature+Pressure+Humidity+Gas Sensor via BSEC
:image: bme680.jpg
:keywords: BME680
Component/Hub
-------------
The ``bme680_bsec`` sensor platform allows you to use your BME680
(`datasheet <https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf>`__,
`Adafruit`_) temperature, pressure and humidity and gas sensors with ESPHome via the Bosch Sensortec Environmental Cluster (BSEC)
@ -58,11 +61,6 @@ The :ref:`I²C <i2c>` is required to be set up in your configuration for this se
name: "BME680 IAQ Accuracy"
Configuration variables:
------------------------
The configuration is made up of three parts: The central hub, individual sensors, and accuracy text sensor.
Hub Configuration:
- **address** (*Optional*, int): Manually specify the I^2C address of
the sensor. Defaults to ``0x76``. Another address can be ``0x77``.
@ -79,7 +77,10 @@ Hub Configuration:
- **state_save_interval** (*Optional*, :ref:`config-time`): The minimum interval at which to save calibrated BSEC algorithm state to
flash so that calibration does have to start from zero on device restart. Defaults to ``6h``.
Sensor Configuration:
Sensor
------
Configuration variables:
- **temperature** (*Optional*): The information for the temperature sensor.
@ -129,9 +130,15 @@ Sensor Configuration:
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
Text Sensor Configuration:
Text Sensor
-----------
- **iaq_accuracy** (*Optional*): The information for the IAQ accuracy sensor.
Accuracy can be reported in text format.
Configuration variables:
- **iaq_accuracy** (*Optional*): The information for the IAQ accuracy sensor. Shows: Stabilizing,
Uncertain, Calibrating, Calibrated.
- **name** (**Required**, string): The name for the IAQ accuracy sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

27
components/sensor/sht4x.rst
View File

@ -1,5 +1,5 @@
SHT4X Temperature and Humidity Sensor
==================================================
=====================================
.. seo::
:description: Instructions for setting up SHT4X temperature and humidity sensor
@ -28,15 +28,24 @@ The :ref:`I²C Bus <i2c>` is required to be set up in your configuration for thi
Configuration variables:
------------------------
- **temperature** (**Optional**): Temperature. All other options from :ref:`Sensor <config-sensor>`.
- **humidity** (**Optional**): Relative Humidity. All other options from :ref:`Sensor <config-sensor>`.
- **temperature** (*Optional*): Temperature.
- **precision** (**Optional**, string): The measurement precision, either ``"High"``, ``"Med"`` or ``"Low"``. Default is ``"High"``.
- **heater_max_duty** (**Optional**, float): The maximum duty cycle of the heater (limited to ``0.05``). Default is ``0.0`` i.e. heater off.
- **heater_power** (**Optional**, string): The heater power, either ``"High"``, ``"Med"`` or ``"Low"``. Default is ``"High"``.
- **heater_time** (**Optional**, string): The length of time to run the heater, either ``"Long"`` (``1000ms``) or ``"Short"`` (``100ms``). Default is ``"Long"``.
- **address** (**Optional**, int): Manually specify the I²C address of the sensor. Default is ``0x44``.
- **update_interval** (**Optional**, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
- **name** (**Required**, string): The name of the sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
- **humidity** (*Optional*): Relative Humidity.
- **name** (**Required**, string): The name of the sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
- **precision** (*Optional*, string): The measurement precision, either ``High``, ``Med`` or ``Low``. Default is ``High``.
- **heater_max_duty** (*Optional*, float): The maximum duty cycle of the heater (limited to ``0.05``). Default is ``0.0``, i.e. heater off.
- **heater_power** (*Optional*, string): The heater power, either ``High``, ``Med`` or ``Low``. Default is ``High``.
- **heater_time** (*Optional*, string): The length of time to run the heater, either ``Long`` (1000ms) or ``Short`` (100ms). Default is ``Long``.
- **address** (*Optional*, int): Manually specify the I²C address of the sensor. Default is ``0x44``.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
Heater Configuration:
---------------------

10
components/switch/ble.rst → components/switch/ble_client.rst
View File

@ -1,12 +1,12 @@
BLE Switch
==========
BLE Client Switch
=================
.. seo::
:description: Control the state of BLE clients.
:image: bluetooth.svg
The ``ble_switch`` component is a switch platform that is used to enable
and disable a ``ble_client``. This has several uses, such as minimising
The ``ble_client`` component is a switch platform that is used to enable
and disable a ``ble_client``. This has several uses, such as minimizing
battery usage or for allowing other clients (Eg phone apps) to connect to
the device.
@ -30,7 +30,7 @@ Configuration variables:
------------------------
- **ble_client_id** (**Required**, :ref:`config-id`): ID of the associated BLE client.
- **id** (**Optional**, :ref:`config-id`): The ID to use for code generation, and for reference by dependent components.
- **id** (*Optional*, :ref:`config-id`): The ID to use for code generation, and for reference by dependent components.
- All other options from :ref:`Switch <config-switch>`.
See Also

2
cookbook/ble_itag.rst
View File

@ -110,5 +110,5 @@ See Also
--------
- :doc:`/components/ble_client`
- :doc:`/components/sensor/ble_sensor`
- :doc:`/components/sensor/ble_client`
- :ghedit:`Edit`

4
index.rst
View File

@ -104,7 +104,7 @@ Sensor Components
BH1750, components/sensor/bh1750, bh1750.jpg
Binary Sensor Map, components/sensor/binary_sensor_map, binary_sensor_map.jpg
BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
BLE Sensor, components/sensor/ble_sensor, bluetooth.svg
BLE Client Sensor, components/sensor/ble_client, bluetooth.svg
BME280, components/sensor/bme280, bme280.jpg
BME680, components/sensor/bme680, bme680.jpg
BME680 via BSEC, components/sensor/bme680_bsec, bme680.jpg
@ -272,7 +272,7 @@ Switch Components
UART Switch, components/switch/uart, uart.svg
Custom Switch, components/switch/custom, language-cpp.svg
Tuya Switch, components/switch/tuya, tuya.png
BLE Switch, components/switch/ble, bluetooth.svg
BLE Client Switch, components/switch/ble_client, bluetooth.svg
Fan Components
--------------