y83 code / справочник

Установка

Раздел «Установка» проверяет, готово ли устройство к работе: установлен ли Termux, отвечает ли локальный сервер приложения, есть ли доступ к файлам и не убивает ли телефон фоновую работу.

раздел
Подсистемы приложения
пунктов возможностей
55
источник
docs/about/setup.md

Это не установщик, а приборная панель: она не чинит сама, а показывает, что не так, и даёт кнопки, которые ведут прямо в нужное место — настройки телефона или Termux.

Проверка идёт каждый раз при открытии экрана и при каждом возврате на него с другого экрана, так что данные не устаревают.

Возможности

  • Главная карточка с итогом. Заголовок, короткое объяснение и строка из трёх фактов: Termux, серверная часть, интернет. Цвет и надпись зависят от результата.
  • Одна большая кнопка в главной карточке — то главное действие, которое сейчас нужно: перепроверить, скачать Termux или переподключиться.
  • Раздел // bootstrap — Termux и серверная часть: установлен ли Termux, отвечает ли сервер.
  • Кнопка Install у строки Termux, если его нет. Кнопка Download Termux с прямой ссылкой на файл установки.
  • Карточка с командой починки, когда Termux есть, а сервер не отвечает: сама команда, кнопка Copy и кнопка Open Termux.
  • Кнопка Reconnect — заново связаться с Termux и сразу перепроверить всё.
  • Кнопка Open Termux — открыть Termux, когда с ним всё в порядке.
  • Раздел // file access & reliability — доступы и надёжность фоновой работы.
  • Строка File access — доступ приложения к файлам телефона, с кнопкой Grant.
  • Строка Termux storage — доступ Termux к фотографиям, загрузкам и документам. Показывается только если Termux установлен и доступ ещё не взят.
  • Карточка с командой выдачи доступа Termux: сама команда, Copy и Open Termux.
  • Строка Battery optimization — не выключает ли система фоновое приложение. Кнопка Settings, если приложение не исключено из оптимизации.
  • Строка Battery saver — включён ли режим экономии. Если включён, строка желтеет и появляется кнопка Settings.
  • Строка про политику производителя — предупреждение, характерное для конкретной фирмы, с кнопкой Open. Показывается только на известных производителях, на остальных её нет.
  • Дополнительная строка про настройки батареи производителя — только на Xiaomi и Huawei.
  • Строка Notifications — разрешение на уведомления. Показывается на Android 13 и новее.
  • Строка Overlay — разрешение на оверлей, чтобы скрытый веб-поиск не выскакивал на передний план.
  • Раздел // diagnostics & recovery — интернет, серверная часть и отчёт.
  • Строка Network с кнопкой Recheck, если интернета нет.
  • Строка Backend с задержкой отклика в миллисекундах и кнопкой Reconnect.
  • Строка времени проверки и версии серверной части.
  • Кнопка Copy report — кладёт в буфер полный отчёт о проверке.
  • Кнопка Refresh — перепроверить всё заново.
  • Ссылки на источники Termux — GitHub и F-Droid.
  • Кнопка обновления в шапке — та же перепроверка, но она гаснет, пока идёт проверка или подключение.

Технические данные

ПараметрЗначение
Итоговых состояний экрана6, перечислены ниже
Состояний у отдельной строки4: ok, action required, advisory, unknown
Что проверяется10 пунктов, перечислены в разделе ниже
Когда идёт проверкапри открытии экрана и при каждом возврате на него
Проверка сервераодин запрос с замером задержки
Проверка доступа Termuxподсчёт содержимого общей папки
Команда починкискачивает установщик и запускает его в Termux
Команда выдачи доступа Termuxодна строка, выполняется внутри Termux
Строк в отчёте16
Время в отчёте и шапкечасы и минуты, без даты
На этом устройстве сейчассерверная часть 0.8.254, задержка около 4 мс
Производитель устройстваXiaomi, поэтому показываются обе его строки
Доступ Termux к файламвыдан, в общей папке 18 папок

Как читать главную карточку

Заголовок и цвет говорит обо всём сразу:

  • checking — идёт проверка, цвет бирюзовый.
  • ready — всё в порядке, зелёный.
  • needs setup — Termux не установлен, жёлтый.
  • attention — что-то не то с доступами, жёлтый.
  • no network — нет интернета, красный.
  • backend offline — серверная часть не отвечает, красный.

Под заголовком всегда идёт короткое объяснение, что делать. Ещё ниже — строка из трёх слов: Termux, сервер, сеть. Кнопка под ними одна, и она ведёт ровно туда, куда нужно сейчас: перепроверить, скачать Termux или переподключиться.

Статусы считаются строго по порядку. Сначала сеть: без неё остальные проверки смысла не имеют. Потом Termux: без него серверную часть не починить. Потом сам сервер. И только потом доступы. Поэтому «нужно внимание» — это уже последняя стадия, когда с сетью всё хорошо, а сервер отвечает.

Что именно проверяется

Десять пунктов, и каждый виден отдельной строкой:

  1. Termux установлен.
  2. Серверная часть отвечает, с замером задержки.
  3. Интернет есть.
  4. Приложению выдан доступ к файлам телефона.
  5. Termux выдан доступ к файлам — фотографиям, загрузкам и документам.
  6. Приложение исключено из оптимизации батареи.
  7. Режим экономии батареи выключен.
  8. Уведомления разрешены — только на Android 13 и новее.
  9. Оверлей разрешён.
  10. Производитель телефона известен — Xiaomi, Huawei, Honor или Samsung.

