SDK

Обзор

Язык
C, компилируется в WebAssembly
Память
64 КБ на приложение
Числа
Только целые, без плавающей точки
Пакет
app.wasm, manifest.json, переводы, картинки, файлы

Начало работы

  1. Тулчейн

    wasi-sdk, Java, git.

    shell
    git clone https://github.com/GrakovNe/perinkpheral.git
    cd perinkpheral
    export WASI_SDK_PATH=$HOME/opt/wasi-sdk
    tools/perinkpheral
  2. Новое приложение

    shell
    tools/perinkpheral new ../myapp --title "My App"
  3. Сборка

    shell
    tools/perinkpheral build ../myapp --out ../myapp/build
  4. Запуск в симуляторе

    shell
    tools/perinkpheral sim ../myapp
  5. Запуск на устройстве

    shell
    export PERINKPHERAL_HOST=perinkpheral-xxxx.local
    tools/perinkpheral run ../myapp --shot screen.png
    tools/perinkpheral press 2 2 --shot pressed.png
    tools/perinkpheral log --follow

Пример

hello.c
#include "app_text.h"
#include "host_api.h"

static const char PRESSES_KEY[] = "presses";
static int32_t presses;

void app_init(void)
{
    /* Restore state: the host unloads the application
     * when it leaves the screen. */
    kv_get(PRESSES_KEY, sizeof PRESSES_KEY - 1, &presses, sizeof presses);
}

void app_on_terminate(void)
{
    kv_set(PRESSES_KEY, sizeof PRESSES_KEY - 1, &presses, sizeof presses);
}

void app_on_button(int32_t event)
{
    if (event == BTN_OK_PRESSED) {
        presses++;
        request_redraw(HOST_REDRAW_NORMAL);
    }
}

void app_on_draw(void)
{
    char line[32];
    app_text_t text;
    app_text_start(&text, line, sizeof line);
    app_text_add(&text, "Presses: ");
    app_text_add_number(&text, presses);

    gfx_text(HOST_UI_MARGIN, HOST_UI_MARGIN, HOST_FONT_TEXT, "Hello from wasm", 15);
    gfx_text(HOST_UI_MARGIN, 60, HOST_FONT_TEXT, line, app_text_length(line));
}

Манифест

manifest.json
{
  "name": "weather",
  "title": "Weather",
  "version": "0.2.5",
  "abi": 2,
  "settings": [
    { "key": "city", "type": "place", "title": "City",
      "latitude": "lat", "longitude": "lon" },
    { "key": "lat", "type": "number", "title": "Latitude" },
    { "key": "lon", "type": "number", "title": "Longitude" },
    { "key": "every", "type": "choice", "title": "Update interval",
      "options": ["15 min", "30 min", "1 hour", "3 hours"] }
  ],
  "polls": [
    {
      "url": "https://api.open-meteo.com/v1/forecast?latitude={{lat}}&longitude={{lon}}&current=temperature_2m,weather_code",
      "every": "{{every}}",
      "pick": ["current.temperature_2m", "current.weather_code"]
    }
  ]
}
КлючЗначение
nameУникальный id: 1-13 символов, a-z, 0-9, - и _
titleНазвание в меню, до 23 символов
pollsЗапросы, которые устройство делает по расписанию, до 4
hostsСерверы, к которым приложению можно обращаться
settingsДо 8. Типы: text, secret, number, choice, toggle, place, url, link, list
intentsСистемные события: запуск устройства, смена времени, появление сети
iconИконка 11 x 11 точек: # чёрный, . белый
fullscreenВесь экран, без верхней строки
writes_filesПриложение пишет файлы; под них зарезервировано 32 КБ
systemДоступ к настройкам устройства, часам и приложениям; пользователь подтверждает при установке
certificatesСертификаты для серверов, которым не доверяют браузеры
companionВеб-страница, которая помогает настроить приложение
firmwareСамая старая прошивка, на которой работает приложение; сборка вычисляет её по вызовам

Обработчики и состояние

ФункцияКогда вызывается
app_init()Приложение запускается
app_on_focus() / app_on_blur()Приложение появляется на экране или уходит с него
app_on_terminate()Приложение сейчас закроется: здесь сохраняют состояние
app_on_button(event)Кнопку нажали, отпустили или удерживают
app_on_back()Нажата BACK, для приложений с несколькими страницами
app_on_draw()Нужно нарисовать экран
app_on_timer(id)Сработал таймер, пока приложение на экране
app_on_alarm(id)Сработал будильник, даже если приложение закрыто
app_on_values(poll, status)Пришли данные по расписанию, уже разобранные
app_on_data(...)Пришла часть ответа
app_on_settings()Пользователь изменил настройки
app_on_intent(type)Системное событие, на которое приложение подписано
app_on_installed() / app_on_updated()Первый запуск после установки или обновления

Кнопки и состояние

Кнопки
1 вверх, 2 OK, 3 вниз, 4 назад; удержание BACK открывает меню
Сохранённые данные
kv_set(), kv_get()

Данные из сети

По расписанию
Запросы в манифесте
По запросу
http_request() из кода
Готовые значения
Пути JSON в "pick": app_on_values() получает значения
Ответ как есть
Без "pick": app_on_data() получает ответ частями
Показать на экране
request_focus() открывает приложение, когда пришли данные
weather.c
void app_on_values(int32_t poll, int32_t http_status)
{
    /* Values of the "pick" paths, in order. 1 decimal: tenths. */
    int32_t temperature, code;
    if (http_status == 200 &&
        app_value_number(0, 1, &temperature) &&
        app_value_number(1, 0, &code)) {
        state.temperature = temperature;
        state.code = code;
        app_state_save("state", &state, sizeof state);
        request_redraw(HOST_REDRAW_NORMAL);
    }
}

Графика и UI kit

ЧастьФункции
Текст в четырёх стиляхui_text, ui_text_lines, ui_title
Список с полосой прокруткиui_list_row, ui_list_visible
Диалог: текст, иконка, кнопкиui_notice
Плитка: название, картинка, значениеui_cell, ui_cell_fit
График: линия, область, столбцы, ступениui_chart
Значение с единицейui_value
Выбор значения, даты и времениui_picker, ui_date
Сообщение, пока показывать нечегоui_reason

Ограничения

ЧтоПредел
Размер приложения48 KB
Память64 KB
Время на вызов3 s
Сохранённые данные2 КБ, до 1 КБ на значение
Файлы64 КБ в пакете; 32 КБ, если приложение пишет файлы
Запросы по расписанию4, от 10 с до суток
Запросов одновременно16
Размер ответа256 КБ с разбором, 4 МБ частями
Настройки8, значения до 255 байт
Таймеры и будильники4 и 4
Приложений на устройствеДо 24, пока хватает места

Инструменты

КомандаОписание
new <dir>Новое приложение
build <app> --out <dir>Собрать и проверить
sim <app>Запустить в симуляторе
run <app>Запустить на устройстве
serve [app]Страница с экраном устройства, кнопками и логом
shot / press / openСкриншот, нажатия кнопок, открыть приложение
log [--follow]Лог устройства
set <app> <key> <value>Изменить настройку приложения
catalog <folder> --out <dir>Собрать каталог
strings export / importПереводы таблицей
flash [image]Обновить прошивку по Wi-Fi
usb <port>Управлять устройством по USB

Плагин CLion

Где работает
Устройство, симулятор (macOS, Linux)
Что умеет
Установка тулчейна, живой экран устройства, проверка манифеста, загрузка прошивки
Исходники
perinkpheral-clion-plugin

Публикация

shell
tools/perinkpheral catalog apps --out catalog

Справка