hap-nodejs/dist/types.d.ts

HAP-NodeJS is a Node.js implementation of HomeKit Accessory Server.

import { Formats, Perms, Units } from "./lib/Characteristic";
import { ResourceRequestReason } from "./lib/controller";
import { HAPStatus } from "./lib/HAPServer";
/**
 * @group Utils
 */
export type Nullable<T> = T | null;
/**
 * @group Utils
 */
export type WithUUID<T> = T & {
    UUID: string;
};
/**
 * Like TypeScripts `Partial` but allowing null as a value.
 *
 * @group Utils
 */
export type PartialAllowingNull<T> = {
    [P in keyof T]?: T[P] | null;
};
/**
 * Type of the constructor arguments of the provided constructor type.
 *
 * @group Utils
 */
export type ConstructorArgs<C> = C extends new (...args: infer A) => any ? A : never;
/**
 * UUID string uniquely identifying every HAP connection.
 *
 * @group HAP Accessory Server
 */
export type SessionIdentifier = string;
/**
 * Defines a mac address.
 * Must have a format like 'XX:XX:XX:XX:XX:XX' with XX being a valid hexadecimal string
 *
 * @group Utils
 */
export type MacAddress = string;
/**
 * Defines a pincode for the HAP accessory.
 * Must have a format like "XXX-XX-XXX".
 *
 * @group Accessory
 */
export type HAPPincode = string;
/**
 * @group Utils
 */
export type InterfaceName = string;
/**
 * @group Utils
 */
export type IPv4Address = string;
/**
 * @group Utils
 */
export type IPv6Address = string;
/**
 * @group Utils
 */
export type IPAddress = IPv4Address | IPv6Address;
/**
 * @group Utils
 */
export type NodeCallback<T> = (err: Nullable<Error> | undefined, data?: T) => void;
/**
 * @group Utils
 */
export type VoidCallback = (err?: Nullable<Error>) => void;
/**
 * @group Utils
 */
export type PrimitiveTypes = string | number | boolean;
/**
 * @group Characteristic
 */
export type CharacteristicValue = PrimitiveTypes | PrimitiveTypes[] | {
    [key: string]: PrimitiveTypes;
};
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicJsonObject {
    type: string;
    iid: number;
    value?: Nullable<CharacteristicValue>;
    perms: Perms[];
    format: Formats | string;
    description?: string;
    unit?: Units | string;
    minValue?: number;
    maxValue?: number;
    minStep?: number;
    maxLen?: number;
    maxDataLen?: number;
    "valid-values"?: number[];
    "valid-values-range"?: [min: number, max: number];
}
/**
 * @group HAP Accessory Server
 */
export interface ServiceJsonObject {
    type: string;
    iid: number;
    characteristics: CharacteristicJsonObject[];
    hidden?: boolean;
    primary?: boolean;
    linked?: number[];
}
/**
 * @group HAP Accessory Server
 */
export interface AccessoryJsonObject {
    aid: number;
    services: ServiceJsonObject[];
}
/**
 * @group HAP Accessory Server
 */
export interface AccessoriesResponse {
    accessories: AccessoryJsonObject[];
}
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicId {
    aid: number;
    iid: number;
}
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicsReadRequest {
    ids: CharacteristicId[];
    includeMeta: boolean;
    includePerms: boolean;
    includeType: boolean;
    includeEvent: boolean;
}
/**
 * @group HAP Accessory Server
 */
export interface PartialCharacteristicReadDataValue {
    value: CharacteristicValue | null;
    status?: HAPStatus.SUCCESS;
    type?: string;
    format?: string;
    unit?: string;
    minValue?: number;
    maxValue?: number;
    minStep?: number;
    maxLen?: number;
    perms?: Perms[];
    ev?: boolean;
}
/**
 * @group HAP Accessory Server
 */
export interface PartialCharacteristicReadError {
    status: HAPStatus;
}
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicReadDataValue extends PartialCharacteristicReadDataValue {
    aid: number;
    iid: number;
}
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicReadError extends PartialCharacteristicReadError {
    aid: number;
    iid: number;
}
/**
 * @group HAP Accessory Server
 */
export type PartialCharacteristicReadData = PartialCharacteristicReadDataValue | PartialCharacteristicReadError;
/**
 * @group HAP Accessory Server
 */
export type CharacteristicReadData = CharacteristicReadDataValue | CharacteristicReadError;
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicsReadResponse {
    characteristics: CharacteristicReadData[];
}
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicWrite {
    aid: number;
    iid: number;
    value?: CharacteristicValue;
    ev?: boolean;
    authData?: string;
    remote?: boolean;
    r?: boolean;
}
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicsWriteRequest {
    characteristics: CharacteristicWrite[];
    pid?: number;
}
/**
 * @group HAP Accessory Server
 */
export interface PartialCharacteristicWriteDataValue {
    value?: CharacteristicValue | null;
    status: HAPStatus.SUCCESS;
}
/**
 * @group HAP Accessory Server
 */
export interface PartialCharacteristicWriteError {
    status: HAPStatus;
    value?: undefined;
}
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicWriteDataValue extends PartialCharacteristicWriteDataValue {
    aid: number;
    iid: number;
}
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicWriteError extends PartialCharacteristicWriteError {
    aid: number;
    iid: number;
}
/**
 * @group HAP Accessory Server
 */
export type PartialCharacteristicWriteData = PartialCharacteristicWriteDataValue | PartialCharacteristicWriteError;
/**
 * @group HAP Accessory Server
 */
export type CharacteristicWriteData = CharacteristicWriteDataValue | CharacteristicWriteError;
/**
 * @group HAP Accessory Server
 */
export interface CharacteristicsWriteResponse {
    characteristics: CharacteristicWriteData[];
}
/**
 * @group HAP Accessory Server
 */
export type PrepareWriteRequest = {
    ttl: number;
    pid: number;
};
/**
 * @group HAP Accessory Server
 */
export declare const enum ResourceRequestType {
    IMAGE = "image"
}
/**
 * @group HAP Accessory Server
 */
export interface ResourceRequest {
    aid?: number;
    "image-height": number;
    "image-width": number;
    "reason"?: ResourceRequestReason;
    "resource-type": ResourceRequestType;
}
//# sourceMappingURL=types.d.ts.map