Перейти к содержимому

Для разработчиков прошивок

Добавьте свою прошивку в Updater CE.

Updater CE — это каталог сообщества и установщик кастомных прошивок. Разработайте свой проект на базе ROM, опубликуйте его как общедоступный репозиторий с правильными ресурсами выпуска, добавьте записи модели в slidia_manifest.xml, протестируйте фильтры модели и откройте запрос на включение. Один репозиторий может обслуживать каждую поддерживаемую модель.

Начать с базы ROM

Базовые ПЗУ предоставляют разработчикам специализированных прошивок чистую основу Android с включенными чипами беспроводной радиосвязи. На Y1 они включают Wi-Fi и GPS наряду с заводскими Bluetooth и FM; на Y2 они включают Wi-Fi, GPS и FM наряду с заводским Bluetooth.

Базовые ROM загрузки для разработки индивидуального встроенного ПО, каждая из которых включает версию Android и функции беспроводной связи.
СкачатьУстройствоAndroidБеспроводные функции
rom.zipY1 · Type AAndroid 4.2.2Добавляет Wi-Fi и GPS к заводским Bluetooth и FM (FM уже работает на Y1 с завода). Для Y1 игроков, поставлявшихся с ОС версии 2.0.0 или новее.
rom_type_b.zipY1 · Type BAndroid 4.2.2Добавляет Wi-Fi и GPS к заводским Bluetooth и FM (FM уже работает на Y1 с завода). Для Y1 игроков, поставлявшихся с ОС более ранней версии, чем 2.0.0.
rom_y2.zipY2Android 4.4.2Добавляет Wi-Fi, GPS и FM к заводскому Bluetooth. Радиочип Y2 полностью включен, поэтому FM здесь тоже доступен.

Эти образы представляют собой стандартную базу Android (AOSP) с включенной беспроводной связью устройства, поэтому специальная прошивка может добавлять сетевые функции вместо замены стека радиосвязи. Они являются практической отправной точкой для описанных ниже этапов публикации.

Используйте эти названия ресурсов выпуска

Имя файла является частью сигнала совместимости. Сохраняйте имена точными и помещайте ZIP-файлы в ресурсы выпуска проекта, а не только в дерево исходного кода репозитория.

Имена ZIP-файлов прошивки и поддерживаемые устройства
ОбъектУстройствоАппаратное обеспечениеЗначение
rom.zipY1Type AY1 устройства, поставляемые с ОС 2.0.0 или более поздней версии.
rom_type_b.zipY1Type BY1 устройства, поставляемые с ОС более ранней версии, чем 2.0.0.
rom_y2.zipY2Y2Полноустановочный пакет Y2 . Держите его отдельно от Y1 ресурсов.
Не переименовывайте пакет, чтобы он соответствовал другой модели. Y1 и Y2 используют разные файлы платформы MediaTek и конфигурацию прошивки. Опубликуйте пакет для оборудования, которое он действительно поддерживает.

Как работает соединение

Средство обновления CE считывает манифест как свой каталог. Каждый <package> строка сообщает ему имя проекта, репозиторий, модель и обработчик. Когда пользователь выбирает этот проект, Updater проверяет опубликованные выпуски репозитория и ищет rom*.zip объект.

Манифест

Называет проект и сопоставляет его с моделью. Y1 и Y2 нуждаются в отдельных строках, даже если они используют общий репозиторий.

Опубликованный выпуск

Содержит устанавливаемые ZIP-ресурсы. Один выпуск может содержать пакеты Y1 Type A, Y1 Type B и Y2 вместе.

Установка обновления CE

Использует выбранную модель для выбора соответствующего пакета и пути прошивки для конкретной модели. Пользователю не нужно угадывать имя файла.

