@v5x/serial 0.5.4 → 0.5.6

package/{dts/VexPacket.d.ts → dist/VexPacketModels.d.ts}

@@ -1,75 +1,13 @@
-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);
-}
+import { 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.js";
+import { VexFirmwareVersion } from "./VexFirmwareVersion.js";
+import { DeviceBoundPacket, HostBoundPacket } from "./VexPacketBase.js";
 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;
@@ -79,7 +17,6 @@ export declare class UpdateMatchModeH2DPacket extends DeviceBoundPacket {
 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;
@@ -136,11 +73,6 @@ export declare class GetFileMetadataH2DPacket extends DeviceBoundPacket {
     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;
@@ -168,22 +100,18 @@ export declare class GetSystemFlagsH2DPacket extends DeviceBoundPacket {
 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;
@@ -193,12 +121,6 @@ export declare class ReadLogPageH2DPacket extends DeviceBoundPacket {
 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;
@@ -213,19 +135,8 @@ export declare class SendDashTouchH2DPacket extends DeviceBoundPacket {
 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;
@@ -239,12 +150,10 @@ export declare class WriteKeyValueH2DPacket extends DeviceBoundPacket {
 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;
@@ -255,13 +164,6 @@ export declare class FactoryEnableH2DPacket extends DeviceBoundPacket {
     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;
@@ -335,7 +237,6 @@ export declare class ReadFileReplyD2HPacket extends HostBoundPacket {
     length: number;
     buf: ArrayBuffer;
     constructor(data: DataArray);
-    static isValidPacket(data: Uint8Array, n: number): boolean;
 }
 export declare class LinkFileReplyD2HPacket extends HostBoundPacket {
     static COMMAND_ID: number;
@@ -363,10 +264,6 @@ export declare class GetFileMetadataReplyD2HPacket extends HostBoundPacket {
     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;
@@ -452,10 +349,6 @@ export declare class GetRadioStatusReplyD2HPacket extends HostBoundPacket {
     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;
@@ -468,14 +361,6 @@ 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;

package/dist/VexPacketView.d.ts

@@ -1,6 +1,6 @@
-import { VexFirmwareVersion } from "./VexFirmwareVersion";
-import { type HostBoundPacket } from "./VexPacket";
-export declare class PacketView extends DataView {
+import { VexFirmwareVersion } from "./VexFirmwareVersion.js";
+import { type HostBoundPacket } from "./VexPacket.js";
+export declare class PacketView extends DataView<ArrayBuffer> {
     position: number;
     littleEndianDefault: boolean;
     constructor(buffer: ArrayBuffer, offset?: number, length?: number);
@@ -12,7 +12,9 @@ export declare class PacketView extends DataView {
     nextInt32(littleEndian?: boolean): number;
     nextUint32(littleEndian?: boolean): number;
     nextString(length: number): string;
+    /** Read a null-terminated string from a fixed-width `length`-byte field. */
     nextNTBS(length: number): string;
+    /** Read a null-terminated string of at most `length` bytes. */
     nextVarNTBS(length: number): string;
     nextVersion(reverse?: boolean): VexFirmwareVersion;
 }

package/dist/VexTransfers.d.ts

@@ -0,0 +1,20 @@
+import { type IFileBasicInfo, type IFileHandle, FileVendor, type IProgramInfo, type IFileWriteRequest, FileDownloadTarget } from "./Vex.js";
+import { type ProgramIniConfig } from "./VexIniConfig.js";
+import type { V5SerialDeviceState } from "./VexDeviceState.js";
+import { VexSerialError } from "./VexError.js";
+import { ResultAsync } from "neverthrow";
+export declare function getValue(state: V5SerialDeviceState, key: string): ResultAsync<string | undefined, VexSerialError>;
+export declare function setValue(state: V5SerialDeviceState, key: string, value: string): ResultAsync<void, VexSerialError>;
+export declare function listFiles(state: V5SerialDeviceState, vendor?: FileVendor): ResultAsync<IFileHandle[], VexSerialError>;
+export declare function listProgram(state: V5SerialDeviceState): ResultAsync<IProgramInfo[], VexSerialError>;
+export declare function readFile(state: V5SerialDeviceState, request: IFileBasicInfo | string, downloadTarget?: FileDownloadTarget, progressCallback?: (current: number, total: number) => void): ResultAsync<Uint8Array, VexSerialError>;
+export declare function removeFile(state: V5SerialDeviceState, request: IFileBasicInfo | string): ResultAsync<void, VexSerialError>;
+export declare function removeAllFiles(state: V5SerialDeviceState): ResultAsync<void, VexSerialError>;
+export declare function uploadProgram(state: V5SerialDeviceState, iniConfig: ProgramIniConfig, binFileBuf: Uint8Array, coldFileBuf: Uint8Array | undefined, progressCallback: (state: string, current: number, total: number) => void): ResultAsync<boolean, VexSerialError>;
+export declare function writeFile(state: V5SerialDeviceState, request: IFileWriteRequest, progressCallback?: (current: number, total: number) => void): ResultAsync<boolean, VexSerialError>;
+/**
+ * @param progressCallback Informs the progress of the download.
+ * @returns array of bytes where each pixel is represented by 3 consecutive bytes (rgb).
+ * This array's length is 272 width * 480 height * 3 channels = 391680 bytes.
+ */
+export declare function captureScreen(state: V5SerialDeviceState, progressCallback?: (current: number, total: number) => void): ResultAsync<Uint8Array, VexSerialError>;