Add a doc for PSRAM config (#3177)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Keith Burzinski
GitHub
parent
28758a9b85
commit
d0719caf68
|
|
@ -0,0 +1,31 @@
|
|||
PSRAM
|
||||
=====
|
||||
|
||||
.. seo::
|
||||
:description: Configuration for the ESP32 PSRAM platform for ESPHome.
|
||||
:image: psram.svg
|
||||
|
||||
This component enables and configures PSRAM if/when available on ESP32 modules/boards.
|
||||
It is automatically loaded and enabled by components that require it.
|
||||
|
||||
PSRAM is only available on the ESP32.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
psram:
|
||||
mode: octal
|
||||
speed: 80MHz
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **mode** (*Optional*): Defines the operating mode the PSRAM should utilize. One of ``quad`` or ``octal``.
|
||||
- **speed** (*Optional*, int): The speed at which the PSRAM should operate. One of ``40MHz``, ``80MHz`` or ``120MHz``.
|
||||
Note that ``80MHz`` and ``120MHz`` are not supported on all modules; in addition, ``120MHz`` is considered
|
||||
"experimental" at the time this document was written.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :ghedit:`Edit`
|
||||
|
|
@ -0,0 +1 @@
|
|||
<svg viewBox="0 0 106 25" id="svg5" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"><defs id="defs9"/><path d="M5 0h96a5 5 0 015 5v15a5 5 0 01-5 5H5a5 5 0 01-5-5V5a5 5 0 015-5z" style="fill:#000" id="path2"/><g aria-label="PSRAM" id="component-text" style="font-weight:700;font-size:25px;font-family:Montserrat;letter-spacing:1.1px;fill:#fffffc"><path d="M7.075 21V3.5h7.575q2.35.0 4.05.775 1.7.75 2.625 2.175t.925 3.4q0 1.95-.925 3.375t-2.625 2.2q-1.7.75-4.05.75H9.325l1.8-1.825V21zm4.05-6.2-1.8-1.925h5.1q1.875.0 2.8-.8t.925-2.225q0-1.45-.925-2.25-.925-.8-2.8-.8h-5.1l1.8-1.925z" id="path11"/><path d="m32.225009 21.3q-2.1.0-4.025-.55-1.925-.575-3.1-1.475l1.375-3.05q1.125.8 2.65 1.325 1.55.5 3.125.5 1.2.0 1.925-.225.75-.25 1.1-.675t.35-.975q0-.7-.55-1.1-.55-.425-1.45-.675-.9-.275-2-.5-1.075-.25-2.175-.6-1.075-.35-1.975-.9-.9-.55-1.475-1.45-.55-.9-.55-2.3.0-1.5.8-2.725.825-1.25 2.45-1.975 1.65-.75 4.125-.75 1.65.0 3.25.4 1.6.375 2.825 1.15l-1.25 3.075q-1.225-.7-2.45-1.025-1.225-.35-2.4-.35-1.175.0-1.925.275t-1.075.725q-.325.425-.325 1 0 .675.55 1.1.55.4 1.45.65.9.25 1.975.5 1.1.25 2.175.575 1.1.325 2 .875t1.45 1.45q.575.9.575 2.275.0 1.475-.825 2.7t-2.475 1.975q-1.625.75-4.125.75z" id="path13"/><path d="M43.52502 21V3.5h7.575q2.35.0 4.05.775 1.7.75 2.625 2.175t.925 3.4q0 1.95-.925 3.375-.925 1.4-2.625 2.15t-4.05.75h-5.325l1.8-1.775V21zm11.125.0-4.375-6.35h4.325l4.425 6.35zm-7.075-6.2-1.8-1.9h5.1q1.875.0 2.8-.8.925-.825.925-2.25.0-1.45-.925-2.25-.925-.8-2.8-.8h-5.1l1.8-1.925z" id="path15"/><path d="m60.700037 21 7.8-17.5h4l7.825 17.5h-4.25l-6.4-15.45h1.6l-6.425 15.45zm3.9-3.75 1.075-3.075h9l1.1 3.075z" id="path17"/><path d="M83.250056 21V3.5h3.35l7.45 12.35h-1.775l7.325-12.35h3.325004l.05 17.5h-3.800004l-.025-11.675h.7l-5.85 9.825h-1.825l-5.975-9.825h.85V21z" id="path19"/></g></svg>
|
||||
|
After Width: | Height: | Size: 1.8 KiB |
|
|
@ -133,8 +133,8 @@ Core Components
|
|||
.. imgtable::
|
||||
|
||||
Core, components/esphome, cloud-circle.svg, dark-invert
|
||||
PSRAM, components/psram, psram.svg
|
||||
WiFi, components/wifi, network-wifi.svg, dark-invert
|
||||
MQTT, components/mqtt, mqtt.png
|
||||
Network, components/network, network-wifi.svg, dark-invert
|
||||
|
||||
I²C Bus, components/i2c, i2c.svg
|
||||
|
|
@ -142,6 +142,7 @@ Core Components
|
|||
UART Bus, components/uart, uart.svg
|
||||
CAN Bus, components/canbus, canbus.svg
|
||||
|
||||
MQTT, components/mqtt, mqtt.png
|
||||
OTA Updates, components/ota, system-update.svg, dark-invert
|
||||
Logger, components/logger, file-document-box.svg, dark-invert
|
||||
Web Server, components/web_server, http.svg, dark-invert
|
||||
|
|
|
|||
Loading…
Reference in New Issue