@ha4us/script.adapter/dist/sandbox.interface.d.ts

Scripting Adapter for the ha4us

/**
 * @module Scripting Environment
 * @preferred
 *
 * This is a doc comment for a dynamic module.
 */
import { Observable } from 'rxjs';
import { Ha4usMessage } from '@ha4us/core';
import { ScheduleEvent, SimpleTime } from 'us-scheduler';
/**
 * Logger interface
 */
export interface Logger {
    /**
     * outputs a debug log statement in the log file
     * @param  args the data to be logged
     */
    debug(...args: any[]): void;
    /**
     * outputs a error log statement in the log file
     * @param  args the data to be logged
     */
    info(...args: any[]): void;
    /**
     * outputs a info log statement in the log file
     * @param  args the data to be logged
     */
    warn(...args: any[]): void;
    /**
     * outputs a error log statement in the log file
     * @param  args the data to be logged
     */
    error(...args: any[]): void;
}
/**
 * This is the scripting environment for scripts developed for
 * ha4us-scripts.
 *
 */
export interface Ha4usScriptingEnvironment {
    log: Logger;
    console: Logger;
    onlyRetained: any;
    noRetained: any;
    pick: any;
    pickEach: any;
    /**
     * Observes one or more MQTT topic
     * @param   ...topics the mqtt topics to subscribe
     * @return           stream of messages
     */
    observe(...topics: string[]): Observable<Ha4usMessage>;
    observe(topic: string, ...params: any[]): Observable<Ha4usMessage>;
    /**
     * requires a  module
     * @param   md name of module to require
     * @return    the exported module
     */
    require(md: string): any;
    combine(...pattern: string[]): Observable<Ha4usMessage[]>;
    set(topic: string, value: any): Promise<any>;
    get(topic: string): Promise<any>;
    status(topic: string, value: any, retained: boolean): void;
    schedule(eventOrOpts: SimpleTime, ...times: SimpleTime[]): Observable<ScheduleEvent>;
    doIn(duration: string | number): Observable<ScheduleEvent>;
    load(file: string): Promise<any>;
    save(data: any, file: string): Promise<void>;
    $onDestroy(destroyFunc: () => void): any;
}