diff --git a/components/psram.rst b/components/psram.rst new file mode 100644 index 000000000..7cf16bfe4 --- /dev/null +++ b/components/psram.rst @@ -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` diff --git a/images/psram.svg b/images/psram.svg new file mode 100644 index 000000000..3bc309a4e --- /dev/null +++ b/images/psram.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/index.rst b/index.rst index ad418e58d..ef159a68f 100644 --- a/index.rst +++ b/index.rst @@ -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