zigbee-herdsman
Version:
An open source ZigBee gateway solution with node.js.
23 lines • 1.52 kB
TypeScript
import { PortInfo } from '@serialport/bindings-cpp';
import { Adapter, DiscoverableUSBAdapter } from './tstype';
export declare function matchUSBAdapter(adapter: Adapter, path: string): Promise<boolean>;
export declare function findUSBAdapter(adapter?: Adapter, path?: string): Promise<[adapter: DiscoverableUSBAdapter, path: PortInfo['path']] | undefined>;
export declare function findmDNSAdapter(path: string): Promise<[adapter: Adapter, path: string, baudRate: number]>;
export declare function findTCPAdapter(path: string, adapter?: Adapter): Promise<[adapter: Adapter, path: string]>;
/**
* Discover adapter using mDNS, TCP or USB.
*
* @param adapter The adapter type.
* - mDNS: Unused.
* - TCP: Required, cannot discover at this time.
* - USB: Optional, limits the discovery to the specified adapter type.
* @param path The path to the adapter.
* - mDNS: Required, serves to initiate the discovery.
* - TCP: Required, cannot discover at this time.
* - USB: Optional, limits the discovery to the specified path.
* @returns adapter An adapter type supported by Z2M. While result is TS-typed, this should be validated against actual values before use.
* @returns path Path to adapter.
* @returns baudRate [optional] Discovered baud rate of the adapter. Valid only for mDNS discovery at the moment.
*/
export declare function discoverAdapter(adapter?: Adapter, path?: string): Promise<[adapter: Adapter, path: string, baudRate?: number | undefined]>;
//# sourceMappingURL=adapterDiscovery.d.ts.map