Публикация проекта за пять шагов

  1. Форк репозитория Updater CE. Создайте свой собственный форк ryan-specter/updater-ce-neo, затем клонируйте свою вилку локально.
  2. Подготовьте общедоступный репозиторий прошивки. Убедитесь, что репозиторий является общедоступным и его версия содержит правильные ZIP-ресурсы. Вы можете положить rom.zip, rom_type_b.zip, и rom_y2.zip в одном выпуске, если они принадлежат одной и той же версии.
  3. Отредактируйте манифест. Открыть slidia_manifest.xml в корне вашей вилки Updater CE. Добавьте по одной строке для каждой модели, поддерживаемой выпуском (Y1 и Y2 — общая пара). repo значение — это репозиторий owner/repository; url — это общедоступная страница проекта.
  4. Протестируйте каталог. Запустите Updater из отредактированной кассы. Выберите Y1 и подтвердите, что в проекте показаны ресурсы Y1. Выберите Y2 и подтвердите, что отображается версия Y2. Проверьте Type A и Type B отдельно, если оба опубликованы.
  5. Откройте запрос на вытягивание. Отправьте изменение манифеста в свою вилку и откройте запрос на включение в вышестоящий репозиторий Updater CE. Укажите ссылку на проект, поддерживаемые модели, тег выпуска, названия активов и протестированные вами устройства.

Создайте строки манифеста

Заполните репозиторий и отметьте каждую модель, которую поддерживает релиз. Генератор пишет один <package> строка для каждой модели и включает только установленные вами атрибуты, поэтому результат соответствует текущему slidia_manifest.xml формат. Каждый атрибут, который читает Updater CE, доступен ниже — необязательные находятся под Больше возможностей.

Публичный GitHub репозиторий. Генератор извлекает owner/repository из URL-адреса.
Отображается в приложении и каталоге сайта.
Страница проекта или его примечаний к выпуску, ориентированная на пользователя.
Снимите этот флажок, чтобы использовать марку модели по умолчанию. SR1, Q3, Q5 и Q3e — это модели Timmkoo.
Устройства (по одной строке каждое)
Для модели, которой нет в списке выше. Известные модели сохраняют каталожное написание.
Флаги

Функция «Сохранить данные» предлагается только в том случае, если входящая и установленная прошивки одинаковы или имеют один и тот же файл. derivative корень. Используйте этот флаг только в том случае, если пользовательские данные действительно не могут быть перенесены.

Дополнительные параметры: значок, обложка, ресурсы выпуска, пост-установка и зеркала.

Иконка и произведение искусства

Выберите образ, который вы сохраните в репозитории. Это предварительно просматривает его и создает необработанный URL-адрес; он ничего не загружает.
Путь к зафиксированному образу относительно корня репозитория.
Прямой URL-адрес изображения. Если оно пусто, приложение использует версию updater.png или сгенерированный значок.

Дополнительный значок темной темы. image_dark является принятым псевдонимом.
Вторичное оформление, опробованное после выпуска изображения и icon.

Освободить активы

Одно имя для каждой выбранной модели. Оставьте пустым, чтобы использовать rom.zip на Y1 и rom_<model>.zip в другом месте.
Glob используется, когда почтовые индексы выпуска не названы. rom*.zip.
Glob для пакета Y1 Type A, если в его названии об этом не говорится.
Glob для пакета Y1 Type B, если в его названии об этом не говорится.
Скрыть запись из старых сборок Updater CE.

Ссылки, зеркала и семейство Keep Data

Открывается после успешной установки.
Необязательный второй шаг для многостраничного руководства по настройке.
через запятую *-mirror репозитории, в которых создаются пакеты Portable Flashing Zip.
Прошивка, на которой построен этот выпуск. Сопутствующие прошивки имеют общий раздел данных, который проверяет Keep Data.
Репозиторий приложений, выпуски которого описывают приложения в этой прошивке. Также необходима страница после установки.
Репозиторий приложения, из которого APK приложение загружается и устанавливается после прошивки.

Дополнения каталога

Стабильный идентификатор ссылок и сохраненных записей об установках. Модель добавляется автоматически при выборе нескольких моделей.
<package name="Your Firmware" brand="Innioasis" repo="your-account/your-firmware" device="Y1" url="https://github.com/your-account/your-firmware" type="img" handler="Custom Firmware" />
<package name="Your Firmware" brand="Innioasis" repo="your-account/your-firmware" device="Y2" url="https://github.com/your-account/your-firmware" type="img" handler="Custom Firmware" />

