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

Clean up some external links ()

Browse Source
This commit is contained in:
Jesse Hills 2024-11-12 16:39:09 +13:00 committed by GitHub
parent ce62d5ea8d
commit f4226cb93a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 26 additions and 29 deletions

2
components/binary_sensor/rc522.rst
View File

@ -13,7 +13,7 @@ RC522 NFC/RFID
:width: 60.0%
The ``rc522`` component allows you to use RC522 NFC/RFID controllers
(`datasheet <https://www.nxp.com/docs/en/data-sheet/MFRC522.pdf>`__, `Ali Express <https://es.aliexpress.com/item/1260729519.html>`__)
(`datasheet <https://www.nxp.com/docs/en/data-sheet/MFRC522.pdf>`__, `Ali Express <https://www.aliexpress.com/item/1260729519.html>`__)
with ESPHome. ESPHome can read the UID from the tag. Every NFC/RFID tag has a unique "UID" value assigned at the time
of manufacture. Tags can be associated with binary sensors, making it easy to determine when a specific tag is present.
You can also use the tag information directly within ESPHome automations/lambdas. See :ref:`rc522-setting_up_tags` for

3
components/display/ili9xxx.rst
View File

@ -36,8 +36,7 @@ This component is the successor of the ILI9341 component supporting more display
families.
The ``ILI9xxx`` display platform allows you to use
ILI9341 (`datasheet <https://cdn-shop.adafruit.com/datasheets/ILI9341.pdf>`__,
`Aliexpress <https://www.aliexpress.com/af/Ili9341.html>`__) and other
ILI9341 (`datasheet <https://cdn-shop.adafruit.com/datasheets/ILI9341.pdf>`__) and other
displays from the same chip family with ESPHome. As this is a somewhat higher resolution display and requires additional pins
beyond the basic SPI connections, and a reasonable amount of RAM, it is not well suited for the ESP8266.

25
components/display/st7567.rst
View File

@ -10,12 +10,11 @@ ST7567 LCD Graphic Display
Usage
-----
The ``st7567`` display platform allows you to use wide range of 128x64 display modules based on
The ``st7567`` display platform allows you to use wide range of 128x64 display modules based on
Sitronix ST7567 chipset family (ST7567A, ST7567S, ST7567G, etc.) (`datasheet <https://github.com/latonita/datasheets-storage/blob/main/lcd-modules/ST7567A_V1.2b.pdf>`__,
`Sitronix <https://www.sitronix.com.tw/en/products/industrial-display-driver-ic/mono-stn-lcd-driver-ic/>`__,
`Aliexpress <https://www.aliexpress.com/af/st7567s.html>`__) with ESPHome.
`Sitronix <https://www.sitronix.com.tw/en/products/industrial-display-driver-ic/mono-stn-lcd-driver-ic/>`__) with ESPHome.
Note that this component is for displays that are connected via the :ref:`I²C Bus <i2c>` (see :ref:`st7567-i2c`)
Note that this component is for displays that are connected via the :ref:`I²C Bus <i2c>` (see :ref:`st7567-i2c`)
or 3-Wire or 4-Wire :ref:`SPI bus <spi>` (see :ref:`st7567-spi`).
It's a monochrome LCD graphic display.
@ -30,11 +29,11 @@ It's a monochrome LCD graphic display.
**Voltage:** Check your module specs for required power. Most of the modules are tolerant to range of voltages from 3.3V to 5V, but some might require either 5V or 3.3V.
**Electrical interference:** To reduce malfunction caused by noise, datasheet recommends to "use the refresh sequence regularly in a specified interval".
Noone knows what exact interval is - it varies based on your electrical environment - some might need it every hour, for example.
Noone knows what exact interval is - it varies based on your electrical environment - some might need it every hour, for example.
Without doing refresh sequence picture on LCD might get glitchy after some time.
You can plan refresh by using ``interval:`` section and calling ``request_refresh()`` function, after that it will perform display
You can plan refresh by using ``interval:`` section and calling ``request_refresh()`` function, after that it will perform display
refresh sequence on next component update.
@ -43,8 +42,8 @@ It's a monochrome LCD graphic display.
Over I²C
--------
Connect ``SDA`` and ``SCL`` pins on a module to pins you chose for the :ref:`I²C Bus <i2c>`.
If your display module has ``RESET`` pin you may optionally connect it to a pin on the
Connect ``SDA`` and ``SCL`` pins on a module to pins you chose for the :ref:`I²C Bus <i2c>`.
If your display module has ``RESET`` pin you may optionally connect it to a pin on the
ESP which may improve reliability. For power, connect ``VCC`` to 3.3V and ``GND`` to ``GND``.
@ -60,7 +59,7 @@ ESP which may improve reliability. For power, connect ``VCC`` to 3.3V and ``GND`
id: my_display
lambda: |-
it.print(0, 0, id(my_font), "Hello World!");
interval:
- interval: 1h
then:
@ -90,7 +89,7 @@ Configuration variables:
.. code-block:: yaml
# Example increased I²C bus speed
# Example increased I²C bus speed
i2c:
sda: D1
scl: D2
@ -117,7 +116,7 @@ Over SPI
--------
Connect ``D0`` to the ``CLK`` pin you chose for the :ref:`SPI bus <spi>`, connect ``D1`` to the ``MOSI`` pin and ``DC`` and ``CS``
to some GPIO pins on the ESP. For power, connect ``VCC`` to 3.3V and ``GND`` to ``GND``.
to some GPIO pins on the ESP. For power, connect ``VCC`` to 3.3V and ``GND`` to ``GND``.
Optionally you can also connect the ``RESET`` pin to a pin on the ESP which may improve reliability.
.. code-block:: yaml

8
components/sensor/as3935.rst
View File

@ -7,7 +7,7 @@ AMS AS3935 Franklin Lightning Sensor
:keywords: as3935
The **AS3935** sensor platform allows you to use your AS3935 sensor
(`AliExpress`_, `AMS_AS3935`_)
(`AMS_AS3935`_)
in order to get notified when a thunderstorm is getting close.
The AS3935 can detect the presence of lightning activity and provide an estimation
@ -46,14 +46,13 @@ A1 I²C address selection MSB
AS3935 Lightning Sensor.
.. _AliExpress: https://de.aliexpress.com/af/as3935.html?SearchText=as3935
.. _AMS_AS3935: https://ams.com/as3935
Over SPI
--------
The ``as3935_spi`` sensor platform allows you to use your AS3935 sensor
(`AliExpress`_, `AMS_AS3935`_) in order to get notified when a thunderstorm is getting close.
(`AMS_AS3935`_) in order to get notified when a thunderstorm is getting close.
.. code-block:: yaml
@ -102,7 +101,7 @@ Over I²C
--------
The ``as3935_i2c`` sensor platform allows you to use your AS3935 sensor
(`AliExpress`_, `AMS_AS3935`_) in order to get notified when a thunderstorm is getting close.
(`AMS_AS3935`_) in order to get notified when a thunderstorm is getting close.
.. code-block:: yaml
@ -193,7 +192,6 @@ See Also
- :ref:`sensor-filters`
- :apiref:`as3935/as3935.h`
- `AliExpress <https://de.aliexpress.com/af/as3935.html?SearchText=as3935>`__
- `Data Sheet <https://www.embeddedadventures.com/datasheets/AS3935_Datasheet_EN_v2.pdf>`__
- `Little Arduino Projects <https://github.com/tardate/LittleArduinoProjects/tree/master/playground/AS3935>`__
- `AMS AS3935 <https://ams.com/as3935>`__

