mirror of
https://github.com/letscontrolit/ESPEasy.git
synced 2026-09-12 09:36:59 +00:00
161 lines
7.1 KiB
ReStructuredText
161 lines
7.1 KiB
ReStructuredText
Hardware page
|
|
*************
|
|
|
|
Overview
|
|
========
|
|
|
|
ESPEasy has some centralized hardware configuration settings, shown in this page, and divided in sections.
|
|
|
|
|
|
---------------
|
|
Wifi Status LED
|
|
---------------
|
|
|
|
To display the Wifi acitivity, a pin can be configured to light up a LED when data is transfered via Wifi. Optionally, the LED signal can be 'inverted'.
|
|
|
|
As many ESP boards have an onboard LED connected to GPIO-2 and inverted, it is shown as a note how to configure that.
|
|
|
|
.. image:: Hardware_Wifistatusled.png
|
|
|
|
|
|
---------
|
|
Reset pin
|
|
---------
|
|
|
|
To provide a possible escape from a malfunctioning ESP module, a factory-reset button/feature can be configured by setting up a GPIO-pin for this.
|
|
|
|
.. warning::
|
|
**When connecting this pin to ground for ca. 10 seconds the unit will be completely reset, and all settings/configuration irretrievably deleted!**
|
|
|
|
This feature can be useful in a development/laboratory environment, for when the configuration gets corrupted in some way.
|
|
|
|
|
|
.. image:: Hardware_Resetpin.png
|
|
|
|
|
|
-------------
|
|
I2C Interface
|
|
-------------
|
|
|
|
When using devices that use the I2C bus (Inter-integrated circuit, also known as IIC, and mostly compatible with SM Bus) (`Wikipedia: I2C <https://en.wikipedia.org/wiki/I%C2%B2C>`_) some pins have to be configured, and initialized during boot, for the SDA and SCL connections. This can be any unused pair of pins on the ESP board.
|
|
|
|
The pins can be configured here, and will have default values initially (ESP8266: SDA: GPIO-4 (D2), SCL: GPIO-5 (D3), ESP32: SDA: GPIO-22, SCL: GPIO-23). When I2C is not used, these can be set to `- None -`, so the pins are available for other purposes.
|
|
|
|
The default bus clock speed can also be set here. If only devices supporting 100 kHz are connected (Old/Slow devices), then the value can be set to 100 kHz, by default 400 kHz is configured, that is supported by newer devices, though there are many devices supporting higher frequencies. ESP8266 is able to achieve ca. 400 kHz, while ESP32 allows much higher speeds.
|
|
|
|
Since build 20110, ESPEasy has a separate setting for Slow I2C devices, and per I2C device this slow clock speed can be selected in the Device edit page. This value is by default set to 100 kHz, but can be set lower or higher if desired.
|
|
|
|
.. image:: Hardware_I2CInterface.png
|
|
|
|
*Device specific Force Slow I2C speed selection:*
|
|
|
|
.. image:: Device_I2COptionsShort.png
|
|
|
|
|
|
---------------
|
|
I2C Multiplexer
|
|
---------------
|
|
|
|
Since build 20110, there is the option of using an I2C multiplexer. This option is not available in all builds, because of the size of the code. It is usually available in the normal, testing and custom builds, but ommitted from minimal, IR and hardware-specific builds.
|
|
|
|
Possible use-cases for an I2C multiplexer are:
|
|
|
|
* Connect multiple devices that have fixed or limited I2C addresses (For example, some OLED devices have a single fixed address but you need to connect 2 or more, or connect more than 3 TLS2561 devices, that support only 3 different addresses).
|
|
* Connect different devices that have the same I2C address (For example connecting a TSL2561 light/lux sensor and an APDS9960 proximity sensor).
|
|
* Connect slow and fast devices, where the speed of the fast device prohibits proper working of the slow device.
|
|
|
|
There are a couple of I2C multiplexer chips available, currently there is support for:
|
|
|
|
* TCA9548a (8 channels, multiple channel-connections, 8 I2C addresses, with reset)
|
|
* TCA9546a (4 channels, multiple channel-connections, 8 I2C addresses, with reset)
|
|
* PCA9540 (2 channels, fixed I2C address, no reset, experimental support)
|
|
|
|
Both TCA9548a and TCA9546a support connecting multiple channels to the main I2C channel. This can be configured on the Device edit page for I2C devices, once the I2C Multiplexer configuration is enabled by selecting a multiplexer type and an I2C address for the multiplexer.
|
|
|
|
Also, both the TCA9548a and TCA9546a chips have a connection for a reset signal available. This allows the chip to be reset if it gets stuck by some 'less compatible' or 'badly behaving' devices. Once connected and configured, the multiplexer can be reset from the software, if desired or required. This feature is not yet used in any I2C device plugin.
|
|
|
|
.. image:: Hardware_I2CMultiplexerNone.png
|
|
|
|
*Available multiplexer types:*
|
|
|
|
.. image:: Hardware_I2CMultiplexer_Type.png
|
|
|
|
*Select the I2C Address for the multiplexer:*
|
|
|
|
.. image:: Hardware_I2CMultiplexer_Address.png
|
|
|
|
|
|
Device configuration
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
If an I2C multiplexer is configured, every Device edit page for I2C devices will show extra options to select the channel the device is connected on.
|
|
|
|
There is the default option of Single channel, or, when a TCA9548a or TCA9546a is configured, Multiple channels.
|
|
|
|
*Example: A multiplexer is confgured, but the device is connected directly on the ESP board I2C channel:*
|
|
|
|
.. image:: Device_I2COptionsMultiplexerNone.png
|
|
|
|
*Configure a (single) multiplexer channel the device is connected on:*
|
|
|
|
.. image:: Device_I2COptionsMultiplexerSelectSingleChannel.png
|
|
|
|
NB: Only acceptable channels (0-7/0-3/0-1) will be available in the dropdown list, depending on the Multiplexer type configured.
|
|
|
|
*Select Single channel or Multiple channels:*
|
|
|
|
.. image:: Device_I2COptionsMultiplexerSelect.png
|
|
|
|
*Configure multiple channels for a device, 8 channel multiplexer configured*
|
|
|
|
.. image:: Device_I2COptionsMultiplexerMultipleSelect.png
|
|
|
|
Above configuration results in channels 0, 4, 5, 6 and 7 being connected to the ESP board I2C bus when this sensor is active via I2C.
|
|
|
|
For the 4 channel multiplexer, options 4-7 aren't shown.
|
|
|
|
|
|
-------------
|
|
SPI Interface
|
|
-------------
|
|
|
|
When using devices that are connected via the SPI interface (`Wikipedia: SPI <https://en.wikipedia.org/wiki/Serial_Peripheral_Interface>`_), the interface must be initialized during boot. This can be enabled here. For ESP32 there is the option to select either the Hardware SPI (HSPI) interface or the Virtual SPI (VSPI) interface (software controlled).
|
|
|
|
The common SPI pins are shown here.
|
|
|
|
Other SPI pins to be used are device specific, and need to be configured from the corresponding Device edit page.
|
|
|
|
*For ESP8266:*
|
|
|
|
.. image:: Hardware_SPIInterfaceESP8266.png
|
|
|
|
*For ESP32, disabled:*
|
|
|
|
.. image:: Hardware_SPIInterfaceESP32.png
|
|
|
|
*For ESP32, select the desired interface:*
|
|
|
|
.. image:: Hardware_SPIInterfaceESP32_Select.png
|
|
|
|
NB: When using the VSPI interface and also the I2C interface is used, another pin has to be selected for I2C GPIO -> SCL, as its configuration is fixed for the VSPI setting.
|
|
|
|
|
|
-------------------
|
|
GPIO boot states
|
|
-------------------
|
|
|
|
For some GPIO pins, the boot state (initial configuration after startup) can be configured.
|
|
|
|
Some differences exist between ESP8266 and ESP32:
|
|
|
|
* ESP8266 can't initialize GPIO's 6, 7 and 8 (technical limitation of ESP8266 chip) and 16 (always has pull-down setting)
|
|
* ESP32 can't initialize GPIO's from 16 and up (settings storage limitation, could be initialized from Rules in `System#Boot` event)
|
|
|
|
*ESP8266 GPIO boot states:*
|
|
|
|
.. image:: Hardware_GPIObootstatesESP8266.png
|
|
|
|
*ESP32 GPIO boot states:*
|
|
|
|
.. image:: Hardware_GPIObootstatesESP32.png
|