Skip to content

Commit

Permalink
doc: rename main OS to Keira OS
Browse files Browse the repository at this point in the history
  • Loading branch information
and3rson committed Mar 9, 2024
1 parent bb5a81b commit 3979f4b
Show file tree
Hide file tree
Showing 60 changed files with 226 additions and 157 deletions.
31 changes: 1 addition & 30 deletions docs/library/build_flags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Бібліотека ``lilka`` постачається з рядом вбудованих можливостей, які за замовчуванням увімкнені.

Можливо, вам не подобаються деякі налаштування, які вибрані за замовчуванням. Наприклад, ви хочете вимкнути підтримку Lua, бо не плануєте використовувати цю мову програмування.
Можливо, вам не подобаються деякі налаштування, які вибрані за замовчуванням. Наприклад, ви не хочете, щоб привітальне зображення відображалося при запуску Лілки.

Завдяки :term:`PlatformIO` ви можете змінити налаштування, відредагувавши файл `platformio.ini`. Для цього є опція ``build_flags``.

Expand Down Expand Up @@ -32,32 +32,3 @@
Видалити привітальне зображення.

Пришвидшує запуск Лілки та звільняє ~134 КБ флеш-пам'яті.

.. c:macro:: LILKA_NO_MJS
Вимкнути підтримку mJS.

Звільняє ~49 КБ флеш-пам'яті.

.. c:macro:: LILKA_NO_LUA
Вимкнути підтримку Lua.

Звільняє ~162 КБ флеш-пам'яті.

Мінімальна конфігурація
-----------------------

Якщо ви хочете вимкнути всі можливості (наприклад, ви хочете використати бібліотеку ``lilka`` без Lua, mJS та привітального зображення), ви можете використати наступний рядок:

.. code-block:: ini
:linenos:
:emphasize-lines: 7
[env:v2]
platform = espressif32
board = lilka_v2
framework = arduino
lib_deps =
lilka
build_flags = -D LILKA_NO_SPLASH -D LILKA_NO_MJS -D LILKA_NO_LUA
11 changes: 9 additions & 2 deletions docs/library/ui.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
``UI``: Інтерфейс користувача
=============================

.. doxygenfunction:: lilka::ui_menu
Цей модуль містить класи, які відповідають за відображення простих елементів інтерфейсу користувача: меню, сповіщення тощо.

.. doxygenfunction:: lilka::ui_alert
.. doxygenclass:: lilka::Menu
:members:

.. doxygenclass:: lilka::Alert
:members:

.. doxygenclass:: lilka::ProgressDialog
:members:
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
Налаштування середовища розробки
================================

Для розробки програмного забезпечення для Лілки ми використовуємо середовище **PlatformIO**.
Отже, ви зібрали Лілку. Чи, можливо, якийсь інший пристрій на базі мікроконтролера ESP32. І ви хочете написати для нього програмне забезпечення. З чого почати?
(Саме так: багато що з цього документу може бути корисним і для інших пристроїв на базі ESP32, але ми будемо говорити здебільшого саме про Лілку.)

Для розробки програмного забезпечення для Лілки ми використовуємо середовище **PlatformIO**, і дуже рекомендуємо вам теж спробувати його. До речі, **PlatformIO** - це український проект, і ми пишаємося тим, що він став таким популярним у всьому світі! 🇺🇦

**PlatformIO** - це набір інструментів для розробки вбудованого програмного забезпечення, який автоматизує процес збірки, завантаження та налагодження програмного забезпечення для мікроконтролерів.
Якщо ви колись працювали з Arduino IDE, то ви знаєте, що воно хоч і зручне, але має свої обмеження. **PlatformIO** - це таке собі "Arduino для дорослих".

**PlatformIO** автоматично встановлює необхідні залежності, такі як компілятори, бібліотеки та інші інструменти, що необхідні для написання програм.

Expand Down
14 changes: 0 additions & 14 deletions docs/manual/hashbrown/index.rst

This file was deleted.

File renamed without changes
3 changes: 2 additions & 1 deletion docs/manual/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
.. toctree::
:maxdepth: 1

hashbrown/index
environment
keira/index
development
extension
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _hashbrown-firmware-features:
.. _keira-firmware-features:

Можливості Хешбраун OS
======================
Можливості
==========

.. contents::
:local:
Expand All @@ -12,11 +12,11 @@
Запуск прошивок з SD-картки
---------------------------

Основна прошивка підтримує запуск другорядних прошивок з SD-картки. Такі файли мають розширення ``.bin``. Це дозволяє вам скомпілювати (або завантажити з інтернету) нестандартну прошивку, скопіювати її на SD-картку, і запустити її на Лілці.
Keira підтримує запуск другорядних прошивок з SD-картки. Такі файли мають розширення ``.bin``. Це дозволяє вам скомпілювати (або завантажити з інтернету) нестандартну прошивку, скопіювати її на SD-картку, і запустити її на Лілці.

Це має деякі великі переваги:

- Ви можете використовувати більше пам'яті, ніж доступно в Хешбраун OS.
- Ви можете використовувати більше пам'яті, ніж доступно в Keira.
- Вам не потрібно щоразу перепрошивати Лілку, щоб випробувати другорядні прошивки: просто скопіюйте їх на SD-картку.
- Ви можете ділитися своїми скомпільованими прошивками (у вигляді ``.bin``-файлів) з іншими користувачами Лілки, без необхідності відправляти їм весь код вашої власної прошивки.

Expand All @@ -31,14 +31,14 @@

Тепер ви можете вставити SD-картку в Лілку і вибрати ``doom.bin`` у браузері SD-картки. Лілка перезавантажиться, і ви зможете зіграти в Doom!

Після перезавантаження Лілки ви повернетеся до Хешбраун OS.
Після перезавантаження Лілки ви повернетеся до Keira.

.. _nes-emulator-feature:

Запуск ігор NES з SD-картки
---------------------------

Основна прошивка має вбудовану підтримку запуску ігор `NES <https://uk.wikipedia.org/wiki/Nintendo_Entertainment_System>`_ з SD-картки. Це означає, що ви можете скопіювати файли ігор NES (`.rom` або `.nes`) на SD-картку, і грати в них на Лілці.
Keira має вбудовану підтримку запуску ігор `NES <https://uk.wikipedia.org/wiki/Nintendo_Entertainment_System>`_ з SD-картки. Це означає, що ви можете скопіювати файли ігор NES (`.rom` або `.nes`) на SD-картку, і грати в них на Лілці.

Для емуляції NES Лілка використовує емулятор `Nofrendo <https://github.com/moononournation/arduino-nofrendo>`_. Він може мати деякі обмеження, але, наприклад, Super Mario Bros працює бездоганно.

Expand All @@ -47,7 +47,7 @@
Запуск Lua-скриптів з SD-картки
-------------------------------

Основна прошивка має вбудовану підтримку запуску `Lua <https://uk.wikipedia.org/wiki/Lua>`_-скриптів з SD-картки. Це означає, що ви можете скопіювати файли Lua (`.lua`) на SD-картку, і виконувати їх на Лілці.
Keira має вбудовану підтримку запуску `Lua <https://uk.wikipedia.org/wiki/Lua>`_-скриптів з SD-картки. Це означає, що ви можете скопіювати файли Lua (`.lua`) на SD-картку, і виконувати їх на Лілці.

Для виконання Lua-скриптів Лілка використовує вбудований інтерпретатор Lua, який базується на `Lua 5.4.6 <https://www.lua.org/manual/5.4/manual.html>`_.

Expand All @@ -59,7 +59,7 @@
-------------------------------

mJS - це `мінімалістичний двигун JavaScript <https://github.com/cesanta/mjs>`_, який використовується в Лілці для виконання скриптів.
Основна прошивка має вбудовану підтримку запуску mJS-скриптів з SD-картки. Це означає, що ви можете скопіювати файли, написані діалектом mJS (з розширенням ``.js``) на SD-картку і виконувати їх на Лілці.
Keira має вбудовану підтримку запуску mJS-скриптів з SD-картки. Це означає, що ви можете скопіювати файли, написані діалектом mJS (з розширенням ``.js``) на SD-картку і виконувати їх на Лілці.

