PIPKIT · Reference

Справочник флагов, enum-ов и общих контрактов API.

Это отдельный reference-слой, чтобы не искать руками enum-ы, mode tokens, color formats, input semantics и общие fluent-patterns по всему API.md.

Build-time флаги

  • PIPCORE_PLATFORM — выбор platform backend (ESP32 или DESKTOP)
  • PIPCORE_DISPLAY — выбор display backend
  • PIPCORE_ENABLE_PREFS — включает core-level prefs backend
  • PIPCORE_ENABLE_WIFI — включает core-level Wi‑Fi backend
  • PIPCORE_ENABLE_OTA — включает core-level OTA backend
  • PIPCORE_OTA_PROJECT_URL — OTA base URL для core-level backend
  • PIPGUI_STATUS_BAR — включает код status bar
  • PIPGUI_DEBUG_METRICS — включает debug metrics в status bar
  • PIPGUI_SCREENSHOTS — включает систему скриншотов
  • PIPGUI_SCREENSHOT_MODE — 1 serial capture, 2 LittleFS
  • PIPGUI_WIFI, PIPGUI_WIFI_SSID, PIPGUI_WIFI_PASSWORD — standalone Wi‑Fi wrapper
  • PIPGUI_OTA, PIPGUI_OTA_PROJECT_URL, PIPGUI_OTA_ED25519_PUBKEY_HEX — OTA config
  • PIPGUI_FIRMWARE_TITLE, PIPGUI_FIRMWARE_VER_MAJOR, PIPGUI_FIRMWARE_VER_MINOR, PIPGUI_FIRMWARE_VER_PATCH — локальная версия firmware для OTA
  • PIPCORE_DISPLAY поддерживает ST7789, ILI9488 и SIMULATOR
  • PIPGUI_SIM_SCALE, PIPGUI_SIM_DEFAULT_WIDTH, PIPGUI_SIM_DEFAULT_HEIGHT — размер и масштаб desktop simulator
  • PIPGUI_SIM_BTN_PREV_PIN, PIPGUI_SIM_BTN_NEXT_PIN, PIPGUI_SIM_BTN_SELECT_PIN — virtual pins simulator-кнопок
  • дефолты hz(...) и order(...) могут зависеть от выбранного display backend

Enums & modes

  • Boot / logo FadeIn, LightFade
  • Screen transitions SlideX, SlideY
  • Status bar / overlay style Solid, Blur
  • Semantic status Normal, Warning, Error
  • Animation None, Pulse, Shimmer
  • Graph direction LeftToRight, RightToLeft, Oscilloscope
  • Blur direction TopDown, BottomUp, LeftRight, RightLeft
  • BatteryStyle Hidden, Numeric, Bar, WarningBar, ErrorBar
  • Typography H1, H2, Body, Caption
  • List / tile modes Cards, Plain, TextOnly, TextSubtitle
  • OTA policy NewerOnly, AllowDowngrade

Форматы цвета

  • RGB565
  • RGB888
  • ui.rgb(r, g, b) — обычный и основной способ конвертации RGB888 в RGB565
  • semantic tokens: Warning, Error

Семантика input

  • Down - состояние удержания
  • Pressed - одноразовое событие нажатия
  • comboDown - обе основные кнопки сейчас зажаты одновременно
  • 2-button режим Next/Prev часто совмещают и navigation, и confirm/back сценарии
  • 3-button режим Select становится основным confirm-action и переключает graph freeze
  • ui.consumeAutoNav() выключает auto screen-nav на текущем тике

Общие fluent-patterns

  • drawX() - immediate draw path
  • updateX() - локальный in-place refresh
  • для animated icons, blur и glow часто нужен bgColor(...), чтобы безопасно зачистить прошлый кадр
  • derive() позволяет ветвить общий base fluent style в несколько вариантов
  • lowercase center — positional sentinel, а Center обычно alignment token
  • в low-level custom callbacks иногда есть явный terminal .draw()
  • в примерах с кнопками используется Pullup

Семейства шрифтов и токены веса

Встроенные семейства: WixMadeForDisplay, KronaOne.

Токены веса: Thin, Light, Regular, Medium, Semibold, Bold, Black.