poe-svelte-ui-lib 1.62.0 → 1.63.0

package/README.md

@@ -59,7 +59,7 @@ npm install poe-svelte-ui-lib
 
 **Названия смарт-виджетов** — в словаре библиотеки на всех языках (WiFi, «Об устройстве», «Файловая система», «Стек и задачи», «RGB лента», «Пилотажный дисплей», «Карта»); пустой `label.name` показывает название на языке пользователя, `widgetTitle(type)` отдаёт его сразу на всех языках `{ ru, en, zh }` — так конструктор заполняет заголовок нового виджета.
 
-**Ядро протоколов** — `poe-svelte-ui-lib/protocols` (без Svelte, работает и под Node без Vite): общий для DevCloud, WebApp и SYP-DevTerminal CBOR-кодек (RFC 8949) — `encodeCbor`/`decodeCbor`, `CborEncoder`/`CborDecoder`; `valueToCbor`/`cborToValue` — обычные значения, двоичные данные как `Uint8Array` (WebSocket, хранилище, телеметрия); `jsonToCbor`/`cborToJson` — JSON-совместимые значения, двоичные данные в base64, строки под ключами с `BIN` — байты (поля ввода терминала и отладки). Дальше сюда переезжают конверт `poe_cbor_pkt` с CRC и разбор потоков POESerial/CAN/RS485 — своих копий протоколов в приложениях не держим.
+**Ядро протоколов** — `poe-svelte-ui-lib/protocols` (без Svelte, работает и под Node без Vite): общий для DevCloud, WebApp и SYP-DevTerminal CBOR-кодек (RFC 8949) — `encodeCbor`/`decodeCbor`, `CborEncoder`/`CborDecoder`; `valueToCbor`/`cborToValue` — обычные значения, двоичные данные как `Uint8Array` (WebSocket, хранилище, телеметрия); `jsonToCbor`/`cborToJson` — JSON-совместимые значения, двоичные данные в base64, строки под ключами с `BIN` — байты (поля ввода терминала и отладки). Пакет `poe_cbor_pkt` `{ TrgBusID : [RetBusID, HA_Code, Payload, CRC16] }` (CAN, RS485): `encodePacket`/`decodePacket` (разбор с начала буфера — `complete` с длиной, `incomplete` для потока или `garbage`; объекты с одинаковым `TrgBusID` не склеиваются, неверный CRC — флаг `crcOk`), `objectsFor` (свой адрес и broadcast `0xFFFF`), `makeHaCode`/`splitHaCode`, `packetObjectCrc`; контрольные суммы `crc16Kermit` и `crc8Rohc`. Байты совпадают с `poe_cbor_pkt.c` прошивки — проверка `npm run TestProtocols` (`tests/protocols.test.mjs`, эталонные пакеты собраны прошивочным кодом). Дальше сюда переезжает разбор потоков POESerial/CAN/RS485 — своих копий протоколов в приложениях не держим.
 
 **Шапка смарт-виджета** (`WidgetHeader`): значок, заголовок и сворачивание слева, «?» в правом краю; правая часть (режимы, «Обновить» и т. п.) стоит в той же строке, а если не помещается — уходит второй строкой под заголовок и там переносится.
 

package/dist/protocols/cbor/decoder.d.ts

