Ir para o conteúdo

Para desenvolvedores de firmware

Adicione seu firmware a Updater CE.

Updater CE é o catálogo da comunidade e instalador para firmware personalizado. Desenvolva seu projeto a partir de uma base ROM, publique-o como um repositório público com os ativos de lançamento corretos, adicione as entradas do modelo ao slidia_manifest.xml, test the model filters, and open a pull request. One repository can serve every model it supports.

Comece de uma base ROM

As ROMs básicas oferecem aos desenvolvedores de firmware personalizado uma base Android limpa com os chips de rádio sem fio habilitados. No Y1 eles habilitam Wi-Fi e GPS junto com Bluetooth e FM de fábrica; no Y2 eles habilitam Wi-Fi, GPS e FM junto com o Bluetooth de fábrica.

Downloads básicos ROM para desenvolvimento de firmware personalizado, com a versão Android e recursos sem fio que cada um permite
BaixarDispositivoAndroidRecursos sem fio
rom.zipY1 · Type AAndroid 4.2.2Adiciona Wi-Fi e GPS ao Bluetooth e FM de fábrica (FM já funciona no Y1 de fábrica). Para Y1 players fornecidos com OS 2.0.0 ou posterior.
rom_type_b.zipY1 · Type BAndroid 4.2.2Adiciona Wi-Fi e GPS ao Bluetooth e FM de fábrica (FM já funciona no Y1 de fábrica). Para Y1 players fornecidos com um sistema operacional anterior a 2.0.0.
rom_y2.zipY2Android 4.4.2Adiciona Wi-Fi, GPS e FM ao Bluetooth de fábrica. O chip de rádio Y2 está totalmente habilitado, então FM também está disponível aqui.

Essas imagens são a base padrão do Android (AOSP) com os rádios sem fio do dispositivo habilitados, portanto, um firmware personalizado pode adicionar recursos de rede em vez de substituir a pilha de rádio. Eles são o ponto de partida prático para as etapas de publicação abaixo.

Use estes nomes de recursos de lançamento

O nome do arquivo faz parte do sinal de compatibilidade. Mantenha os nomes exatos e coloque os arquivos ZIP nos ativos de lançamento do projeto, não apenas na árvore de origem do repositório.

Nomes de ativos ZIP de firmware e dispositivos suportados
AtivoDispositivoHardwareSignificado
rom.zipY1Type AY1 dispositivos fornecidos com OS 2.0.0 ou posterior.
rom_type_b.zipY1Type BY1 dispositivos fornecidos com um sistema operacional anterior a 2.0.0.
rom_y2.zipY2Y2O pacote de instalação completa Y2. Mantenha-o separado dos Y1 ativos.
Não renomeie um pacote para ajustá-lo a outro modelo. Y1 e Y2 usam arquivos de plataforma MediaTek diferentes e configurações de atualização. Publique o pacote para o hardware que ele realmente suporta.

Como funciona a conexão

Updater CE lê o manifesto como seu catálogo. Cada <package> linha informa o nome do projeto, repositório, modelo e manipulador. Quando um usuário escolhe esse projeto, o Updater verifica as versões publicadas do repositório e procura um rom*.zip ativo.

Manifesto

Nomeia o projeto e o mapeia para um modelo. Y1 e Y2 precisam de linhas separadas, mesmo quando compartilham um repositório.

Lançamento publicado

Contém os ativos ZIP instaláveis. Uma única versão pode conter os pacotes Y1 Type A, Y1 Type B e Y2 juntos.

Updater CE instalar

Usa o modelo selecionado para escolher o pacote correspondente e o caminho intermitente específico do modelo. O usuário não deve ter que adivinhar o nome do arquivo.

Publique um projeto em cinco etapas

  1. Bifurque o repositório Updater CE. Crie seu próprio garfo de ryan-specter/updater-ce-neoe clone seu fork localmente.
  2. Prepare um repositório de firmware público. Certifique-se de que o repositório seja público e que sua versão contenha os ativos ZIP corretos. Você pode colocar rom.zip, rom_type_b.zip, e rom_y2.zip na mesma versão quando pertencem à mesma versão.
  3. Edite o manifesto. Abrir slidia_manifest.xml na raiz do seu fork Updater CE. Adicione uma linha para cada modelo que a versão suporta (Y1 e Y2 são o par comum). O repo o valor é o do repositório owner/repository; url é a página pública do projeto.
  4. Teste o catálogo. Execute o Updater no checkout editado. Selecione Y1 e confirme se o projeto mostra os ativos Y1. Selecione Y2 e confirme que mostra a liberação Y2. Verifique Type A e Type B separadamente quando ambos forem publicados.
  5. Abra uma solicitação pull. Envie a alteração do manifesto para seu fork e abra uma solicitação pull no repositório upstream Updater CE. Inclua o link do projeto, os modelos suportados, a etiqueta de lançamento, os nomes dos ativos e os dispositivos que você testou.

Gere suas linhas de manifesto

