本文へスキップ

ファームウェア開発者向け

ファームウェアを Updater CE に追加します。

Updater CE は、カスタム ファームウェアのコミュニティ カタログおよびインストーラーです。ベース ROM からプロジェクトを開発し、正しいリリース アセットを含むパブリック リポジトリとして公開し、モデル エントリを slidia_manifest.xml、モデル フィルターをテストし、プル リクエストを開きます。 1 つのリポジトリがサポートするすべてのモデルに対応できます。

ベース ROM から開始します

ベース ROM は、カスタム ファームウェア開発者に、ワイヤレス無線チップが有効になったクリーンな Android 基盤を提供します。 Y1 では、工場出荷時の Bluetooth と FM に加えて、Wi-Fi と GPS が有効になります。 Y2 では、工場出荷時の Bluetooth に加えて Wi-Fi、GPS、FM が有効になります。

カスタム ファームウェア開発用のベース ROM ダウンロード。Android バージョンとそれぞれで有効になるワイヤレス機能が含まれます。
ダウンロードデバイスAndroidワイヤレス機能
rom.zipY1 · Type AAndroid 4.2.2Wi-Fi と GPS を工場出荷時の Bluetooth と FM に追加します (FM は工場出荷時に Y1 ですでに動作しています)。 OS 2.0.0 以降で出荷された Y1 プレーヤーの場合。
rom_type_b.zipY1 · Type BAndroid 4.2.2Wi-Fi と GPS を工場出荷時の Bluetooth と FM に追加します (FM は工場出荷時に Y1 ですでに動作しています)。 2.0.0 より前の OS で出荷された Y1 プレーヤーの場合。
rom_y2.zipY2Android 4.4.2工場出荷時の Bluetooth に Wi-Fi、GPS、FM を追加します。 Y2 無線チップが完全に有効になっているため、ここでも FM が利用可能です。

これらのイメージは、デバイスの無線無線が有効になっているストック Android ベース (AOSP) であるため、無線スタックを置き換えるのではなく、カスタム ファームウェアでネットワーク機能を追加できます。これらは、以下の公開手順の実際的な開始点となります。

これらのリリースアセット名を使用してください

ファイル名は互換性シグナルの一部です。名前を正確に保ち、​​ZIP ファイルをリポジトリ ソース ツリーだけでなくプロジェクトのリリース アセットに配置します。

ファームウェア ZIP アセット名とサポートされるデバイス
資産デバイスハードウェア意味
rom.zipY1Type AOS 2.0.0 以降が搭載された Y1 デバイス。
rom_type_b.zipY1Type BY1 デバイスは 2.0.0 より前の OS を搭載して出荷されました。
rom_y2.zipY2Y2Y2 フルインストール パッケージ。 Y1 アセットとは別にしてください。
別のモデルに適合させるためにパッケージの名前を変更しないでください。 Y1 と Y2 は、異なる MediaTek プラットフォーム ファイルとフラッシュ構成を使用します。実際にサポートするハードウェアのパッケージを公開します。

接続の仕組み

Updater CE はマニフェストをカタログとして読み取ります。それぞれ <package> この行は、プロジェクト名、リポジトリ、モデル、およびハンドラーを示します。ユーザーがそのプロジェクトを選択すると、アップデータはリポジトリの公開リリースをチェックし、 rom*.zip 資産。

マニフェスト

プロジェクトに名前を付け、モデルにマップします。 Y1 と Y2 は、リポジトリを共有する場合でも、別々の行が必要です。

公開されたリリース

インストール可能な ZIP アセットが含まれています。 1 つのリリースには、Y1、Type A、Y1、Type B、および Y2 のパッケージが一緒に含まれる場合があります。

Updater CE インストール

選択したモデルを使用して、一致するパッケージとモデル固有のフラッシュ パスを選択します。ユーザーはファイル名を推測する必要はありません。