Итоговых состояний экрана шесть: проверка идёт, всё готово, нужен Termux, нет сети, сервер не отвечает, нужно внимание.

Как читать строки проверок

У каждой строки слева значок, справа — слово:

  • ok — зелёная галочка, всё выдано.
  • action required — красный крест, нужно ваше действие.
  • advisory — жёлтый кружок, работать будет, но лучше поправить.
  • unknown — серый значок, проверить не удалось, а не «выдано».

Слово справа заменяется кнопкой, если действие есть. Само наличие кнопки сказать не только «сломалось», но и что с этим можно сделать прямо сейчас.

Что значит каждая строка

File access — право приложения читать и править файлы на телефоне. Без него агенты не смогут работать с файлами. Выдаётся кнопкой Grant.

Termux storage — право самого Termux до фото, загрузок и документов. Проверяется отдельно от доступа приложения. Пока выдано, строка вообще не показывается — чтобы не пугать зря. Если Termux ещё не подключился, проверка даёт «неизвестно», а не «нет».

Battery optimization — система не душит лишнее приложение, когда экран выключен. Это самая частая причина того, что фоновые сервисы умирают непонятно почему. После выдачи кнопка исчезает.

Battery saver — включён ли режим экономии. Он не считается поломкой, но фоновые агенты в нём могут остановиться.

Manufacturer background policy — предупреждение под фирму: какие именно настройки её телефон уважает и какие нет. Для Xiaomi речь про автозапуск, для Huawei — про разрешение на старт, для Samsung — про «спящие» приложения. Кнопка Open ведёт в нужное место, а если производитель такого экрана не знает — в общие настройки приложения.

Manufacturer battery settings — вторая строка того же рода, только для Xiaomi и Huawei: снять жёсткие ограничения батареи для этого приложения.

Notifications — уведомления о завершении долгих задач. Не обязательны, но удобны: без них долгий ход выглядит как зависший.

Overlay — право рисовать поверх других окон. Нужно, чтобы скрытый веб-поиск не выскакивал на передний план и не мешал работать.

Про два разных доступа

Их легко спутать, поэтому на экране они стоят рядом, но означают разное.

Доступ приложения — это что может делать Y83 Code. Доступ Termux — это что может делать Termux, потому что именно он запускает команды, которые видят файлы. Одного без другого не хватает: без первого агенты слепы, без второго терминал не видит фотографии и загрузки.

Про команду починки

Когда Termux есть, а сервер не отвечает, экран показывает команду: она скачивает установщик и запускает его прямо в Termux. Кнопка Copy кладёт её в буфер, кнопка Open Termux открывает приложение — вставляйте и жмите Enter.

Экран ничего не выполняет сам. Всё, что чинит, делает эта команда внутри Termux. Прямых кнопок «починить сервер» здесь нет намеренно: молчаливый ремонт окружения оборачивается проблемами, которые потом не отличить от настоящей поломки.

Если Termux не установлен, команда не показывается вовсе — сначала предлагают его скачать.

Про отчёт

Кнопка Copy report собирает 16 строк в текст: версия приложения и её номер, устройство, версия Android, производитель, Termux, серверная часть и её версия, задержка ответа, сеть, оба доступа к файлам, оптимизация батареи, режим экономии, уведомления, оверлей и время проверки.

Отчёт копируется, а не отправляется. Куда его передать — решаете вы: вложить в обращение, показать агенту или оставить себе. Агент такой же отчёт может собрать и сам, но разрешения телефон агент проверить не может.

Что агент умеет

Агент может открыть этот экран через мост командой открытия экрана setup и прочитать его содержимое командой чтения интерфейса, если приложение сейчас на экране.

Дальше важнее другое: у агента есть собственные инструменты на весь тот же цикл починки — проверить живость серверной части, собрать её заново, заменить работающий файл, обновить окружение, выкатить изменения на сервер. Именно ими он и чинит, а кнопки этого экрана нужны человеку.

Что агент может проверить сам: жив ли сервер и какая у него версия, есть ли у Termux папка доступа к файлам, какие версии стоят на устройстве.

Чего агент проверить не может: выданы ли разрешения на файлы, уведомления, оверлей и исключение из оптимизации батареи. Это настройки самого телефона, живут они в системе, и менять их должен человек.

Ограничения

  • Экран ничего не чинит. Всё исправление — либо кнопка, которая открывает настройки телефона, либо команда, которую вы вводите в Termux руками.
  • Без интернета проверка не идёт дальше первого шага и показывает «нет сети». Серверная часть при этом не опрашивается, остальные строки проверяются как обычно — просто итог всё равно останется «нет сети».
  • Проверка серверной части идёт всегда, независимо от того, установлен ли Termux. А вот строка доступа Termux без живого сервера остаётся «неизвестно»: проверять её нечем.
  • Доступ Termux нельзя проверить, пока серверная часть не отвечает: проверка идёт через неё. В этом случае строка получает статус «неизвестно».
  • Разрешения на уведомления проверяются только на Android 13 и новее. На старых версиях строка просто не появляется.
  • Строка про производителя есть только на Xiaomi, Huawei, Honor и Samsung. На других телефонах её нет — это не ошибка.
  • На Xiaomi и Huawei показывается сразу две строки производителя, на остальных известных — одна.
  • Кнопки в настройках телефона открывают разные экраны на разных прошивках. Если нужного экрана нет, приложение откроет общие настройки — искать придётся там.
  • Отчёт показывает время только до минут, без даты.
  • Все строки на экране английские.

Источник: docs/about/setup.md. Страница собрана из документации проекта при сборке сайта — без пересказа.