hottohts
Version:
TypeScript library for HottoH pellet stoves
173 lines • 6.25 kB
TypeScript
/**
* hottohts - High-level API for HottoH pellet stoves
*
* Provides a user-friendly interface for reading and controlling HottoH stoves.
* All methods, constants, and logic are ported 1:1 from Hottohpy for deterministic parity.
*
* @module hottoht
*/
import { HottohRemoteClient } from './client';
/**
* High-level API for HottoH stoves. Use this class for all stove operations.
*
* Example:
* const stove = new Hottoh('192.168.1.100', 5001);
* stove.connect();
* // ...
*/
export declare class Hottoh {
private port;
private address;
client: HottohRemoteClient;
private _isDisposed;
constructor(address: string, port: number, id?: number);
/**
* Connect to the stove and start polling
*/
connect(): void;
/**
* Disconnect from the stove and stop polling
*/
disconnect(): void;
/**
* Properly dispose all resources to prevent memory leaks
* Call this when completely done with the Hottoh instance
*/
dispose(): void;
isConnected(): boolean;
private _extractData;
private _getMac;
setTemperature(value: number): Promise<boolean>;
_getFirmwareVersion(): string | null;
_getWifiSignal(): string | null;
_getPageIndex(): string | null;
_getManufacturer(): string | null;
_getIsBitmapVisible(): string | null;
_getIsValid(): string | null;
_getStoveType(): number | null;
_getStoveState(): string | null;
_getStoveIsOn(): string | null;
_getEcoMode(): string | null;
_getChronoMode(): string | null;
_getTemperatureRoom1(): string | null;
_getSetTemperatureRoom1(): string | null;
_getSetMaxTemperatureRoom1(): string | null;
_getSetMinTemperatureRoom1(): string | null;
_getTemperatureRoom2(): string | null;
_getSetTemperatureRoom2(): string | null;
_getSetMaxTemperatureRoom2(): string | null;
_getSetMinTemperatureRoom2(): string | null;
_getTemperatureRoom3(): string | null;
_getSetTemperatureRoom3(): string | null;
_getSetMaxTemperatureRoom3(): string | null;
_getSetMinTemperatureRoom3(): string | null;
_getTemperatureWater(): string | null;
_getSetTemperatureWater(): string | null;
_getSetMaxTemperatureWater(): string | null;
_getSetMinTemperatureWater(): string | null;
_getSmokeTemperature(): string | null;
_getPowerLevel(): string | null;
_getSetPowerLevel(): string | null;
_getSetMaxPowerLevel(): string | null;
_getSetMinPowerLevel(): string | null;
_getSpeedFanSmoke(): string | null;
_getSpeedFan1(): string | null;
_getSetSpeedFan1(): string | null;
_getSetMaxSpeedFan1(): string | null;
_getSpeedFan2(): string | null;
_getSetSpeedFan2(): string | null;
_getSetMaxSpeedFan2(): string | null;
_getSpeedFan3(): string | null;
_getSetSpeedFan3(): string | null;
_getSetMaxSpeedFan3(): string | null;
_getFlowSwitch(): string | null;
_getGenericPump(): string | null;
_getAirEx1(): string | null;
_getAirEx2(): string | null;
_getAirEx3(): string | null;
_getPuffer(): string | null;
_getSetPuffer(): string | null;
_getSetMinPuffer(): string | null;
_getSetMaxPuffer(): string | null;
_getBoiler(): string | null;
_getSetBoiler(): string | null;
_getSetMinBoiler(): string | null;
_getSetMaxBoiler(): string | null;
_getDhw(): string | null;
_getSetDhw(): string | null;
_getSetMinDhw(): string | null;
_getSetMaxDhw(): string | null;
setWaterTemperature(value: number): boolean;
setPowerLevel(value: number): boolean;
setSpeedFan1(value: number): boolean;
setSpeedFan2(value: number): boolean;
setSpeedFan3(value: number): boolean;
setEcoModeOn(): boolean;
setEcoModeOff(): boolean;
setChronoModeOn(): boolean;
setChronoModeOff(): boolean;
setOn(): boolean;
setOff(): boolean;
getSmokeTemperature(): number | null;
getWaterTemperature(): number | null;
getSetWaterTemperature(): number | null;
getSetMinWaterTemperature(): number | null;
getSetMaxWaterTemperature(): number | null;
getSpeedFanSmoke(): number | null;
getTemperatureRoom1(): number | null;
getSetTemperatureRoom1(): number | null;
getSetMinTemperatureRoom1(): number | null;
getSetMaxTemperatureRoom1(): number | null;
getTemperatureRoom2(): number | null;
getSetTemperatureRoom2(): number | null;
getSetMinTemperatureRoom2(): number | null;
getSetMaxTemperatureRoom2(): number | null;
getTemperatureRoom3(): number | null;
getSetTemperatureRoom3(): number | null;
getSetMinTemperatureRoom3(): number | null;
getSetMaxTemperatureRoom3(): number | null;
getSpeedFan1(): number | null;
getSetSpeedFan1(): number | null;
getSetMaxSpeedFan1(): number | null;
getSpeedFan2(): number | null;
getSetSpeedFan2(): number | null;
getSetMaxSpeedFan2(): number | null;
getSpeedFan3(): number | null;
getSetSpeedFan3(): number | null;
getSetMaxSpeedFan3(): number | null;
getPowerLevel(): number | null;
getSetPowerLevel(): number | null;
getSetMinPowerLevel(): number | null;
getSetMaxPowerLevel(): number | null;
getAirEx1(): number | null;
getAirEx2(): number | null;
getAirEx3(): number | null;
getAction(): string | null;
getIsOn(): boolean | null;
getEcoMode(): boolean | null;
getChronoMode(): boolean | null;
getMode(): string | null;
getName(): string | null;
getFirmware(): string | null;
getWifi(): string | null;
getManufacturer(): string | null;
getWaterPump(): boolean | null;
_getStoveTypeBitArray(): boolean[];
isBoilerEnabled(): boolean;
isDomesticHotWaterEnabled(): boolean;
getFanNumber(): number;
isTempRoom1Enabled(): boolean;
isTempRoom2Enabled(): boolean;
isTempRoom3Enabled(): boolean;
isTempWaterEnabled(): boolean;
isPumpEnabled(): boolean;
isFlowSwitchEnabled(): boolean;
isPufferEnabled(): boolean;
isBoilerTempEnabled(): boolean;
isDhwEnabled(): boolean;
isAirEx1Enabled(): boolean;
isAirEx2Enabled(): boolean;
isAirEx3Enabled(): boolean;
isGenericPumpEnabled(): boolean;
}
//# sourceMappingURL=hottoht.d.ts.map