@v5x/serial 0.5.4 → 0.5.5

package/dist/VexError.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Typed error hierarchy for the serial protocol package.
+ *
+ * Every public async API that can fail returns a {@link Result} (or
+ * {@link ResultAsync}) whose error channel is a {@link VexSerialError}.
+ * Each error carries a stable {@link VexSerialError.kind} discriminator
+ * so callers can branch on the failure category without parsing messages.
+ */
+export type VexSerialErrorKind = "not-connected" | "invalid-argument" | "protocol" | "transfer" | "download" | "firmware" | "io";
+/** Base class for every failure surfaced by the serial package. */
+export declare class VexSerialError extends Error {
+    readonly kind: VexSerialErrorKind;
+    constructor(kind: VexSerialErrorKind, message: string);
+}
+/** No connection is currently open to a device. */
+export declare class VexNotConnectedError extends VexSerialError {
+    constructor(message?: string);
+}
+/** A caller supplied an invalid argument value. */
+export declare class VexInvalidArgumentError extends VexSerialError {
+    constructor(message: string);
+}
+/** The device refused, timed out, or replied unexpectedly to a command. */
+export declare class VexProtocolError extends VexSerialError {
+    constructor(message: string);
+}
+/** A file-transfer handshake, read, write, or exit failed. */
+export declare class VexTransferError extends VexSerialError {
+    constructor(message: string);
+}
+/** A remote resource download (catalog/VEXos) failed. */
+export declare class VexDownloadError extends VexSerialError {
+    constructor(message: string);
+}
+/** A firmware archive was malformed, oversized, or incomplete. */
+export declare class VexFirmwareError extends VexSerialError {
+    constructor(message: string);
+}
+/** An underlying transport (serial port, stream) error. */
+export declare class VexIoError extends VexSerialError {
+    constructor(message: string);
+}
+/**
+ * Coerce an arbitrary thrown value into a {@link VexSerialError} so it
+ * can be returned through the {@link Result} error channel.
+ */
+export declare function toVexSerialError(error: unknown, fallback?: VexSerialErrorKind): VexSerialError;

package/dist/VexFirmware.d.ts

@@ -0,0 +1,45 @@
+import type { V5SerialDeviceState } from "./VexDeviceState.js";
+import { VexSerialError } from "./VexError.js";
+import { ResultAsync } from "neverthrow";
+export interface DownloadFileFromInternetOptions {
+    /** Maximum total bytes to read from the response body. */
+    maxBytes?: number;
+    /** Request timeout in milliseconds. */
+    timeout?: number;
+}
+/**
+ * Download a remote resource while enforcing a maximum body size. The
+ * declared `Content-Length` header is validated up front, and the body
+ * is streamed so an oversized payload is rejected before it is fully
+ * read into memory. Failures are returned as a {@link VexDownloadError}
+ * (or {@link VexInvalidArgumentError} for bad options) instead of
+ * thrown.
+ */
+export declare function downloadFileFromInternet(link: string, options?: DownloadFileFromInternetOptions): ResultAsync<ArrayBuffer, VexSerialError>;
+/**
+ * Poll an async predicate until it returns true or the timeout elapses.
+ * Argument errors are returned as {@link VexInvalidArgumentError}; a
+ * throwing predicate surfaces its error through the {@link Result}
+ * error channel.
+ */
+export declare function sleepUntilAsync(f: () => Promise<boolean>, timeout: number, interval?: number): ResultAsync<boolean, VexSerialError>;
+/**
+ * Poll a synchronous predicate until it returns true or the timeout
+ * elapses. The implementation uses a loop with `sleep` rather than
+ * `setInterval` so the timer is cleared as soon as the predicate
+ * resolves, and so predicate exceptions are surfaced without leaving a
+ * pending interval behind.
+ */
+export declare function sleepUntil(f: () => boolean, timeout: number, interval?: number): ResultAsync<boolean, VexSerialError>;
+/**
+ * Resolve after `ms` milliseconds. Returns a {@link VexInvalidArgumentError}
+ * when `ms` is negative.
+ */
+export declare function sleep(ms: number): ResultAsync<void, VexSerialError>;
+/**
+ * Upload a VEXos firmware archive to a connected brain. Network and
+ * archive validation failures are returned as {@link VexSerialError}
+ * values rather than thrown; a device that refuses a step or a missing
+ * connection surfaces as {@link VexProtocolError} / {@link VexNotConnectedError}.
+ */
+export declare function uploadFirmware(state: V5SerialDeviceState, publicUrl?: string, usingVersion?: string, progressCallback?: (state: string, current: number, total: number) => void): ResultAsync<boolean, VexSerialError>;

package/dist/VexIniConfig.d.ts