Preencha o repositório e marque todos os modelos que o lançamento suporta. O gerador escreve um <package> linha por modelo e inclui apenas os atributos que você definiu, então o resultado corresponde ao atual slidia_manifest.xml formatar. Cada leitura de atributo Updater CE está disponível abaixo - os opcionais estão em Mais opções.

O repositório público GitHub. O gerador extrai owner/repository do URL.
Exibido no aplicativo e no catálogo do site.
Página voltada para humanos do projeto ou suas notas de lançamento.
Desmarque para usar a marca padrão do modelo. SR1, Q3, Q5 e Q3e são modelos Timmkoo.
Dispositivos (uma linha cada)
Para um modelo que não está listado acima. Os modelos conhecidos mantêm a grafia do catálogo.
Bandeiras

Keep Data só é oferecido quando o firmware recebido e o firmware instalado são iguais ou compartilham um derivative raiz. Use o sinalizador somente quando os dados do usuário realmente não puderem ser transferidos.

Mais opções: ícone, arte, recursos de lançamento, pós-instalação e espelhos

Ícone e arte

Escolha a imagem que você irá enviar para o repositório. Isso o visualiza e cria seu URL bruto; não carrega nada.
Caminho para a imagem confirmada, relativa à raiz do repositório.
Um URL de imagem direto. Quando vazio, o aplicativo usa o lançamento updater.png ou um ícone gerado.

Ícone opcional de tema escuro. image_dark é um alias aceito.
Arte secundária, tentada após a imagem de lançamento e icon.

Liberar ativos

Um nome para cada modelo selecionado. Deixe vazio para usar rom.zip em Y1 e rom_<model>.zip em outro lugar.
Glob usado quando os zips do lançamento não são nomeados rom*.zip.
Glob para o pacote Y1 Type A quando seu nome não diz isso.
Glob para o pacote Y1 Type B quando seu nome não diz isso.
Oculte a entrada de compilações Updater CE mais antigas.

Links, espelhos e família Keep Data

Aberto após uma instalação bem-sucedida.
Segunda etapa opcional para um guia de configuração de várias páginas.
Separados por vírgula *-mirror repositórios que constroem pacotes Portable Flashing Zip.
O firmware a partir do qual esta versão foi criada. Firmwares relacionados compartilham uma partição de dados, que é o que o Keep Data verifica.
App repo whose releases describe the apps in this firmware. Ele também precisa de uma página de pós-instalação.
Repositório de aplicativos cujo APK o aplicativo é baixado e instalado após o firmware.

Extras do catálogo

Identificador estável para links e registros de instalação salvos. O modelo é anexado automaticamente quando vários modelos são selecionados.
<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" />

Carregando o manifesto mais recente…

Uma linha não é suficiente para um repositório compartilhado. Se a linha Y2 estiver faltando, os usuários Y2 não obterão uma entrada correspondente ao modelo, mesmo quando rom_y2.zip existe no lançamento do projeto. The same is true for every other model your release supports.

Cada atributo que o manifesto lê

Estes são os atributos que as compilações atuais Updater CE entendem. O gerador grava apenas aqueles que você preenche; o aplicativo volta aos padrões sensatos para o resto.

Atributos do pacote slidia_manifest.xml e seu significado
AtributoNecessárioO que isso faz
nameSimNome do software mostrado no catálogo e nos cartões de instalação.
repoSimowner/repo. O aplicativo lê as versões GitHub desse repositório.
deviceSimModelo de destino, letras maiúsculas (Y1, Y2, G1, Q3e,…). Mantenha uma entrada por modelo.
urlRecomendadoPágina do projeto ou notas de lançamento abertas no catálogo.
type, handlerSim, na práticatype="img" e handler="Custom Firmware". Outros tipos e manipuladores que não sejam de firmware são ignorados.
brandOpcionalMarca do catálogo (Innioasis, Timmkoo). Vazio usa a marca padrão do modelo.
package_nameOpcionalLiberar nome do arquivo do ativo. O padrão é rom.zip em Y1 e rom_<model>.zip em outros modelos.
asset_patternOpcionalGlob que não diferencia maiúsculas de minúsculas para versões cujos zips de firmware não são nomeados rom*.zip (por exemplo my-firmware-*.zip).
type_a_asset, type_b_assetOpcionalGlobs que identificam os zips Y1 Type A e Type B quando seus nomes de arquivos não contêm os marcadores usuais.
iconOpcionalURL do logotipo. Usado após o próprio lançamento updater.png / updater.jpge como substituto para cada versão.
icon_darkOpcionalLogotipo com tema escuro. image_dark é um alias aceito.
imageOpcionalArte de luz secundária, tentada depois icon.
post_install, post_install2OpcionalPágina(s) abertas após uma instalação bem-sucedida. O segundo cobre um guia de várias etapas.
portable_zipsOpcionalSeparados por vírgula *-mirror repositórios que publicam pacotes portáteis prontos para execução.
derivativeOpcionalRepositório a partir do qual o firmware é construído. Firmware with the same derivative root can keep user data.
info_repoOpcionalRepositório de aplicativos cujas versões descrevem o que o firmware implanta. Requer post_install ou post_install2.
apk_repoOpcionalRepositório de aplicativos cujo APK o aplicativo é instalado após o firmware.
min_versionOpcionalOculte a entrada quando Updater CE for anterior a esta versão.
do_not_keep_dataOpcionaltrue (também 1 / yes) bloqueia Keep Data completamente para este firmware.
slugOpcionalStable identifier for links and saved install records. Gerado a partir do nome e do modelo quando vazio.
descriptionOpcionalBreve descrição do catálogo. Pode ser o valor do atributo ou o texto do elemento.