@@ -2,6 +2,7 @@ import { type CborValue } from "./types.js";
 export declare class CborDecoder {
     private state;
     constructor(buffer: ArrayBuffer | Uint8Array);
+    get offset(): number;
     decode(): CborValue;
     skipValue(): boolean;
     decodeBytes(): {

package/dist/protocols/cbor/decoder.js

@@ -12,6 +12,10 @@ export class CborDecoder {
             depth: 0,
         };
     }
+    /* Сколько байт уже прочитано — граница значения при разборе потока по одному значению */
+    get offset() {
+        return this.state.offset;
+    }
     /* Основной метод декодирования - декодирует одно значение CBOR */
     decode() {
         this.state.depth++;
@@ -180,14 +184,15 @@ export class CborDecoder {
                 return -1 - Number(header.value);
             case CborMajorType.ByteString: {
                 const bytesValue = header.value === BigInt(-1) ? this.readIndefiniteBytes() : this.decodeBytesWithLength(Number(header.value));
+                /* Не хватило байт — конец данных (в потоке это «ждать ещё»), а не испорченный CBOR */
                 if (!bytesValue)
-                    throw new CborError("Failed to decode byte string");
+                    throw new CborEndOfDataError();
                 return bytesValue.value;
             }
             case CborMajorType.Utf8String: {
                 const stringValue = header.value === BigInt(-1) ? this.readIndefiniteString() : this.decodeStringWithLength(Number(header.value));
                 if (!stringValue)
-                    throw new CborError("Failed to decode string");
+                    throw new CborEndOfDataError();
                 return stringValue.value;
             }
             case CborMajorType.Array:

package/dist/protocols/crc.d.ts

@@ -0,0 +1,2 @@
+export declare const crc16Kermit: (crc: number, bytes: Uint8Array | number[]) => number;
+export declare const crc8Rohc: (crc: number, bytes: Uint8Array | number[]) => number;

package/dist/protocols/crc.js

@@ -0,0 +1,20 @@
+/* $lib/protocols/crc.ts */
+/* Контрольные суммы протоколов устройств — побайтные, как в прошивках (ProdFactory-ESP/STM) */
+/* CRC-16/KERMIT: poly 0x1021 reflected (0x8408), init 0x0000, xorout 0x0000, check("123456789") = 0x2189 — объекты пакета poe_cbor_pkt */
+export const crc16Kermit = (crc, bytes) => {
+    for (const byte of bytes) {
+        crc ^= byte & 0xff;
+        for (let bit = 0; bit < 8; bit++)
+            crc = crc & 1 ? (crc >>> 1) ^ 0x8408 : crc >>> 1;
+    }
+    return crc & 0xffff;
+};
+/* CRC-8/ROHC: poly 0x07 reflected (0xE0), init 0xFF, xorout 0x00, check("123456789") = 0xD0 — рамка POESerial (system_console) */
+export const crc8Rohc = (crc, bytes) => {
+    for (const byte of bytes) {
+        crc ^= byte & 0xff;
+        for (let bit = 0; bit < 8; bit++)
+            crc = crc & 1 ? (crc >>> 1) ^ 0xe0 : crc >>> 1;
+    }
+    return crc & 0xff;
+};

package/dist/protocols/index.d.ts

@@ -4,3 +4,5 @@ export { CborEncoder, encodeCbor } from "./cbor/encoder.js";
 export { bytesToBase64, base64ToBytes } from "./cbor/base64.js";
 export { CborToValue, ValueToCbor, cborToValue, valueToCbor } from "./cbor/value.js";
 export { CborToJson, JsonToCbor, cborToJson, jsonToCbor } from "./cbor/json.js";
+export { crc16Kermit, crc8Rohc } from "./crc.js";
+export { BROADCAST_BUS_ID, makeHaCode, splitHaCode, packetObjectCrc, encodePacket, decodePacket, objectsFor, type PacketObject, type DecodedPacketObject, type PacketParse, } from "./packet.js";

package/dist/protocols/index.js

@@ -9,3 +9,6 @@ export { bytesToBase64, base64ToBytes } from "./cbor/base64.js";
 export { CborToValue, ValueToCbor, cborToValue, valueToCbor } from "./cbor/value.js";
 /* JSON-текст ↔ CBOR: двоичные данные — base64, ключи с "BIN" кодируются байтами (поля ввода терминала и отладки) */
 export { CborToJson, JsonToCbor, cborToJson, jsonToCbor } from "./cbor/json.js";
+/* Контрольные суммы и пакет poe_cbor_pkt { TrgBusID : [RetBusID, HA_Code, Payload, CRC16] } (CAN, RS485) */
+export { crc16Kermit, crc8Rohc } from "./crc.js";
+export { BROADCAST_BUS_ID, makeHaCode, splitHaCode, packetObjectCrc, encodePacket, decodePacket, objectsFor, } from "./packet.js";

package/dist/protocols/packet.d.ts

@@ -0,0 +1,31 @@
+export declare const BROADCAST_BUS_ID = 65535;
+export interface PacketObject {
+    trgBusID: number;
+    retBusID: number;
+    haCode: number;
+    payload: Uint8Array;
+}
+export interface DecodedPacketObject extends PacketObject {
+    header: number;
+    argument: number;
+    crc: number;
+    crcOk: boolean;
+}
+export declare const makeHaCode: (header: number, argument: number) => number;
+export declare const splitHaCode: (haCode: number) => {
+    header: number;
+    argument: number;
+};
+export declare const packetObjectCrc: (trgBusID: number, retBusID: number, haCode: number, payload: Uint8Array) => number;
+export declare const encodePacket: (objects: PacketObject[]) => Uint8Array;
+export type PacketParse = {
+    status: "complete";
+    length: number;
+    objects: DecodedPacketObject[];
+} | {
+    status: "incomplete";
+} | {
+    status: "garbage";
+};
+export declare const decodePacket: (bytes: Uint8Array) => PacketParse;
+export declare const objectsFor: (objects: DecodedPacketObject[], busID: number) => DecodedPacketObject[];

package/dist/protocols/packet.js

@@ -0,0 +1,105 @@
+/* $lib/protocols/packet.ts */
+/* Пакет poe_cbor_pkt (README poe_cbor прошивки, ProdFactory-ESP/STM): indefinite MAP { TrgBusID : [RetBusID, HA_Code, Payload, CRC16] },
+   объектов в пакете сколько угодно (в том числе с одинаковым TrgBusID), у каждого свой CRC-16/KERMIT по TrgBusID|RetBusID|HA_Code (по 2 байта
+   big-endian) и Payload — не зависит от того, как числа записаны в CBOR. Общая точка сборки и разбора для терминала (CAN, RS485) и облака */
+import { CborDecoder } from "./cbor/decoder.js";
+import { CborEncoder } from "./cbor/encoder.js";
+import { CborEndOfDataError } from "./cbor/types.js";
+import { crc16Kermit } from "./crc.js";
+/* Адрес «всем устройствам шины» */
+export const BROADCAST_BUS_ID = 0xffff;
+/* HA_Code = заголовок (0..3) в старших 2 битах и аргумент (0..0x3FFF) */
+export const makeHaCode = (header, argument) => ((header & 0x03) << 14) | (argument & 0x3fff);
+export const splitHaCode = (haCode) => ({ header: (haCode >> 14) & 0x03, argument: haCode & 0x3fff });
+/* CRC объекта: TrgBusID | RetBusID | HA_Code по 2 байта big-endian, затем Payload */
+export const packetObjectCrc = (trgBusID, retBusID, haCode, payload) => {
+    const head = [trgBusID >> 8, trgBusID, retBusID >> 8, retBusID, haCode >> 8, haCode].map((byte) => byte & 0xff);
+    return crc16Kermit(crc16Kermit(0, head), payload);
+};
+/* Пакет из одного или нескольких объектов — те же байты, что CBOR_PACK/CBOR_PktEncFinish прошивки */
+export const encodePacket = (objects) => {
+    const encoder = new CborEncoder();
+    encoder.encodeMapStart(null);
+    for (const { trgBusID, retBusID, haCode, payload } of objects) {
+        encoder.encodeUnsigned(trgBusID);
+        encoder.encodeArrayStart(4);
+        encoder.encodeUnsigned(retBusID);
+        encoder.encodeUnsigned(haCode);
+        encoder.encodeBytes(payload);
+        encoder.encodeUnsigned(packetObjectCrc(trgBusID, retBusID, haCode, payload));
+    }
+    encoder.encodeBreak();
+    return encoder.getResult();
+};
+/* Одно CBOR-значение с позиции offset: значение и сколько байт заняло; null — данных не хватает */
+const readValue = (bytes, offset) => {
+    const decoder = new CborDecoder(bytes.subarray(offset));
+    try {
+        const value = decoder.decode();
+        return { value, length: decoder.offset };
+    }
+    catch (error) {
+        if (error instanceof CborEndOfDataError)
+            return null;
+        throw error;
+    }
+};
+const toNumber = (value) => (typeof value === "number" && Number.isInteger(value) && value >= 0 && value <= 0xffff ? value : null);
+/* Объект пакета из пары ключ/значение; не по формату (не 4 элемента, не те типы, старый формат без CRC) — null, как CBOR_PktDecGet его пропускает */
+const toObject = (key, value) => {
+    const trgBusID = toNumber(key);
+    if (trgBusID === null || !Array.isArray(value) || value.length !== 4)
+        return null;
+    const [retBusID, haCode, payload, crc] = [toNumber(value[0]), toNumber(value[1]), value[2], toNumber(value[3])];
+    if (retBusID === null || haCode === null || !(payload instanceof Uint8Array) || crc === null)
+        return null;
+    return { trgBusID, retBusID, haCode, payload, crc, crcOk: packetObjectCrc(trgBusID, retBusID, haCode, payload) === crc, ...splitHaCode(haCode) };
+};
+/* Разбор пакета с начала буфера — и для целого кадра (CAN), и для потока (RS485: «incomplete» — ждать ещё байт, «garbage» — сдвинуться на байт) */
+export const decodePacket = (bytes) => {
+    if (bytes.length === 0)
+        return { status: "incomplete" };
+    const first = bytes[0];
+    if (first >> 5 !== 5)
+        return { status: "garbage" };
+    /* Число записей: indefinite (0xBF, до BREAK) или definite — прямо в байте либо в следующих 1/2 байтах */
+    let offset = 1;
+    let count = null;
+    const info = first & 0x1f;
+    if (info < 24)
+        count = info;
+    else if (info === 24 || info === 25) {
+        const size = info === 24 ? 1 : 2;
+        if (bytes.length < 1 + size)
+            return { status: "incomplete" };
+        count = size === 1 ? bytes[1] : (bytes[1] << 8) | bytes[2];
+        offset += size;
+    }
+    else if (info !== 31)
+        return { status: "garbage" };
+    const objects = [];
+    try {
+        for (let index = 0; count === null || index < count; index++) {
+            if (offset >= bytes.length)
+                return { status: "incomplete" };
+            if (count === null && bytes[offset] === 0xff)
+                return { status: "complete", length: offset + 1, objects };
+            const key = readValue(bytes, offset);
+            if (!key)
+                return { status: "incomplete" };
+            const value = readValue(bytes, offset + key.length);
+            if (!value)
+                return { status: "incomplete" };
+            offset += key.length + value.length;
+            const object = toObject(key.value, value.value);
+            if (object)
+                objects.push(object);
+        }
+    }
+    catch {
+        return { status: "garbage" };
+    }
+    return { status: "complete", length: offset, objects };
+};
+/* Объекты пакета для своего адреса (и broadcast) с верным CRC — как CBOR_PktDecGet прошивки, только все, а не первый */
+export const objectsFor = (objects, busID) => objects.filter((object) => object.crcOk && (object.trgBusID === busID || object.trgBusID === BROADCAST_BUS_ID));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poe-svelte-ui-lib",
-  "version": "1.62.0",
+  "version": "1.63.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Oleg-Perevyshin/ElementsUI.git"
@@ -15,7 +15,8 @@
     "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
     "CheckUpdate": "npx npm-check-updates -u && npm install",
     "UpdateIconsLib": "tsx src/lib/IconsCatalog/iconsLib.ts",
-    "Formatting": "prettier --write ."
+    "Formatting": "prettier --write .",
+    "TestProtocols": "svelte-package && node --test tests/*.test.mjs"
   },
   "svelte": "./dist/index.js",
   "types": "./dist/index.d.ts",