Загрузка последней версии манифеста…

Для общего репозитория одной строки недостаточно. Если строка Y2 отсутствует, пользователи Y2 не получат запись, соответствующую модели, даже если rom_y2.zip существует в релизе проекта. То же самое относится и к любой другой модели, поддерживаемой вашим выпуском.

Каждый атрибут, который читает манифест

Это атрибуты, которые понимают текущие сборки Updater CE. Генератор записывает только те, которые вы заполняете; в остальном приложение возвращается к разумным настройкам по умолчанию.

Атрибуты пакета slidia_manifest.xml и их значение
АтрибутНужныйЧто он делает
nameДаНазвание ПО указано в каталоге и на установочных карточках.
repoДаowner/repo. Приложение считывает выпуски этого репозитория GitHub.
deviceДаЦелевая модель, заглавные буквы (Y1, Y2, G1, Q3e, …). Оставьте одну запись для каждой модели.
urlРекомендуетсяСтраница проекта или примечания к выпуску, открытые из каталога.
type, handlerДа, на практикеtype="img" и handler="Custom Firmware". Другие типы и не встроенные обработчики пропускаются.
brandНеобязательныйБренд по каталогу (Innioasis, Timmkoo). Empty использует марку модели по умолчанию.
package_nameНеобязательныйОсвободить имя файла актива. По умолчанию rom.zip на Y1 и rom_<model>.zip на других моделях.
asset_patternНеобязательныйНечувствительный к регистру glob для выпусков, zip-архивы прошивки которых не названы. rom*.zip (например my-firmware-*.zip).
type_a_asset, type_b_assetНеобязательныйГлобы, которые идентифицируют zip-архивы Y1 Type A и Type B, когда их имена файлов не содержат обычных маркеров.
iconНеобязательныйURL-адрес логотипа. Используется после самого релиза updater.png / updater.jpgи как запасной вариант для каждого выпуска.
icon_darkНеобязательныйЛоготип в темной теме. image_dark является принятым псевдонимом.
imageНеобязательныйВторичный свет, опробован позже icon.
post_install, post_install2НеобязательныйСтраницы, открытые после успешной установки. Второй представляет собой многоэтапное руководство.
portable_zipsНеобязательныйчерез запятую *-mirror репозитории, в которых публикуются готовые к использованию переносимые пакеты.
derivativeНеобязательныйРепозиторий, из которого собрана прошивка. Прошивки с тем же производным корнем могут хранить пользовательские данные.
info_repoНеобязательныйРепозиторий приложений, выпуски которого описывают возможности встроенного ПО. Требует post_install или post_install2.
apk_repoНеобязательныйРепозиторий приложений, в котором APK приложение устанавливается после прошивки.
min_versionНеобязательныйСкройте запись, если программа обновления CE старше этой версии.
do_not_keep_dataНеобязательныйtrue (также 1 / yes) полностью блокирует Keep Data для этой прошивки.
slugНеобязательныйСтабильный идентификатор ссылок и сохраненных записей об установках. Генерируется на основе имени и модели, когда оно пусто.
descriptionНеобязательныйКраткое описание каталога. Это может быть значение атрибута или текст элемента.

Устаревшие имена по-прежнему читаются для совместимости: model, package, portable_zip, post_install_2, min_app_version и image_dark. Новые записи должны использовать текущие имена, указанные выше.

Отправьте строки как запрос на включение

  1. Скопируйте сгенерированные строки выше. Они уже соответствуют последнему формату манифеста.
  2. Редактировать slidia_manifest.xml в репозитории. Используйте ссылку редактирования ниже; хост репозитория автоматически создает для вас вилку и ветку.
  3. Вставьте строки непосредственно перед </slidia>, сохранение существующих записей без изменений.
  4. Перейдите в новую ветку (например add-your-firmware), затем откройте запрос на включение в репозиторий Updater CE.
  5. В PR включить ссылку на проект, поддерживаемые модели, тег выпуска, названия активов и протестированные вами устройства.

