API extensible via plugins from @novastar/gen.

Original API contains more than a thousand methods, and you won't need all of them, so you just include the methods you need, and they will be embedded into your Session instance

interface API {
    version: "2.0";
    FuncCard_ReadOutDeviceValue_1(addr: number, portAddr: number, funcCardAddr: number): Promise<Buffer>;
    ReadAllBrightnessInfo(addr: number, portAddr: number, scanBoardAddr: number): Promise<Buffer>;
    ReadAllStatus(addr: number, portAddr: number, scanBoardAddr: number): Promise<Buffer>;
    ReadAudioControl(addr: number): Promise<number>;
    ReadCompanyID(addr: number): Promise<number>;
    ReadControllerModelId(addr: number): Promise<number>;
    ReadControllerSnHigh(addr: number): Promise<Buffer>;
    ReadDriverType(addr: number, portAddr: number, scanBoardAddr: number): Promise<number>;
    ReadDviMode(addr: number): Promise<number>;
    ReadDviSelect(addr: number): Promise<number>;
    ReadGamma(addr: number, portAddr: number, scanBoardAddr: number): Promise<number>;
    ReadGammaMaxValue2053(addr: number, portAddr: number, scanBoardAddr: number): Promise<number>;
    ReadGlobalBrightness(addr: number, portAddr: number, scanBoardAddr: number): Promise<number>;
    ReadHDEnable(addr: number): Promise<number>;
    ReadIsHasDVI(addr: number): Promise<number>;
    ReadScanner_FPGAProgramRemarks(addr: number, portAddr: number, scanBoardAddr: number): Promise<Buffer>;
    ReadScanner_McuProgramRemarks(addr: number, portAddr: number, scanBoardAddr: number): Promise<Buffer>;
    ReadScannerFunctionInfo(addr: number, portAddr: number, scanBoardAddr: number): Promise<Buffer>;
    ReadSelfTestMode(addr: number, portAddr: number, scanBoardAddr: number): Promise<number>;
    ReadSender_ScreenConfigSpace(addr: number): Promise<Buffer>;
    ReadSender_SoftwareSpace(addr: number, dataLength: number, addrOffset: number): Promise<Buffer>;
    SetGamma(addr: number, portAddr: number, scanBoardAddr: number, bBroadcast: boolean, gamma: number): Promise<void>;
    SetGlobalBrightness(addr: number, portAddr: number, scanBoardAddr: number, bBroadcast: boolean, globalBrightness: number): Promise<void>;
    SetReturnFactoryValues(addr: number, bBroadcast: boolean, returnFactoryValues: number): Promise<void>;
    SetScanner_AutoRefreshRate(addr: number, portAddr: number, scanBoardAddr: number, bBroadcast: boolean, autoRefreshRateData: Buffer | number[]): Promise<void>;
    SetScannerxBitEnable(addr: number, portAddr: number, scanBoardAddr: number, bBroadcast: boolean, da: number): Promise<void>;
    SetSelfTestMode(addr: number, portAddr: number, scanBoardAddr: number, bBroadcast: boolean, selfTestMode: TestModeEnum): Promise<void>;
    SetSender_DistributePortSeting(addr: number, bBroadcast: boolean, dataValue: Buffer | number[]): Promise<void>;
    SetSender_ScreenConfigFlagSpace(addr: number, bBroadcast: boolean, screenConfig: Buffer | number[]): Promise<void>;
    SetSender_SoftwareSpace(addr: number, bBroadcast: boolean, sender_SoftwareSpace: Buffer | number[], dataLength: number, addrOffset: number): Promise<void>;
    SetSenderVideoEnclosingMode(senderindex: number, width: number, height: number): Promise<void>;
    SetSmartSetMode(addr: number, portAddr: number, scanBoardAddr: number, bBroadcast: boolean, smartMode: SmartSetModeEnum): Promise<void>;
    SetSortOrder(addr: number, bBroadcast: boolean, sortOrder: number): Promise<void>;
    tryFuncCard_ReadOutDeviceValue_1(addr: number, portAddr: number, funcCardAddr: number): Promise<null | Packet>;
    tryReadAllBrightnessInfo(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadAllStatus(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadAudioControl(addr: number): Promise<null | Packet>;
    tryReadCompanyID(addr: number): Promise<null | Packet>;
    tryReadControllerModelId(addr: number): Promise<null | Packet>;
    tryReadControllerSnHigh(addr: number): Promise<null | Packet>;
    tryReadDriverType(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadDviMode(addr: number): Promise<null | Packet>;
    tryReadDviSelect(addr: number): Promise<null | Packet>;
    tryReadGamma(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadGammaMaxValue2053(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadGlobalBrightness(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadHDEnable(addr: number): Promise<null | Packet>;
    tryReadIsHasDVI(addr: number): Promise<null | Packet>;
    tryReadScanner_FPGAProgramRemarks(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadScanner_McuProgramRemarks(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadScannerFunctionInfo(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadSelfTestMode(addr: number, portAddr: number, scanBoardAddr: number): Promise<null | Packet>;
    tryReadSender_ScreenConfigSpace(addr: number): Promise<null | Packet>;
    tryReadSender_SoftwareSpace(addr: number, dataLength: number, addrOffset: number): Promise<null | Packet>;
    trySetGamma(addr: number, portAddr: number, scanBoardAddr: number, gamma: number): Promise<null | ErrorType>;
    trySetGlobalBrightness(addr: number, portAddr: number, scanBoardAddr: number, globalBrightness: number): Promise<null | ErrorType>;
    trySetReturnFactoryValues(addr: number, returnFactoryValues: number): Promise<null | ErrorType>;
    trySetScanner_AutoRefreshRate(addr: number, portAddr: number, scanBoardAddr: number, autoRefreshRateData: Buffer | number[]): Promise<null | ErrorType>;
    trySetScannerxBitEnable(addr: number, portAddr: number, scanBoardAddr: number, da: number): Promise<null | ErrorType>;
    trySetSelfTestMode(addr: number, portAddr: number, scanBoardAddr: number, selfTestMode: TestModeEnum): Promise<null | ErrorType>;
    trySetSender_DistributePortSeting(addr: number, dataValue: Buffer | number[]): Promise<null | ErrorType>;
    trySetSender_ScreenConfigFlagSpace(addr: number, screenConfig: Buffer | number[]): Promise<null | ErrorType>;
    trySetSender_SoftwareSpace(addr: number, sender_SoftwareSpace: Buffer | number[], dataLength: number, addrOffset: number): Promise<null | ErrorType>;
    trySetSenderVideoEnclosingMode(senderindex: number, width: number, height: number): Promise<null | ErrorType>;
    trySetSmartSetMode(addr: number, portAddr: number, scanBoardAddr: number, smartMode: SmartSetModeEnum): Promise<null | ErrorType>;
    trySetSortOrder(addr: number, sortOrder: number): Promise<null | ErrorType>;
}

Properties

version

Methods

  • Parameters

    • addr: number
    • portAddr: number
    • funcCardAddr: number

    Returns Promise<Buffer>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<Buffer>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<Buffer>

  • Parameters

    • addr: number

    Returns Promise<number>

  • Parameters

    • addr: number

    Returns Promise<number>

  • Parameters

    • addr: number

    Returns Promise<number>

  • Parameters

    • addr: number

    Returns Promise<Buffer>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<number>

  • Parameters

    • addr: number

    Returns Promise<number>

  • Parameters

    • addr: number

    Returns Promise<number>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<number>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<number>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<number>

  • Parameters

    • addr: number

    Returns Promise<number>

  • Parameters

    • addr: number

    Returns Promise<number>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<Buffer>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<Buffer>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<Buffer>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<number>

  • Parameters

    • addr: number

    Returns Promise<Buffer>

  • Parameters

    • addr: number
    • dataLength: number
    • addrOffset: number

    Returns Promise<Buffer>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • bBroadcast: boolean
    • gamma: number

    Returns Promise<void>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • bBroadcast: boolean
    • globalBrightness: number

    Returns Promise<void>

  • Parameters

    • addr: number
    • bBroadcast: boolean
    • returnFactoryValues: number

    Returns Promise<void>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • bBroadcast: boolean
    • autoRefreshRateData: Buffer | number[]

    Returns Promise<void>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • bBroadcast: boolean
    • da: number

    Returns Promise<void>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • bBroadcast: boolean
    • selfTestMode: TestModeEnum

    Returns Promise<void>

  • Parameters

    • addr: number
    • bBroadcast: boolean
    • dataValue: Buffer | number[]

    Returns Promise<void>

  • Parameters

    • addr: number
    • bBroadcast: boolean
    • screenConfig: Buffer | number[]

    Returns Promise<void>

  • Parameters

    • addr: number
    • bBroadcast: boolean
    • sender_SoftwareSpace: Buffer | number[]
    • dataLength: number
    • addrOffset: number

    Returns Promise<void>

  • Parameters

    • senderindex: number
    • width: number
    • height: number

    Returns Promise<void>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • bBroadcast: boolean
    • smartMode: SmartSetModeEnum

    Returns Promise<void>

  • Parameters

    • addr: number
    • bBroadcast: boolean
    • sortOrder: number

    Returns Promise<void>

  • Parameters

    • addr: number
    • portAddr: number
    • funcCardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • dataLength: number
    • addrOffset: number

    Returns Promise<null | Packet>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • gamma: number

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • globalBrightness: number

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • returnFactoryValues: number

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • autoRefreshRateData: Buffer | number[]

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • da: number

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • selfTestMode: TestModeEnum

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • dataValue: Buffer | number[]

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • screenConfig: Buffer | number[]

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • sender_SoftwareSpace: Buffer | number[]
    • dataLength: number
    • addrOffset: number

    Returns Promise<null | ErrorType>

  • Parameters

    • senderindex: number
    • width: number
    • height: number

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • portAddr: number
    • scanBoardAddr: number
    • smartMode: SmartSetModeEnum

    Returns Promise<null | ErrorType>

  • Parameters

    • addr: number
    • sortOrder: number

    Returns Promise<null | ErrorType>