5 つのステップでプロジェクトを公開する

  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 フォークのルートにあります。リリースがサポートするモデルごとに 1 行を追加します (Y1 と Y2 が共通のペアです)。の repo 値はリポジトリの値です owner/repository; url 公開プロジェクトページです。
  4. カタログをテストします。 編集したチェックアウトからアップデーターを実行します。 Y1 を選択し、プロジェクトに Y1 アセットが表示されていることを確認します。 Y2を選択し、Y2のリリースが表示されていることを確認します。 Type AとType Bが両方公開されている場合は個別に確認してください。
  5. プルリクエストを開きます。 マニフェストの変更をフォークにプッシュし、上流の Updater CE リポジトリに対してプル リクエストを開きます。プロジェクトのリンク、サポートされているモデル、リリース タグ、アセット名、テストしたデバイスを含めます。

マニフェスト行を生成する

リポジトリに入力し、リリースがサポートするすべてのモデルにチェックを入れます。ジェネレーターは 1 つを書き込みます <package> モデルごとに行に分けられ、設定した属性のみが含まれるため、結果は現在のものと一致します。 slidia_manifest.xml 形式。 Updater CE で読み取られるすべての属性は以下で利用可能です。オプションのものは以下にあります。 その他のオプション.

パブリック GitHub リポジトリ。ジェネレーターは抽出します owner/repository URLから。
アプリとサイトのカタログに表示されます。
プロジェクトまたはそのリリース ノートの人向けページ。
モデルのデフォルトのブランドを使用するには、これをクリアします。 SR1、Q3、Q5、Q3e は Timmkoo モデルです。
デバイス (各 1 行)
上記以外の機種の場合。既知のモデルはカタログの綴りのままです。
フラグ

Keep Data は、受信したファームウェアとインストールされたファームウェアが同じであるか、同じファームウェアを共有している場合にのみ提供されます。 derivative 根。このフラグは、ユーザーデータが本当に引き継がれない場合にのみ使用してください。

その他のオプション: アイコン、アートワーク、リリース アセット、ポストインストール、ミラー

アイコンとアートワーク

リポジトリにコミットするイメージを選択します。これにより、それがプレビューされ、生の URL が構築されます。何もアップロードしません。
リポジトリのルートを基準とした、コミットされたイメージへのパス。
画像の直接 URL。空の場合、アプリはリリースの updater.png または生成されたアイコン。

オプションのダークテーマアイコン。 image_dark は受け入れられるエイリアスです。
二次アートワーク、リリース後に試してみた画像と icon.

アセットをリリースする

選択したモデルごとに 1 つの名前。空のままにして使用します rom.zip Y1 と rom_<model>.zip 他の場所で。
リリースの zip に名前が付けられていない場合に使用される Glob rom*.zip.
Y1 Type A パッケージの名前が記載されていない場合は、そのパッケージをグロブします。
Y1 Type B パッケージの名前が記載されていない場合は、そのパッケージをグロブします。
古い Updater CE ビルドのエントリを非表示にします。

リンク、ミラー、Keep Data ファミリ

インストールが成功した後に開きます。
複数ページのセットアップ ガイドのオプションの 2 番目のステップ。
カンマ区切り *-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" />

最新のマニフェストをロードしています…

共有リポジトリには 1 行では不十分です。 Y2 行が欠落している場合、Y2 ユーザーは次のような場合でもモデルに一致するエントリを取得できません。 rom_y2.zip プロジェクトのリリースに存在します。リリースがサポートする他のすべてのモデルにも同じことが当てはまります。

マニフェストが読み取るすべての属性

これらは、現在の Updater CE ビルドが理解する属性です。ジェネレーターは、ユーザーが入力したもののみを書き込みます。アプリは残りの部分について適切なデフォルトに戻ります。