@@ -1,4 +1,4 @@
-import { type ZerobaseSlotNumber } from "./Vex";
+import { type ZerobaseSlotNumber } from "./Vex.js";
 export declare class ProgramIniConfig {
     baseName: string;
     autorun: boolean;

package/dist/VexPacket.d.ts

@@ -1,512 +1,3 @@
-import { CrcGenerator } from "./VexCRC";
-import * as AllPackets from "./VexPacket";
-import { AckType, type DataArray, type FileDownloadTarget, type FileExitAction, FileInitAction, type FileInitOption, type FileLoadAction, type FileVendor, type IFileEntry, type IFileMetadata, type ISmartDeviceInfo, type MatchMode, type SlotNumber, type SelectDashScreen } from "./Vex";
-import { VexFirmwareVersion } from "./VexFirmwareVersion";
-export declare class PacketEncoder {
-    static HEADERS_LENGTH: number;
-    static HEADER_TO_DEVICE: number[];
-    static HEADER_TO_HOST: number[];
-    static J2000_EPOCH: number;
-    vexVersion: number;
-    crcgen: CrcGenerator;
-    allPacketsTable: Record<string, typeof HostBoundPacket>;
-    static getInstance(): AllPackets.PacketEncoder;
-    private constructor();
-    /**
-     * Create the vex CDC header
-     * @param buf the bytes to send
-     */
-    createHeader(buf: ArrayBuffer | undefined): Uint8Array;
-    /**
-     * Create the vex CDC simple message
-     * @param cmd the CDC command byte
-     */
-    cdcCommand(cmd: number): Uint8Array;
-    /**
-     * Create the vex CDC simple message
-     * @param cmd the CDC command byte
-     * @param data the data to send
-     */
-    cdcCommandWithData(cmd: number, data: Uint8Array): Uint8Array;
-    /**
-     * Create the vex CDC extended message
-     * @param cmd the CDC command byte
-     * @param ext the CDC extended command byte
-     * @return a message
-     */
-    cdc2Command(cmd: number, ext: number): Uint8Array;
-    /**
-     * Calculate buffer length for new CDC extended command
-     * @param data the CDC extended command payload
-     * @returns the required buffer length of the command message
-     */
-    cdc2CommandBufferLength(data: Uint8Array): number;
-    /**
-     * Create the vex CDC extended message with some data
-     * @param cmd the CDC command byte
-     * @param ext the CDC extended command byte
-     * @param data the CDC extended command payload
-     * @return a message
-     */
-    cdc2CommandWithData(cmd: number, ext: number, data: Uint8Array): Uint8Array;
-    validateHeader(data: Uint8Array): boolean;
-    validateMessageCdc(data: Uint8Array): boolean;
-    getPayloadSize(data: Uint8Array): number;
-}
-export declare abstract class Packet {
-    data: Uint8Array;
-    static ENCODER: PacketEncoder;
-    constructor(rawData: DataArray);
-}
-export declare class DeviceBoundPacket extends Packet {
-    constructor(payload?: Uint8Array);
-}
-export declare class Query1H2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: undefined;
-    constructor();
-}
-export declare class SystemVersionH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: undefined;
-    constructor();
-}
-export declare class UpdateMatchModeH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(mode: MatchMode, matchClock: number);
-}
-export declare class GetMatchStatusH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class GetRadioModeH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(mode: number);
-}
-export declare class FileControlH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(a: number, b: number);
-}
-export declare class InitFileTransferH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(operation: FileInitAction, target: FileDownloadTarget, vendor: FileVendor, options: FileInitOption, binary: Uint8Array, addr: number, name: string, type?: string, version?: VexFirmwareVersion);
-}
-export declare class ExitFileTransferH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(action: FileExitAction);
-}
-export declare class WriteFileH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(addr: number, buf: Uint8Array);
-}
-export declare class ReadFileH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(addr: number, size: number);
-}
-export declare class LinkFileH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(vendor: FileVendor, fileName: string, options: number);
-}
-export declare class GetDirectoryFileCountH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(vendor: FileVendor);
-}
-export declare class GetDirectoryEntryH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(index: number);
-}
-export declare class LoadFileActionH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(vendor: FileVendor, actionId: FileLoadAction, fileNameOrSlotNumber: SlotNumber | string);
-}
-export declare class GetFileMetadataH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(vendor: FileVendor, fileName: string, options: number);
-}
-export declare class SetFileMetadataH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(vendor: FileVendor, fileName: string, fileInfo: IFileMetadata, options: number);
-}
-export declare class EraseFileH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(vendor: FileVendor, fileName: string);
-}
-export declare class GetProgramSlotInfoH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(vendor: FileVendor, fileName: string);
-}
-export declare class FileClearUpH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(vendor: FileVendor);
-}
-export declare class FileFormatH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class GetSystemFlagsH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class GetDeviceStatusH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class GetSystemStatusH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class GetFdtStatusH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class GetLogCountH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class ReadLogPageH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(offset: number, count: number);
-}
-export declare class GetRadioStatusH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class GetUserDataH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(e?: Uint8Array);
-}
-export declare class ScreenCaptureH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(e: number);
-}
-export declare class SendDashTouchH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(x: number, y: number, press: boolean);
-}
-export declare class SelectDashH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    /** @param port untested */
-    constructor(screen: number | SelectDashScreen, port: number);
-}
-export declare class EnableDashH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(unknown1?: number);
-}
-export declare class DisableDashH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class ReadKeyValueH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(key: string);
-}
-export declare class WriteKeyValueH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor(key: string, value: string);
-}
-export declare class GetSlot1to4InfoH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class GetSlot5to8InfoH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class FactoryStatusH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class FactoryEnableH2DPacket extends DeviceBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    constructor();
-}
-export declare class HostBoundPacket extends Packet {
-    ack: AckType;
-    payloadSize: number;
-    ackIndex: number;
-    constructor(data: DataArray);
-    static isValidPacket(data: Uint8Array, n: number): boolean;
-}
-export declare class Query1ReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: undefined;
-    joystickFlag1: number;
-    joystickFlag2: number;
-    brainFlag1: number;
-    brainFlag2: number;
-    bootloadFlag1: number;
-    bootloadFlag2: number;
-    constructor(data: DataArray);
-}
-export declare class SystemVersionReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: undefined;
-    version: VexFirmwareVersion;
-    hardware: number;
-    constructor(data: DataArray);
-}
-export declare class MatchModeReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    modebit: number;
-    constructor(data: DataArray);
-}
-export declare class MatchStatusReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    rssi: number;
-    systemStatusBits: number;
-    radioStatusBits: number;
-    fieldStatusBits: number;
-    matchClock: number;
-    brainBatteryPercent: number;
-    controllerBatteryPercent: number;
-    partnerControllerBatteryPercent: number;
-    pad: number;
-    buttons: number;
-    activeProgram: number;
-    radioType: number;
-    radioChannel: number;
-    radioSlot: number;
-    robotName: string;
-    controllerFlags: number;
-    rxSignalQuality: number;
-    constructor(data: DataArray);
-}
-export declare class FileControlReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class InitFileTransferReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    windowSize: number;
-    fileSize: number;
-    crc32: number;
-    constructor(data: DataArray);
-}
-export declare class ExitFileTransferReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class WriteFileReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class ReadFileReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    addr: number;
-    length: number;
-    buf: ArrayBuffer;
-    constructor(data: DataArray);
-    static isValidPacket(data: Uint8Array, n: number): boolean;
-}
-export declare class LinkFileReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class GetDirectoryFileCountReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    count: number;
-    constructor(data: DataArray);
-}
-export declare class GetDirectoryEntryReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    file?: IFileEntry;
-    constructor(data: DataArray);
-}
-export declare class LoadFileActionReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class GetFileMetadataReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    file?: IFileMetadata;
-    constructor(data: DataArray);
-}
-export declare class SetFileMetadataReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class EraseFileReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class GetProgramSlotInfoReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    requestedSlot: number;
-    slot: number;
-    constructor(data: DataArray);
-}
-export declare class FileClearUpReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class FileFormatReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class GetSystemFlagsReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    flags: number;
-    radioSearching: boolean;
-    radioQuality?: number;
-    controllerBatteryPercent?: number;
-    partnerControllerBatteryPercent?: number;
-    battery?: number;
-    currentProgram: number;
-    constructor(data: DataArray);
-}
-export declare class GetDeviceStatusReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    count: number;
-    devices: ISmartDeviceInfo[];
-    constructor(data: DataArray);
-}
-export declare class GetSystemStatusReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    systemVersion: VexFirmwareVersion;
-    cpu0Version: VexFirmwareVersion;
-    cpu1Version: VexFirmwareVersion;
-    nxpVersion: VexFirmwareVersion;
-    touchVersion: VexFirmwareVersion;
-    uniqueId: number;
-    sysflags: number[];
-    eventBrain: boolean;
-    romBootloaderActive: boolean;
-    ramBootloaderActive: boolean;
-    goldenVersion: VexFirmwareVersion;
-    constructor(data: DataArray);
-}
-export declare class GetFdtStatusReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    count: number;
-    status: unknown[];
-    constructor(data: DataArray);
-}
-export declare class GetLogCountReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    count: number;
-    constructor(data: DataArray);
-}
-export declare class ReadLogPageReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    offset: number;
-    count: number;
-    entries: unknown[];
-    constructor(data: DataArray);
-}
-export declare class GetRadioStatusReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    device: number;
-    quality: number;
-    strength: number;
-    channel: number;
-    timeslot: number;
-    constructor(data: DataArray);
-}
-export declare class GetUserDataReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class ScreenCaptureReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class SendDashTouchReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class SelectDashReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class EnableDashReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class DisableDashReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class ReadKeyValueReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    value: string;
-    constructor(data: DataArray);
-}
-export declare class WriteKeyValueReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
-export declare class GetSlot1to4InfoReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    slotFlags: number;
-    slots: unknown[];
-    constructor(data: DataArray, start?: number);
-}
-export declare class GetSlot5to8InfoReplyD2HPacket extends GetSlot1to4InfoReplyD2HPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    slotStartIndex: number;
-    constructor(data: DataArray);
-}
-export declare class FactoryStatusReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-    status: number;
-    percent: number;
-    constructor(data: DataArray);
-}
-export declare class FactoryEnableReplyD2HPacket extends HostBoundPacket {
-    static COMMAND_ID: number;
-    static COMMAND_EXTENDED_ID: number;
-}
+export * from "./VexPacketBase.js";
+export * from "./VexPacketEncoder.js";
+export * from "./VexPacketModels.js";