9
components/sensor/atm90e32.rst
View File

@ -108,10 +108,11 @@ Configuration variables:
Calibration
-----------
This sensor needs calibration to show correct values. The default gain configuration is set to use the `SCT-013-000 <https://amzn.to/2E0KVvo>`__
current transformers, and the `Jameco Reliapro 9v AC transformer <https://amzn.to/2XcWJjI>`__.
This sensor needs calibration to show correct values. The default gain configuration is set to use the
`SCT-013-000 <https://www.amazon.com/gp/product/B075541WVT>`__
current transformers, and the `Jameco Reliapro 9v AC transformer <https://www.amazon.com/gp/product/B00B886CWS>`__.
A load which uses a known amount of current can be used to calibrate. For for a more accurate calibration use a
`Kill-A-Watt <https://amzn.to/2TXT7jx>`__ meter or similar, mains voltages can fluctuate depending on grid load.
`Kill-A-Watt <https://www.amazon.com/gp/product/B00009MDBU>`__ meter or similar, mains voltages can fluctuate depending on grid load.
Voltage
^^^^^^^
@ -316,7 +317,7 @@ Additional Examples
enable_offset_calibration: True
- platform: atm90e32
cs_pin: 4
id: chip2 #Optional
id: chip2 #Optional
phase_a:
current:
name: "EMON CT4 Current"

2
components/tm1651.rst
View File

@ -11,7 +11,7 @@ Battery Display
---------------
The ``tm1651`` display platform allows you to use battery display units based on the TM1651 chip such as
`this one <https://aliexpress.com/item/32811491559.html>`__ with ESPHome. This component supports the level
`this one <https://www.aliexpress.com/item/32811491559.html>`__ with ESPHome. This component supports the level
and brightness settings. All updates can be made via lambda expressions.
.. figure:: images/tm1651-battery-display.jpg

2
components/weikai.rst
View File

@ -19,7 +19,7 @@ The ESPHome ``WeiKai`` component supports the following WeiKai chips:
It can also be used with evaluation board equipped with these chips, such as:
- `WK2168 Chip Development Board <https://fr.aliexpress.com/item/1005002198759633.html>`__
- `WK2168 Chip Development Board <https://www.aliexpress.com/item/1005002198759633.html>`__
- `WK2132 Chip Development Board <https://www.aliexpress.com/item/1005002018579265.html>`__
- `DFROBOT Gravity: I²C to Dual UART Module <https://www.dfrobot.com/product-2001.html>`__

4
cookbook/leak-detector-m5stickC.rst
View File

@ -24,14 +24,14 @@ Things you'll need
:align: center
- Moisture sensor
This example uses a `Guardian Remote Sensor Probe <https://amazon.com/Guardian-by-Elexa-Remote-Sensor/dp/B07G5BMD7L>`__
This example uses a `Guardian Remote Sensor Probe <https://www.amazon.com/gp/product/B07G5BMD7L>`__
which has a 6' cord.
.. figure:: images/leak-detector-m5stickC_probe.jpg
:align: center
- Grove connector pigtail
`Amazon Link <https://www.amazon.com/Cables-Grove-Female-Jumper-Grove-Conversion/dp/B01CNZ9EEC>`__
`Amazon Link <https://www.amazon.com/gp/product/B01CNZ9EEC>`__
.. figure:: images/leak-detector-m5stickC_grove1.jpg
:align: center