Названия моделей делайте прописными, используйте точный URL-адрес общедоступного репозитория и сохраняйте type="img" и handler="Custom Firmware" для записи прошивки.

Сделайте выпуск легко проверяемым

Дайте выпуску четкий тег и примечание к выпуску. Тег полезен для людей, но имена ресурсов ZIP — это то, что Updater CE использует для идентификации установочных пакетов.

Контрольный список релиза

  • Опубликуйте релиз публично.
  • Прикрепите ZIP-файлы в качестве ресурсов выпуска.
  • Укажите поддерживаемую модель и Type A или Type B в примечаниях.
  • Перечислите любую необходимую подготовку или известные ограничения.

Один релиз, три актива

Общий выпуск может содержать rom.zip, rom_type_b.zip, и rom_y2.zip. Программа обновлений классифицирует их отдельно и выбирает фильтры по модели и оборудованию.

Не группируйте догадки

Не включайте пакет Y1 под именем файла Y2 и не добавляйте непроверенные данные разброса, предварительного загрузчика или раздела только для того, чтобы актив появился.

Почему записи модели имеют значение при перепрошивке

Манифест — это не просто меню загрузки. После извлечения Updater CE использует решенную модель для подготовки соответствующего пути установки. Y1 и Y2 имеют разные файлы платформы, предварительные загрузчики, конфигурацию разброса и макеты устройств.

Участники должны предоставлять правильные файлы прошивки, а не смещения прошивки. Не редактируйте адреса разброса, файлы предварительной загрузки, файлы DA или команды разделов, чтобы обойти плохой пакет. Исправьте актив выпуска и протестируйте его на предполагаемой модели.

Прежде чем запросить слияние

  1. Проверьте XML с помощью синтаксического анализатора XML. Отсутствует цитата или завершение /> может скрыть каждую запись после нее.
  2. Запустите программу обновления из оформления заказа, чтобы она загружала локальный манифест перед удаленным обновлением.
  3. Проверьте Y1 и Y2 независимо. Убедитесь, что проект появляется только там, где поддерживается его пакет.
  4. Проверьте список выпусков на наличие rom.zip, rom_type_b.zip, и rom_y2.zip в зависимости от обстоятельств.
  5. Проверьте фактическую установку на предполагаемом устройстве с помощью надежного кабеля для передачи данных USB и плана восстановления для возврата к исходному программному обеспечению.
  6. В запросе на включение объясните, что вы тестировали. Не описывайте непроверенную модель как поддерживаемую.
python -c "from xml.etree import ElementTree as ET; ET.parse('slidia_manifest.xml'); print('manifest ok')"

Для локальной проверки запустите эту команду из корня репозитория. Он проверяет только синтаксис XML; это не доказывает, что выпуск содержит действительную прошивку или что устройство можно безопасно прошить.

Модификация навыков для ИИ-агентов

Репозиторий skills/ Каталог представляет собой основанную на источниках базу знаний для агентов, работающих с оборудованием, прошивкой, темами и приложениями Y1 и Y2. Каждый навык называет файлы проекта, из которых получены его утверждения, поэтому агент может проверить факт перед заменой устройства.

Аппаратное обеспечение

Y1 оборудование

MT6572, колесо в качестве ключевых событий, дисплей 480x360, каналы FM/аудио, хранилище и карта разделов Type A/B.

Аппаратное обеспечение

Y2 оборудование

Плата MT6582, дерево устройств, панели GC9503V/ST7701S, шины PMIC/DAC, разделы и загрузочный образ.

Прошивка

Пакеты прошивок

rom.zip анатомия, скаттер-файлы, контракты на обновление класса A и контрольный список выпуска.

Все навыки

Просмотрите папку навыков

Rockbox Y1/Y2, стандартные прошивки Android, Y2Linux, приложения для Android, средства запуска, примечания к выпуску и публикация на сайте.