SiFli CodeKit¶
SiFli CodeKit — это расширение для VS Code, предназначенное для разработки с помощью SiFli-SDK. Оно предлагает пошаговые действия для установки инструментов SDK, выбора платы, сборки примера, прошивки и открытия консоли последовательного порта.
Используйте этот вариант, если предпочитаете работать в IDE. Чтобы разобраться в командах, которые выполняются этими действиями, обратитесь к руководству по ручной настройке SiFli-SDK.
Это руководство посвящено первому запуску. После успешной работы hello_world используйте основной справочник по инструментам CodeKit, где описаны повседневный процесс разработки, требования к воспроизводимости и ограничения при сбоях.
Что понадобится¶
Оборудование
- Отладочная плата SF32, поддерживаемая SiFli-SDK.
- Кабель USB Type-C с поддержкой передачи данных, подключённый к разъёму USB-to-UART на плате.
- Компьютер под управлением Windows, macOS или Linux.
Программное обеспечение
- Visual Studio Code
- Расширение SiFli CodeKit.
- Git, если CodeKit предложит клонировать или импортировать SiFli-SDK.
Официальная документация
Установка CodeKit¶
- Запустите VS Code.
- Откройте раздел Extensions.
- Найдите расширение SiFli-SDK-CodeKit.
- Установите его.
- Если появится запрос, перезапустите VS Code.
Чтобы открыть управление SDK, нажмите значок SiFli на боковой панели VS Code и выберите SDK Manager. Также можно открыть View > Command Palette (по умолчанию F1) и выполнить команду Manage SiFli SDK installation. Точные названия зависят от версии расширения; сверяйтесь с приведённым выше официальным руководством по установке.
Tip
Если нужная команда не отображается, откройте Command Palette и выполните поиск по SiFli.
Установка или выбор SiFli-SDK¶
Установите SiFli-SDK через мастер настройки CodeKit или укажите путь к уже клонированной копии SDK. Для большинства пользователей подходит Release/Tag: это версия с зафиксированным тегом, прошедшая проверку. Выберите Branch, если нужны более новые исправления или функции и вы готовы к возможной нестабильности. В официальном руководстве release/vX.Y описана как способ получать последние исправления и функции этой линии выпусков, не используя менее стабильную ветку main. Её содержимое всё равно может меняться со временем.
Для пользователей в материковом Китае официальное руководство рекомендует использовать Gitee как источник SDK, а внутрикитайское зеркало SiFli — для загрузки инструментария.
Если CodeKit запросит расположение SDK, укажите короткий путь без пробелов, например:
CodeKit запускает собственные установщик и скрипты окружения SDK. В результате подготавливаются те же компоненты, что и при ручной настройке: компилятор, среда Python, инструменты сборки и прошивки.
Открытие примера¶
Откройте пример hello_world из SDK:
Откройте каталог проекта в VS Code. Если CodeKit предложит мастер импорта проекта, выберите проект hello_world и дождитесь, пока расширение определит корневой каталог SDK.
Выбор платы¶
Выберите конфигурацию, соответствующую вашей плате. Для платы типа SF32LB52-DevKit-LCD обычно используется следующее имя:
Для другой платы выберите соответствующее имя из списка CodeKit или документации SDK о поддерживаемых платах. Имя платы определяет разметку памяти, выводы, параметры флеш-памяти и периферийные устройства, включённые по умолчанию.
Сборка¶
Запустите действие CodeKit Build. При успешной сборке будет создан каталог с результатами для выбранной платы, например:
Если сборка завершается с ошибкой сразу после запуска, проверьте, правильно ли CodeKit определил расположение SiFli-SDK и завершилась ли установка окружения SDK.
Прошивка¶
Подключите плату через разъём USB-to-UART, затем запустите действие CodeKit Flash или Download.
Когда программа запросит последовательный порт:
- В Windows выберите соответствующий порт
COM. - В macOS выберите устройство
/dev/cu.*, а не/dev/tty.*. - В Linux выберите соответствующее устройство
/dev/ttyUSB*или/dev/ttyACM*.
Если утилита загрузки не переводит плату в режим загрузки UART, сбросьте плату непосредственно перед началом передачи. Если проблема сохраняется, следуйте инструкциям по прошивке для конкретной платы.
Открытие консоли последовательного порта¶
Используйте монитор последовательного порта в CodeKit, инструменты для последовательного порта в VS Code или другую терминальную программу. После сброса платы в консоли должны появиться читаемые загрузочные сообщения и вывод примера hello_world.
Если загрузочные сообщения отображаются правильно, плата и настройки последовательного порта заданы верно. Если текст искажён, закройте остальные программы, подключённые к порту, и проверьте скорость передачи данных, используемую примером.
Проверка результата¶
Можно переходить дальше, если:
- CodeKit определяет расположение SDK.
- Выбрана конфигурация, соответствующая плате.
- Действия сборки и прошивки завершаются успешно.
- После сброса платы в консоли отображается вывод
hello_world.
Устранение неполадок¶
| Проблема | Что проверить |
|---|---|
| Последовательный порт не появляется | Проверьте кабель для передачи данных, попробуйте другой USB-порт или подключитесь к разъёму USB-to-UART на плате. |
| CodeKit не находит SDK | Повторно запустите мастер настройки CodeKit и укажите корневой каталог SiFli-SDK. |
| При сборке не найдены инструменты | Дождитесь, пока CodeKit повторно установит инструментарий, или один раз запустите установщик SDK вручную. |
| Прошивка не начинается | Если утилита не может перевести плату в режим загрузки по UART, сбросьте её непосредственно перед передачей. Если проблема сохраняется, следуйте инструкции по прошивке для этой платы. |
| Вывод в последовательном порту не читается | Проверьте скорость передачи данных и убедитесь, что открыт только один монитор последовательного порта. |
Что делать дальше¶
- Чтобы узнать, какие команды терминала выполняются при работе с IDE, изучите руководство по SiFli-SDK.
- После успешного запуска
hello_worldпереходите к руководству «Знакомство с периферией». - При разработке функций изделия обратитесь к материалам: Обзор Bluetooth, Обзор графики, Обзор аудио и Обзор энергосберегающего проектирования.
Зафиксируйте воспроизводимую конфигурацию¶
Запишите версии CodeKit и SDK, выбранный тег или ветку и точное имя цели платы. Если название команды или пункта меню отличается, сверяйтесь с официальным руководством по установке и списком поддерживаемых плат для установленных версий.
Последнее обновление: