theta-ble-client-react-native/lib/typescript/theta-ble/theta-ble.d.ts

This library provides a way to control RICOH THETA using

import { ThetaDevice } from '../theta-device';
import type { Timeout } from '../values';
import type { ThetaModel } from '../service';
/**
 * scan properties
 */
interface ScanProps {
    /**
     * Name of THETA to connect.
     */
    name?: string;
    /**
     * Configuration of timeout.
     */
    timeout?: Timeout;
}
/**
 * Scan for nearby THETA.
 *
 * Call {@link ThetaDevice.release} when the use of the acquired {@link ThetaDevice} is complete.
 *
 * @param props scan properties.
 * @returns Found THETA. If no name is specified, an array is returned.
 */
export declare function scan(props?: ScanProps): Promise<ThetaDevice | ThetaDevice[] | undefined>;
/**
 * Deprecated
 * Scan for nearby THETA.
 *
 * Call {@link ThetaDevice.release} when the use of the acquired {@link theta-device.ThetaDevice} is complete.
 *
 * @param name Name of THETA to connect.
 * @param uuid UUID used for authentication.
 * @param timeout Configuration of timeout.
 * @returns Found THETA
 */
export declare function scan(name: string, timeout?: Timeout): Promise<ThetaDevice | undefined>;
/**
 * scan SSID properties
 */
interface ScanSsidParams {
    /**
     * THETA model
     */
    model?: ThetaModel;
    /**
     * Specifies a time period (in milliseconds) required to scan THETA.
     */
    timeout?: number;
}
/**
 * SSID and default password
 */
interface SsidListItem {
    /**
     * SSID
     */
    ssid: string;
    /**
     * Default password
     */
    password: string;
}
/**
 * Scan for nearby THETA SSID.
 *
 * @param params scan SSID properties.
 * @returns Found THETA SSID list.
 */
export declare function scanThetaSsid(params?: ScanSsidParams): Promise<SsidListItem[]>;
export {};
//# sourceMappingURL=theta-ble.d.ts.map