homebridge-unifi-protect
Version:
Homebridge UniFi Protect plugin providing complete HomeKit integration for the entire UniFi Protect ecosystem with full support for most features including HomeKit Secure Video, multiple controllers, blazing fast performance, and much more.
21 lines • 927 B
TypeScript
interface DeviceDescriptorConfig {
readonly host: string | null;
readonly mac: string;
readonly marketName: string;
readonly name?: string;
readonly type: string;
}
interface DescribeDeviceOptions {
readonly includeNetwork?: boolean;
readonly name?: string | null;
}
/**
* Render a Protect device or controller config as a human-readable log descriptor.
*
* @param device - The device or NVR config to describe - any record carrying host, mac, marketName, an optional name, and type.
* @param options - `includeNetwork` appends the address/MAC triage suffix; `name` overrides the displayed name.
* @returns "Name [Model]" plainly, or "Name [Model] (address: IP mac: MAC)" when `includeNetwork` is set.
*/
export declare function describeDevice(device: DeviceDescriptorConfig, { includeNetwork, name }?: DescribeDeviceOptions): string;
export {};
//# sourceMappingURL=device-descriptor.d.ts.map