Я не впевнений, наскільки корисною буде ця функція, і ми рекомендуємо використовувати для цього Lua, яка має значно більше можливостей, ніж mJS. Проте ця функція є, і ви можете спробувати її, якщо вам цікаво.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
Запуск Хешбраун OS
==================
Запуск
======

Лілка постачається з готовою прошивкою, яка вміє багато різних речей. Ця прошивка використовується для демонстрації можливостей Лілки, а також як приклад для розробки власних програм.
Лілка постачається з готовою прошивкою Keira, яка вміє багато різних речей. Ця прошивка використовується для :ref:`демонстрації можливостей Лілки, а також як приклад для розробки власних програм <keira-firmware-features>`.

TODO: links to features

В цьому розділі ми розглянемо, як завантажити Хешбраун OS у в Лілку.
В цьому розділі ми розглянемо, як завантажити операційну систему Keira в Лілку.

Клонування репозиторію та побудова прошивки
-------------------------------------------
Expand All @@ -22,7 +20,7 @@ TODO: links to features
.. image:: ./images/09_clone_cropped.png
:width: 80%

2. Після клонування репозиторію перейдіть на вкладку **PlatformIO** та імпортуйте проєкт прошивки Хешбраун OS для Лілки. Для цього натисніть "**Open Project**" та виберіть директорію ``lilka/firmware/hashbrown``.
2. Після клонування репозиторію перейдіть на вкладку **PlatformIO** та імпортуйте проєкт прошивки Keira для Лілки. Для цього натисніть "**Open Project**" та виберіть директорію ``lilka/firmware/keira``.

.. image:: ./images/11_open_pio_project_cropped.png
:width: 80%
Expand Down Expand Up @@ -83,14 +81,14 @@ TODO: links to features

**Тепер вам не потрібно щоразу вручну переводити Лілку в режим завантаження, щоб завантажити нову прошивку!**

Крім прошивки Хешбраун OS, ви щойно завантажили в Лілку ще й програму-завантажувач (bootloader). Тепер ви можете завантажувати нові прошивки в Лілку безпосередньо з **PlatformIO**.
Крім прошивки Keira, ви щойно завантажили в Лілку ще й програму-завантажувач (bootloader). Тепер ви можете завантажувати нові прошивки в Лілку безпосередньо з **PlatformIO**.

Просто натисніть кнопку ``Upload`` в **PlatformIO** та вона автоматично переведе Лілку в режим завантаження та завантажить нову прошивку!

Вітаємо!
--------

Вітаємо, ви успішно налаштували середовище розробки та завантажили Хешбраун OS в Лілку!
Вітаємо, ви успішно налаштували середовище розробки та завантажили Keira в Лілку!

Ви можете потицяти Лілку та переконатися, що вона працює і спробувати різні демо. Також ви можете перейти на вкладку **Explorer** (``Ctrl`` + ``Shift`` + ``E``), відкрити файл ``src/main.cpp`` та поглянути, як виглядає код прошивки, яку ми щойно зібрали і запустили на Лілці.

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
17 changes: 17 additions & 0 deletions docs/manual/keira/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Keira OS
========

Ми написали для Лілки власну прошивку, яка називається **"Keira OS"** (**Операційна Система "Кіра"**) і включає в себе основні функції для демонстрації можливостей пристрою.

**Keira** - це операційна система, що базується на проєкті FreeRTOS. Вона підтримує мультизадачність, мережу, запуск Lua-програм та сторонніх прошивок з SD-карти та багато іншого.

Більше інформації про **Keira OS** - на `наступній сторінці <features>`_.

.. toctree::
:maxdepth: 3

features
flashing
sdcard
lua/intro
lua/reference/index
Loading

0 comments on commit 3979f4b

Please sign in to comment.