package/dist/VexPacketBase.d.ts

@@ -0,0 +1,21 @@
+import { AckType, type DataArray } from "./Vex.js";
+import type { PacketEncoder } from "./VexPacketEncoder.js";
+export declare abstract class Packet {
+    data: Uint8Array;
+    static ENCODER: PacketEncoder;
+    constructor(rawData: DataArray);
+}
+export declare class DeviceBoundPacket extends Packet {
+    get commandId(): number;
+    get commandExtendedId(): number | undefined;
+    static COMMAND_ID: number;
+    static COMMAND_EXTENDED_ID: number | undefined;
+    constructor(payload?: Uint8Array);
+}
+export declare class HostBoundPacket extends Packet {
+    ack: AckType;
+    payloadSize: number;
+    ackIndex: number;
+    constructor(data: DataArray);
+    static isValidPacket(data: Uint8Array, n: number): boolean;
+}

package/dist/VexPacketEncoder.d.ts

@@ -0,0 +1,55 @@
+import { CrcGenerator } from "./VexCRC.js";
+import { HostBoundPacket } from "./VexPacketBase.js";
+export declare function encodeFixedText(value: string, field: string, maxBytes: number): Uint8Array;
+export declare class PacketEncoder {
+    static HEADERS_LENGTH: number;
+    static HEADER_TO_DEVICE: number[];
+    static HEADER_TO_HOST: number[];
+    static J2000_EPOCH: number;
+    vexVersion: number;
+    crcgen: CrcGenerator;
+    allPacketsTable: Record<string, typeof HostBoundPacket>;
+    static getInstance(): PacketEncoder;
+    private constructor();
+    /**
+     * Create the vex CDC header
+     * @param buf the bytes to send
+     */
+    createHeader(buf: ArrayBuffer | undefined): Uint8Array;
+    /**
+     * Create the vex CDC simple message
+     * @param cmd the CDC command byte
+     */
+    cdcCommand(cmd: number): Uint8Array;
+    /**
+     * Create the vex CDC simple message
+     * @param cmd the CDC command byte
+     * @param data the data to send
+     */
+    cdcCommandWithData(cmd: number, data: Uint8Array): Uint8Array;
+    /**
+     * Create the vex CDC extended message
+     * @param cmd the CDC command byte
+     * @param ext the CDC extended command byte
+     * @return a message
+     */
+    cdc2Command(cmd: number, ext: number): Uint8Array;
+    /**
+     * Calculate buffer length for new CDC extended command
+     * @param data the CDC extended command payload
+     * @returns the required buffer length of the command message
+     */
+    cdc2CommandBufferLength(data: Uint8Array): number;
+    /**
+     * Create the vex CDC extended message with some data
+     * @param cmd the CDC command byte
+     * @param ext the CDC extended command byte
+     * @param data the CDC extended command payload
+     * @return a message
+     */
+    cdc2CommandWithData(cmd: number, ext: number, data: Uint8Array): Uint8Array;
+    validateHeader(data: Uint8Array): boolean;
+    validateMessageCdc(data: Uint8Array): boolean;
+    getPayloadSize(data: Uint8Array): number;
+    getHostHeaderLength(data: Uint8Array): number;
+}