Для авторов

Выложи проект один раз. Люди прошивают сборку под свою плату в одно нажатие, и вопросов про прошивку в issues становится меньше. Это бесплатно.

Выложить проект

Как выложить

  1. Войди через GitHub или Google.
  2. Создай проект: название, платы, фото, список деталей и инструкция.
  3. Загрузи файлы прошивки или свяжи репозиторий GitHub.
  4. Отправь на проверку. Новый проект модератор смотрит один раз, дальше обновления выходят сразу.

Что получаешь

Сборки под вариантыЗагрузи сборку под каждый вариант платы. Chipnik покажет людям фото вариантов и прошьёт нужную сборку.
Релизы GitHubСвяжи репозиторий. Новые релизы сами становятся черновиками версий, ты нажимаешь «Опубликовать».
Статистика прошивокСколько раз прошили, на каких платах и вариантах, как часто без ошибок.
Значок для READMEЗначок Flash on Chipnik для README. По нажатию человек попадает к кнопке «Прошить».
БесплатноПубликация и прошивка ничего не стоят.

Что нужно для проекта

Файлы прошивкиФайлы .bin с адресами записи или релиз GitHub с chipnik.json.
ИнструкцияСписок деталей и шаги: что и как подключить, чтобы проект можно было повторить.
ЛицензияЛюбая открытая или закрытый код. Она видна на странице проекта.

Проверка

Первая публикацияКаждый новый проект модератор смотрит один раз, до того как его увидят все.
Новые версииНовая стабильная версия сначала 24 часа живёт в канале beta, потом становится основной для всех.

Импорт с GitHub

Chipnik читает только публичные релизы репозитория. Репозиторий должен принадлежать твоему аккаунту GitHub.

От релиза до прошитой платы

  1. Релиз

    Ты выкладываешь на GitHub релиз v1.0.0 с файлами .bin и chipnik.json.

  2. Страница проекта

    Chipnik забирает релиз, и новая версия появляется на странице проекта.

  3. Выбор платы

    Человек открывает страницу и выбирает свой вариант, например CYD с двумя USB.

  4. Установка

    Он нажимает «Прошить», и на плату записывается сборка под этот вариант.

Открыть демо-проект

Описание сборок в релизе

Положи файл chipnik.json рядом с .bin в релиз GitHub. Релиз с manifest.json от ESP Web Tools тоже подойдёт, если у проекта одна плата.

{
  "improv": false,
  "builds": [
    {
      "board": "esp32-2432s028",
      "variant": "st7789",
      "parts": [
        { "path": "bootloader.bin", "role": "bootloader", "offset": 4096 },
        { "path": "partitions.bin", "role": "partition-table", "offset": 32768 },
        { "path": "firmware.bin", "role": "app", "offset": 65536 }
      ]
    }
  ]
}