DEKI/ENGINE ドキュメント
deki-esp32-integration 0.19.0
Deki パッケージリファレンス
deki-esp32-integration

ESP32 用のプラットフォーム HAL:ESP-IDF の SDMMC による SD カード、FATFS ファイルシステム、シリアルコマンド、メモリとファイルシステムのセットアップ。

リポジトリ: github.com/dekiengine/deki-esp32-integration · 最新リリース: 0.19.0 · エンジン 0.19.0 以降が必要 · 依存: deki-wifi, deki-ble, deki-http, deki-i2s, deki-uart, deki-i2c, deki-gpio, deki-sdcard, deki-rendering

DekiEditor --packages-add deki-esp32-integration <project> か、パッケージマネージャーからインストールします。エンジン自身のコンポーネントと C++ API は Deki のドキュメントにあります。

エディターでは ESP32 Integration と表示されます。

コンポーネント

コンポーネント カテゴリ 説明
ESP32QemuDisplaySetup ESP32 HAL Espressif の QEMU の画面を開きます。ボードなしでファームウェアのビルドを実行するためのものです。
ESP32SerialSetup ESP32 HAL ESP32 のシリアルポートで、エディターからのコマンドに応答します。

機能フラグ

ビルドから外せる部分です。define を持つ機能はその define で切り替わり、それ以外はコンポーネントと一緒に取り除かれます。

機能 define デフォルト
Memory DEKI_FEATURE_ESP32_MEMORY_SETUP オン
File System DEKI_FEATURE_ESP32_FILE_SYSTEM_SETUP オン
Serial Commands DEKI_FEATURE_ESP32_SERIAL_SETUP オン
SD Card (ESP-IDF) DEKI_FEATURE_ESP32_SD オン
GPIO (ESP-IDF) DEKI_FEATURE_ESP32_GPIO オン
I²C (ESP-IDF) DEKI_FEATURE_ESP32_I2C オン
UART (ESP-IDF) DEKI_FEATURE_ESP32_UART オン
I²S (ESP-IDF) DEKI_FEATURE_ESP32_I2S オン
S3 SIMD Blit Kernels DEKI_FEATURE_ESP32_BLIT_SIMD オン
WiFi STA + scan (ESP-IDF) DEKI_FEATURE_ESP32_WIFI オン
BLE (NimBLE) DEKI_FEATURE_ESP32_BLE オン
QEMU Display DEKI_FEATURE_ESP32_QEMU_DISPLAY オン
HTTPS client (ESP-IDF) DEKI_FEATURE_ESP32_HTTP オン

コンポーネントリファレンス

ESP32QemuDisplaySetup

Espressif の QEMU の画面を開きます。ボードなしでファームウェアのビルドを実行するためのものです。

インスペクターでの名前: ESP32 QEMU ディスプレイセットアップ · カテゴリ: ESP32 HAL · 型: DekiEsp32::ESP32QemuDisplaySetup

プロパティ 型 デフォルト 制約 説明
width int32 320 1 から 4096 画面の幅 (ピクセル) です。
height int32 240 1 から 4096 画面の高さ (ピクセル) です。
format enum "RGB565" RGB565, ARGB8888 画面のピクセルフォーマットです。ゲームはこの形式で描画します。

ESP32SerialSetup

ESP32 のシリアルポートで、エディターからのコマンドに応答します。

インスペクターでの名前: ESP32 シリアルセットアップ · カテゴリ: ESP32 HAL · 型: DekiEsp32::ESP32SerialSetup

プロパティ 型 デフォルト 制約 説明
baudRate int32 115200 9600 から 921600 シリアルのボーレート

変更履歴

変更履歴は英語です。

0.19.0

Changed

  • minEngine 0.19.0: built against engine 0.19.0, whose component metadata records the package each class is in. A build of this package from before does not load and is rebuilt.

Added

  • Japanese, Simplified Chinese and Korean: editor/lang/ja.json, zh.json and ko.json translate the names, tooltips and enum values this package's components show in the Inspector.
  • The package's editor text goes through the editor's translation (Tr), so it shows in the editor's language. Needs the editor release that adds Localization.h; raise minEngine to it when releasing.

0.18.2

Added

  • Frame statistics over serial: the line DEKI:STATS is answered with the frames per second and the average frame, update, render and present times over the last second, and the free internal and external memory, for the editor's device_stats.
  • Screen capture over serial: the firmware answers the line DEKI:SCREENSHOT on its console with the frame on screen (base64, with a CRC), for the editor's device_screenshot. Started at boot (DekiESP32HALInitSystem, PACKAGE_HAS_SYSTEM_INIT); a USB Serial/JTAG console is read from its FIFO, a UART one through stdin. A frame takes about a second to send; the game waits for it, and that second is not counted as frame time, so nothing timed jumps ahead.
  • DEKI:PROFILE turns on deki-rendering's render profiler and then reports where the render time went since the request before, per component type. DEKI:SCENE <guid> opens that scene, for measuring each scene without pressing through the game.

Changed

  • minEngine 0.18.2: the frame statistics read the engine's GetLastFrameTimings.
  • ESP32-S3 builds use 64-byte data cache lines, which make a frame in PSRAM quicker to draw and send. The cache stays 32 KB: 64 KB takes 32 KB more of internal RAM, which a scene with many sprites ran out of.

Fixed

  • A UART ignored its baudRate and ran at 9600. Only the key baud was read, and deki-gps and the components name it baudRate, so a GPS sending at 38400 (the T-Deck Plus's) was never understood. Both keys are read.
  • A console reply's last bytes stayed on the board until the next reply pushed them out, so device_stats said the board did not answer. The USB Serial/JTAG console sends what it holds when flushed, and a flush made while the packet before is still going out is lost; it is now made again once the console takes it.
  • A flash with no port named (MCP's deploy_build, the CLI) picks one: the only serial port there is, or, with several, the first that answers as an ESP32. It failed with "No board found" even with a board plugged in.
  • Windows: an installed esptool showed as not installed. The editor unpacks its archive straight into espressif/esptool, and the toolchain definition looked for esptool.exe a folder deeper.
  • Windows: ESP-IDF's setup and builds work on a machine with no Python of its own. The Python component was python.org's embeddable build, which has no venv, ensurepip or pip, so ESP-IDF's install.bat could not create its environment; and nothing put it on PATH, so install.bat and export.bat found only the Microsoft Store's stub and stopped with 9009. It is now the Python Software Foundation's full portable build (the python package on nuget.org, pinned by SHA-256), on PATH for install.bat (pathEntries, which needs the editor that reads them) and for export.bat in every build. An installed copy of the old one shows as not installed; install it again.
  • The build's PATH is set in one set: a second set PATH=...PATH%... on the same cmd line expands PATH% to the value before the first and dropped what it added.
  • A flash with no board connected, or with a refused port, fails with the reason ("No board found on a serial port..."). It used to stop without a result, so the build status stayed "Flashing firmware..." for good.

それ以前のリリース: CHANGELOG.md


パッケージのリフレクションデータから生成しています (エンジン 0.19.0)。プロパティ名はシーンファイルで使われるキーです。名前を変えても別名が残ります (互換性)。