slidia_manifest.xml パッケージの属性とその意味
属性必要です何をするのか
nameはいカタログおよびインストールカードに記載されているソフトウェア名。
repoはいowner/repo。アプリはそのリポジトリの GitHub リリースを読み取ります。
deviceはい対象モデル、大文字(Y1, Y2, G1, Q3e、…)。モデルごとに 1 つのエントリを保持します。
url推奨カタログから開いたプロジェクト ページまたはリリース ノート。
type, handlerはい、実際にはtype="img" そして handler="Custom Firmware"。他のタイプおよび非ファームウェア ハンドラーはスキップされます。
brandオプションカタログブランド(Innioasis, Timmkoo)。 Empty では、モデルのデフォルトのブランドが使用されます。
package_nameオプションリリースアセットのファイル名。デフォルトは rom.zip Y1 と rom_<model>.zip 他のモデルでは。
asset_patternオプションファームウェア zip に名前が付けられていないリリースでは、大文字と小文字を区別しない glob rom*.zip (例えば my-firmware-*.zip).
type_a_asset, type_b_assetオプションファイル名に通常のマーカーが含まれていない場合に、Y1 Type A および Type B zip を識別するグロブ。
iconオプションロゴの URL。リリース独自の後に使用される updater.png / updater.jpg、そしてすべてのリリースのフォールバックとして。
icon_darkオプションダークテーマのロゴ。 image_dark は受け入れられるエイリアスです。
imageオプション二次的なライト アートワーク、その後に試行 icon.
post_install, post_install2オプションインストールが成功した後に開かれたページ。 2 番目のガイドでは、複数のステップのガイドについて説明します。
portable_zipsオプションカンマ区切り *-mirror すぐに実行できるポータブル パッケージを公開するリポジトリ。
derivativeオプションファームウェアの構築元となるリポジトリ。同じ派生ルートを持つファームウェアはユーザー データを保持できます。
info_repoオプションリリースには、ファームウェアが展開する内容が記述されているアプリ リポジトリ。必要 post_install または post_install2.
apk_repoオプションファームウェアの後にアプリが APK インストールされるアプリ リポジトリ。
min_versionオプションUpdater CE がこのバージョンより古い場合、エントリを非表示にします。
do_not_keep_dataオプションtrue (また 1 / yes) このファームウェアのデータ保持を完全にブロックします。
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" ファームウェアエントリの場合。

リリースを簡単に確認できるようにする

リリースに明確なタグとリリース ノートを付けます。このタグは人々にとって便利ですが、Updater CE がインストール パッケージを識別するために使用するのは ZIP アセット名です。

リリースチェックリスト

  • リリースを公開します。
  • ZIP ファイルをリリース アセットとして添付します。
  • 備考欄に対応機種とType AまたはType Bを記載してください。
  • 必要な準備や既知の制限を列挙します。

1 つのリリース、3 つのアセット

共有リリースには以下を含めることができます rom.zip, rom_type_b.zip、そして rom_y2.zip。アップデーターはそれらを個別に分類し、モデルとハードウェアのフィルターから選択します。

推測をまとめないでください

Y2 ファイル名の下に Y1 パッケージを含めたり、アセットを表示するためだけに未テストのスキャッター、プリローダー、またはパーティション データを追加したりしないでください。

フラッシュ中にモデルのエントリが重要な理由

マニフェストは単なるダウンロード メニューではありません。抽出後、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 構文のみを検証します。リリースに有効なファームウェアが含まれていること、またはデバイスが安全にフラッシュできることを証明するものではありません。

AIエージェントのModスキル

リポジトリの skills/ directory は、Y1 および Y2 のハードウェア、ファームウェア、テーマ、アプリを扱うエージェント向けのソースベースのナレッジ ベースです。各スキルはそのクレームの元となるプロジェクト ファイルに名前を付けるため、エージェントはデバイスを変更する前に事実を確認できます。

ここから始めましょう

スキルインデックスと安全ルール

スキルをロードする方法、ファクトが適用されるモデル、およびパッケージが書き込むべきパーティション。

ハードウェア

Y1 ハードウェア

MT6572、キー イベントとしてのホイール、480x360 ディスプレイ、FM/オーディオ パス、ストレージ、および Type A/B パーティション マップ。

ハードウェア

Y2 ハードウェア

MT6582 ボード、デバイス ツリー、GC9503V/ST7701S パネル、PMIC/DAC レール、パーティション、ブート イメージ。

ファームウェア

ファームウェアパッケージ

rom.zip の解剖学、スキャッタ ファイル、クラス A 更新契約、およびリリース チェックリスト。

すべてのスキル

スキルフォルダーを参照する

Rockbox Y1/Y2、ストック Android ROM、Y2Linux、Android アプリ、ランチャー、リリース ノート、サイト公開。