Os nomes legados ainda são lidos para fins de compatibilidade: model, package, portable_zip, post_install_2, min_app_version e image_dark. Novas entradas devem usar os nomes atuais acima.

Envie as linhas como uma solicitação pull

  1. Copie as linhas geradas acima. Eles já correspondem ao formato de manifesto mais recente.
  2. Editar slidia_manifest.xml no repositório. Use o link de edição abaixo; o host do repositório cria um fork e um branch para você automaticamente.
  3. Cole as linhas antes </slidia>, mantendo as entradas existentes inalteradas.
  4. Comprometa-se com uma nova filial (por exemplo add-your-firmware) e, em seguida, abra uma solicitação pull no repositório Updater CE.
  5. No PR, inclua o link do projeto, modelos suportados, etiqueta de lançamento, nomes de ativos e os dispositivos que você testou.

Mantenha os nomes dos modelos em maiúsculas, use a URL exata do seu repositório público e mantenha type="img" e handler="Custom Firmware" para uma entrada de firmware.

Torne o lançamento fácil de verificar

Dê ao lançamento uma etiqueta clara e uma nota de lançamento. A tag é útil para as pessoas, mas os nomes dos ativos ZIP são o que Updater CE usa para identificar os pacotes de instalação.

Lista de verificação de lançamento

  • Publique o lançamento publicamente.
  • Anexe os arquivos ZIP como recursos de lançamento.
  • Indique o modelo suportado e Type A ou Type B nas notas.
  • Liste qualquer preparação necessária ou limites conhecidos.

Um lançamento, três ativos

Uma versão compartilhada pode conter rom.zip, rom_type_b.zip, e rom_y2.zip. O atualizador os classifica separadamente e escolhe entre os filtros de modelo e hardware.

Não agrupe suposições

Não inclua um pacote Y1 sob o nome do arquivo Y2, nem adicione dados de dispersão, pré-carregador ou partição não testados apenas para fazer um ativo aparecer.

Por que as entradas do modelo são importantes durante o flash

O manifesto não é apenas um menu de download. Após a extração, Updater CE usa o modelo resolvido para preparar o caminho de instalação correspondente. Y1 e Y2 têm diferentes arquivos de plataforma, pré-carregadores, configuração de dispersão e layouts de dispositivos.

Os contribuidores devem fornecer arquivos de firmware corretos, não compensações de flash. Não edite endereços de dispersão, pré-carregadores, arquivos DA ou comandos de partição para solucionar um pacote incorreto. Corrija o ativo de lançamento e teste no modelo pretendido.

Antes de solicitar uma mesclagem

  1. Valide o XML com um analisador XML. Uma citação ou fechamento ausente /> pode ocultar todas as entradas depois dela.
  2. Inicie o atualizador em seu checkout para que ele carregue o manifesto local antes da atualização remota.
  3. Verifique Y1 e Y2 independentemente. Confirm that the project appears only where its package is supported.
  4. Confira a lista de lançamentos rom.zip, rom_type_b.zip, e rom_y2.zip conforme aplicável.
  5. Teste a instalação real no dispositivo pretendido, com um cabo de dados USB confiável e um plano de recuperação para retornar ao software original.
  6. Na solicitação pull, explique o que você testou. Não descreva um modelo não testado como suportado.
python -c "from xml.etree import ElementTree as ET; ET.parse('slidia_manifest.xml'); print('manifest ok')"

Para uma verificação local, execute esse comando na raiz do repositório. Ele verifica apenas a sintaxe XML; isso não prova que uma versão contém firmware válido ou que um dispositivo é seguro para flash.

Habilidades de modificação para agentes de IA

O repositório skills/ diretório é uma base de conhecimento baseada em fontes para agentes que trabalham em Y1 e Y2 hardware, firmware, temas e aplicativos. Cada habilidade nomeia os arquivos do projeto de onde vêm suas reivindicações, para que um agente possa verificar um fato antes de alterar um dispositivo.

Hardware

Y1 hardware

MT6572, a roda como eventos principais, display 480x360, caminhos FM/áudio, armazenamento e mapa de partição Type A/B.

Hardware

Y2 hardware

Placa MT6582, árvore de dispositivos, painéis GC9503V/ST7701S, trilhos PMIC/DAC, partições e imagem de inicialização.

Firmware

Pacotes de firmware

rom.zip anatomia, arquivos dispersos, contratos de atualização Classe A e lista de verificação de lançamento.

Todas as habilidades

Navegue pela pasta de habilidades

Rockbox Y1/Y2, estoque de ROMs Android, Y2Linux, aplicativos Android, iniciadores, notas de lançamento e publicação de sites.