MAIDR JavaScript API
    Preparing search index...

    Interface DotPadVendorSdk

    The subset of the vendor SDK MAIDR calls.

    interface DotPadVendorSdk {
        getConnectedDevices: () => DotPadVendorDevice[];
        connectBleDevice: (
            device: unknown,
        ) => Promise<DotPadVendorDevice | null | undefined>;
        connectUsbDevice: (
            device: unknown,
        ) => Promise<DotPadVendorDevice | null | undefined>;
        disconnect: (device?: DotPadVendorDevice | null) => void;
        displayGraphicData: (
            hexData: string,
            device?: DotPadVendorDevice | null,
            displayMode?: string,
        ) => void;
        displayTextData: (
            inputData: string,
            device?: DotPadVendorDevice | null,
            displayMode?: string,
            needsTranslation?: boolean,
            callback?: ((device: DotPadVendorDevice, hex: string) => void) | null,
        ) => void | Promise<void>;
        displayLineData: (
            lineId: number,
            startCellIndex: number,
            hexData: string,
            displayMode: string,
            device?: DotPadVendorDevice | null,
        ) => void;
        setBrailleLanguage: (
            language: unknown,
            gradeOption?: number | null,
        ) => void;
        setNumberOfBraillePerLine: (count: number) => void;
        translateText: (
            inputText: string,
            applyWordWrap?: boolean,
        ) => Promise<string>;
        setCallBack: (
            messageCallBack:
                | (
                    (device: DotPadVendorDevice, dataCode: string, msg: string) => void
                )
                | null,
            keyCallBack:
                | ((device: DotPadVendorDevice, keyCode: string, msg: string) => void)
                | null,
            onKeyDownCallBack?:
                | ((device: DotPadVendorDevice, key: string, binary: string) => void)
                | null,
            onKeyUpCallBack?:
                | ((device: DotPadVendorDevice, key: string, binary: string) => void)
                | null,
        ) => void;
    }
    Index

    Properties

    getConnectedDevices: () => DotPadVendorDevice[]
    connectBleDevice: (
        device: unknown,
    ) => Promise<DotPadVendorDevice | null | undefined>
    connectUsbDevice: (
        device: unknown,
    ) => Promise<DotPadVendorDevice | null | undefined>
    disconnect: (device?: DotPadVendorDevice | null) => void
    displayGraphicData: (
        hexData: string,
        device?: DotPadVendorDevice | null,
        displayMode?: string,
    ) => void
    displayTextData: (
        inputData: string,
        device?: DotPadVendorDevice | null,
        displayMode?: string,
        needsTranslation?: boolean,
        callback?: ((device: DotPadVendorDevice, hex: string) => void) | null,
    ) => void | Promise<void>
    displayLineData: (
        lineId: number,
        startCellIndex: number,
        hexData: string,
        displayMode: string,
        device?: DotPadVendorDevice | null,
    ) => void
    setBrailleLanguage: (language: unknown, gradeOption?: number | null) => void
    setNumberOfBraillePerLine: (count: number) => void
    translateText: (inputText: string, applyWordWrap?: boolean) => Promise<string>
    setCallBack: (
        messageCallBack:
            | ((device: DotPadVendorDevice, dataCode: string, msg: string) => void)
            | null,
        keyCallBack:
            | ((device: DotPadVendorDevice, keyCode: string, msg: string) => void)
            | null,
        onKeyDownCallBack?:
            | ((device: DotPadVendorDevice, key: string, binary: string) => void)
            | null,
        onKeyUpCallBack?:
            | ((device: DotPadVendorDevice, key: string, binary: string) => void)
            | null,
    ) => void