@m1kad0/hannah-proto 4.8.0 → 5.1.0

package/dist/v2/device_model.d.ts

@@ -0,0 +1,240 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "hannah.v2";
+/**
+ * What kind of device this is. A class exists per family of verbs, not per feature:
+ * a measuring socket is a SOCKET with a filled POWER slot, not a class of its own.
+ */
+export declare enum DeviceClass {
+    DEVICE_CLASS_UNSPECIFIED = 0,
+    /** DEVICE_CLASS_LIGHT - Switchable light. Slots: ON (required), BRIGHTNESS, COLOR, COLOR_TEMPERATURE. */
+    DEVICE_CLASS_LIGHT = 1,
+    /** DEVICE_CLASS_SOCKET - Socket/plug. Slots: ON (required), POWER, ENERGY, VOLTAGE, CURRENT. */
+    DEVICE_CLASS_SOCKET = 2,
+    /**
+     * DEVICE_CLASS_GENERIC_BINARY_SWITCH - Any other switchable boolean that fits no other class (scene-like switches,
+     * flags, vendor specific switches). Slots: ON (required).
+     */
+    DEVICE_CLASS_GENERIC_BINARY_SWITCH = 3,
+    /**
+     * DEVICE_CLASS_THERMOSTAT - Radiator or room thermostat. Slots: TARGET_TEMPERATURE (required), TEMPERATURE,
+     * HUMIDITY, VALVE. Comfort/eco setpoints and similar are not slots. Units with an
+     * operating mode and a fan are DEVICE_CLASS_CLIMATE.
+     */
+    DEVICE_CLASS_THERMOSTAT = 4,
+    /** DEVICE_CLASS_COVER - Blind, shutter, awning. Slots: POSITION (required), TILT, STOP. */
+    DEVICE_CLASS_COVER = 5,
+    /**
+     * DEVICE_CLASS_SENSOR - Read-only measurements. At least one measurement slot: TEMPERATURE, HUMIDITY,
+     * ILLUMINANCE, PRESSURE, CO2, IAQ, VOC, POWER, ENERGY, MOTION.
+     */
+    DEVICE_CLASS_SENSOR = 6,
+    /** DEVICE_CLASS_CONTACT - Door or window contact. Slots: OPEN (required, read-only). */
+    DEVICE_CLASS_CONTACT = 7,
+    /**
+     * DEVICE_CLASS_GENERIC - Fallback for anything that matches no class: a list of typed values
+     * (GENERIC_NUMBER / GENERIC_BOOL / GENERIC_TEXT), each with label and unit.
+     */
+    DEVICE_CLASS_GENERIC = 8,
+    /**
+     * DEVICE_CLASS_CLIMATE - Air conditioner / room climate unit with operating mode and fan. Slots: ON (required),
+     * MODE, TARGET_TEMPERATURE, TEMPERATURE, HUMIDITY, FAN_SPEED. A radiator thermostat
+     * without mode and fan is a THERMOSTAT, not a CLIMATE.
+     */
+    DEVICE_CLASS_CLIMATE = 9,
+    UNRECOGNIZED = -1
+}
+/**
+ * A finer kind within a device class, for the cases where the class alone does not say
+ * what a user means ("the windows" versus "the doors"). Optional: the adapter sets it
+ * where it knows (function, role, type detector), otherwise UNSPECIFIED.
+ */
+export declare enum DeviceSubtype {
+    /** DEVICE_SUBTYPE_UNSPECIFIED - No statement. Hannah Core may fall back to the device name. */
+    DEVICE_SUBTYPE_UNSPECIFIED = 0,
+    /** DEVICE_SUBTYPE_WINDOW - DEVICE_CLASS_CONTACT: window contact. */
+    DEVICE_SUBTYPE_WINDOW = 1,
+    /** DEVICE_SUBTYPE_DOOR - DEVICE_CLASS_CONTACT: door contact. */
+    DEVICE_SUBTYPE_DOOR = 2,
+    UNRECOGNIZED = -1
+}
+/**
+ * What a slot means, and therefore which scale and unit its value has. The adapter
+ * normalizes every value to exactly this scale; Core relies on it.
+ */
+export declare enum SlotKind {
+    SLOT_KIND_UNSPECIFIED = 0,
+    /** SLOT_KIND_ON - --- switching and light --- */
+    SLOT_KIND_ON = 1,
+    /** SLOT_KIND_BRIGHTNESS - number, 0-100 (%) */
+    SLOT_KIND_BRIGHTNESS = 2,
+    /** SLOT_KIND_COLOR - rgb, 0xRRGGBB */
+    SLOT_KIND_COLOR = 3,
+    /** SLOT_KIND_COLOR_TEMPERATURE - number, Kelvin (e.g. 2700 warm white, 6500 cold white) */
+    SLOT_KIND_COLOR_TEMPERATURE = 4,
+    /** SLOT_KIND_POWER - --- electricity --- */
+    SLOT_KIND_POWER = 10,
+    /** SLOT_KIND_ENERGY - number, kWh (cumulative) */
+    SLOT_KIND_ENERGY = 11,
+    /** SLOT_KIND_VOLTAGE - number, V */
+    SLOT_KIND_VOLTAGE = 12,
+    /** SLOT_KIND_CURRENT - number, A */
+    SLOT_KIND_CURRENT = 13,
+    /** SLOT_KIND_TARGET_TEMPERATURE - --- climate --- */
+    SLOT_KIND_TARGET_TEMPERATURE = 20,
+    /** SLOT_KIND_TEMPERATURE - number, °C, measured value */
+    SLOT_KIND_TEMPERATURE = 21,
+    /** SLOT_KIND_HUMIDITY - number, 0-100 (% relative) */
+    SLOT_KIND_HUMIDITY = 22,
+    /** SLOT_KIND_VALVE - number, 0-100 (% open) */
+    SLOT_KIND_VALVE = 23,
+    /**
+     * SLOT_KIND_MODE - Operating mode of a CLIMATE device, text, one of: "cool", "heat", "dry", "fan_only",
+     * "auto". The adapter normalizes the device's own values to this vocabulary. The modes the
+     * device really supports are listed in Slot.options.
+     */
+    SLOT_KIND_MODE = 24,
+    /**
+     * SLOT_KIND_FAN_SPEED - Fan level of a CLIMATE device, text, one of: "low", "medium", "high", "auto". Supported
+     * levels are listed in Slot.options.
+     */
+    SLOT_KIND_FAN_SPEED = 25,
+    /** SLOT_KIND_POSITION - --- cover --- */
+    SLOT_KIND_POSITION = 30,
+    /** SLOT_KIND_TILT - number, 0-100 (%) */
+    SLOT_KIND_TILT = 31,
+    /** SLOT_KIND_STOP - boolean trigger: true = stop movement, not a state */
+    SLOT_KIND_STOP = 32,
+    /** SLOT_KIND_OPEN - --- binary sensors --- */
+    SLOT_KIND_OPEN = 40,
+    /** SLOT_KIND_MOTION - boolean: true = motion/presence detected */
+    SLOT_KIND_MOTION = 41,
+    /** SLOT_KIND_ILLUMINANCE - --- further measurements --- */
+    SLOT_KIND_ILLUMINANCE = 50,
+    /** SLOT_KIND_PRESSURE - number, hPa */
+    SLOT_KIND_PRESSURE = 51,
+    /** SLOT_KIND_CO2 - number, ppm */
+    SLOT_KIND_CO2 = 52,
+    /** SLOT_KIND_IAQ - number, index 0-500 */
+    SLOT_KIND_IAQ = 53,
+    /** SLOT_KIND_VOC - number, ppm */
+    SLOT_KIND_VOC = 54,
+    /** SLOT_KIND_GENERIC_NUMBER - --- generic values (DEVICE_CLASS_GENERIC), described by label and unit --- */
+    SLOT_KIND_GENERIC_NUMBER = 90,
+    SLOT_KIND_GENERIC_BOOL = 91,
+    SLOT_KIND_GENERIC_TEXT = 92,
+    UNRECOGNIZED = -1
+}
+/** The value of a slot, typed. Which case is used follows from the SlotKind. */
+export interface SlotValue {
+    boolean?: boolean | undefined;
+    number?: number | undefined;
+    text?: string | undefined;
+    /** 0xRRGGBB, used by SLOT_KIND_COLOR */
+    rgb?: number | undefined;
+}
+/** One capability of a device. */
+export interface Slot {
+    /**
+     * Stable ID of this slot within its device, chosen by the adapter. For the standard
+     * kinds the lowercase kind name without prefix ("on", "brightness", "target_temperature")
+     * is recommended; it is what SlotUpdate and SetSlot address. GENERIC slots need it
+     * because a device can carry several of the same kind.
+     */
+    slotId: string;
+    kind: SlotKind;
+    /** current value; unset = unknown */
+    value: SlotValue | undefined;
+    /** false = read-only (measurements, contacts) */
+    writable: boolean;
+    /** informational, and for GENERIC slots; standard kinds have a fixed unit (see SlotKind) */
+    unit: string;
+    /** human-readable name, used by GENERIC slots */
+    label: string;
+    /**
+     * Minimum user trust level (0-10, same scale as the users' trust level) required to
+     * control this slot, read by the adapter from common.custom["hannah.0"].neededTrust.
+     * Unset = not configured, no restriction — distinct from an explicit 0.
+     */
+    requiredTrustLevel?: number | undefined;
+    /**
+     * The values this slot accepts, for SLOT_KIND_MODE and SLOT_KIND_FAN_SPEED, taken from the
+     * vocabulary of the kind (e.g. a cooling-only unit lists just "cool", "dry", "fan_only").
+     * Empty = no statement, every value of the vocabulary may work. Hannah uses it to answer
+     * honestly when a device cannot do what was asked.
+     */
+    options: string[];
+}
+/** A device, as the adapter derived it from the ioBroker objects (grouping, class, slots). */
+export interface TypedDevice {
+    /** stable ID of the device, chosen by the adapter; not an ioBroker state ID */
+    deviceId: string;
+    /** display name, mandatory */
+    name: string;
+    /** room_id (enum ID segment, see AgentRoom), mandatory */
+    room: string;
+    /** floor, empty = none */
+    floor: string;
+    deviceClass: DeviceClass;
+    slots: Slot[];
+    /** false = device currently unreachable */
+    available: boolean;
+    /** finer kind within the class, UNSPECIFIED = no statement */
+    subtype: DeviceSubtype;
+}
+/**
+ * All devices the adapter knows. Sent on AgentConnect and whenever the set of devices
+ * or their structure changes (devices added/removed, slots added/removed).
+ */
+export interface TypedDeviceSnapshot {
+    devices: TypedDevice[];
+}
+/**
+ * A slot changed. ack=true means the device confirmed the value (as opposed to the
+ * "desired" value), Hannah uses this to verify that a SetSlot was executed.
+ */
+export interface SlotUpdate {
+    deviceId: string;
+    slotId: string;
+    value: SlotValue | undefined;
+    ack: boolean;
+    /** Unix timestamp in milliseconds */
+    ts: bigint;
+}
+/** A device became reachable or unreachable, without any of its slots changing. */
+export interface DeviceAvailability {
+    deviceId: string;
+    available: boolean;
+}
+/**
+ * Hannah wants to control a slot. The adapter maps this onto the real state(s) and
+ * denormalizes the value; the confirmed result comes back as a SlotUpdate with ack=true.
+ */
+export interface SetSlot {
+    deviceId: string;
+    slotId: string;
+    value: SlotValue | undefined;
+}
+export declare const SlotValue: MessageFns<SlotValue>;
+export declare const Slot: MessageFns<Slot>;
+export declare const TypedDevice: MessageFns<TypedDevice>;
+export declare const TypedDeviceSnapshot: MessageFns<TypedDeviceSnapshot>;
+export declare const SlotUpdate: MessageFns<SlotUpdate>;
+export declare const DeviceAvailability: MessageFns<DeviceAvailability>;
+export declare const SetSlot: MessageFns<SetSlot>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;
+export type DeepPartial<T> = T extends bigint ? string | number | bigint : T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};