doc: add info about each component, add info on some strapping pins

and3rson · Apr 15, 2024 · b6f467f · b6f467f
1 parent 7c2b139
commit b6f467f
Show file tree

Hide file tree

Showing 20 changed files with 244 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,11 @@ DIY-консоль, яку можна зібрати з дешевих гото
 
 ## Демо
 
-Відео про проєкт:
+Новини про проєкт Лілка V2:
+
+[![Новини про проєкт "Лілка](https://img.youtube.com/vi/Xh49N__p2jE/hqdefault.jpg)](https://www.youtube.com/watch?v=Xh49N__p2jE)
+
+Перша версія Лілки:
 
 [![Проєкт "Лілка"](https://img.youtube.com/vi/6Tz70vqRrs0/hqdefault.jpg)](https://www.youtube.com/watch?v=6Tz70vqRrs0)
 

diff --git a/docs/assembly/components.rst b/docs/assembly/components.rst
@@ -126,7 +126,7 @@
    * - 1
      - U2
      - 280x240 1.69\" TFT
-     - 1.7\" TFT Display (ST7789)
+     - 1.7\" IPS TFT Display (ST7789)
      - `arduino.ua <https://arduino.ua/prod6568-tft-displei-1-7-spi-240x280-rgb>`__
      - 176
      -

diff --git a/docs/assembly/every_component.rst b/docs/assembly/every_component.rst
diff --git a/docs/assembly/images/buzzer.png b/docs/assembly/images/buzzer.png
diff --git a/docs/assembly/images/dac.png b/docs/assembly/images/dac.png
diff --git a/docs/assembly/images/display.png b/docs/assembly/images/display.png
diff --git a/docs/assembly/images/divider.png b/docs/assembly/images/divider.png
diff --git a/docs/assembly/images/extension.png b/docs/assembly/images/extension.png
diff --git a/docs/assembly/images/mcu.png b/docs/assembly/images/mcu.png
diff --git a/docs/assembly/images/regulator.png b/docs/assembly/images/regulator.png
diff --git a/docs/assembly/images/reset.png b/docs/assembly/images/reset.png
diff --git a/docs/assembly/images/sdcard.png b/docs/assembly/images/sdcard.png
diff --git a/docs/assembly/images/switching.png b/docs/assembly/images/switching.png
diff --git a/docs/assembly/images/usb.png b/docs/assembly/images/usb.png
diff --git a/docs/assembly/index.rst b/docs/assembly/index.rst
@@ -12,3 +12,4 @@
 
     configurations
     components
+    every_component
diff --git a/docs/faq/hardware.rst b/docs/faq/hardware.rst
@@ -30,3 +30,19 @@
 Враховуючи, що (станом на момент написання цього документу) SD-карта працює на частоті 25 МГц, читання файлу розміром 1 МБ з SD-карти за ідеальних умов займе менше однієї секунди!
 
 Тому, якщо ви пишете гру, яка завантажує текстури чи звуки з SD-карти, просто завантажте їх у пам'ять PSRAM один раз при запуску гри і надалі працюйте з ними вже з пам'яті, не взаємодіючи з SD-картою.
+
+Чому ви не вивели `GPIO35`, `GPIO36` та `GPIO37` на роз'єм розширення?
+----------------------------------------------------------------------
+
+Ці піни можна використовувати лише в деяких (менш потужних) варіантах ESP32-S3-WROOM.
+
+В ESP32-S3-WROOM-N16R8, який використовується в Лілці, ці піни використовуються для внутрішіх потреб (а точніше - для спілкування мікроконтролера ESP32-S3 з пам'яттю PSRAM).
+
+Тому використовувати їх для будь-яких інших цілей заборонено.
+
+Чому ви не вивели `GPIO45` на роз'єм розширення?
+------------------------------------------------
+
+`GPIO45` - це один з так званих "strapping" пінів, які використовуються для вибору режиму завантаження мікроконтролера та інших налаштувань.
+
+Використання цього піна небезпечне, оскільки він встановлює режим напруги SPI-шини. Тому ми вирішили не виводити його на роз'єм розширення, щоб уникнути можливих проблем та потенційних пошкоджень пристрою.
diff --git a/docs/hardware/mcu.rst b/docs/hardware/mcu.rst
@@ -1,3 +1,5 @@
+.. _mcu:
+
 Мікроконтролер
 ==============
 

diff --git a/docs/keira/features.rst b/docs/keira/features.rst
@@ -61,11 +61,12 @@ Keira має вбудовану підтримку запуску `Lua <https://
 mJS - це `мінімалістичний двигун JavaScript <https://github.com/cesanta/mjs>`_, який використовується в Лілці для виконання скриптів.
 Keira має вбудовану підтримку запуску mJS-скриптів з SD-картки. Це означає, що ви можете скопіювати файли, написані діалектом mJS (з розширенням ``.js``) на SD-картку і виконувати їх на Лілці.
 
-Я не впевнений, наскільки корисною буде ця функція, і ми рекомендуємо використовувати для цього Lua, яка має значно більше можливостей, ніж mJS. Проте ця функція є, і ви можете спробувати її, якщо вам цікаво.
+Я не впевнений, наскільки корисною буде ця функція, і ми рекомендуємо використовувати для цього Lua, яка має значно більше можливостей, ніж mJS.
+Проте така опція є і ви можете спробувати її, якщо вам цікаво.
 
 .. warning::
 
-    mJS - це діалект JavaScript, який має свої особливості. Наприклад, він не підтримує класи, і він має свої власні функції для роботи з рядками, масивами, об'єктами, тощо.
+    mJS - це діалект JavaScript, який має свої особливості. Наприклад, він не підтримує класи і має свої власні функції для роботи з рядками, масивами, об'єктами тощо.
     Тому, якщо ви вирішили використовувати mJS, будьте готові до того, що:
 
     * **Вам доведеться вивчати новий діалект JavaScript**.

diff --git a/docs/keira/sdcard.rst b/docs/keira/sdcard.rst
@@ -1,3 +1,5 @@
+.. _sdcard:
+
 Карта microSD
 =============
 

diff --git a/docs/manual/extension.rst b/docs/manual/extension.rst
@@ -1,3 +1,5 @@
+.. _extension:
+
 Роз'єм розширення
 =================