Hierarchy
-
Ha4usScriptingEnvironment
Properties
noRetained
noRetained: any
onlyRetained
onlyRetained: any
Methods
$onDestroy
- $onDestroy(destroyFunc: function): any
combine
- combine(...pattern: string[]): Observable<Ha4usMessage[]>
-
Parameters
-
Rest ...pattern: string[]
Returns Observable<Ha4usMessage[]>
doIn
- doIn(duration: string | number): Observable<ScheduleEvent>
-
Parameters
-
duration: string | number
Returns Observable<ScheduleEvent>
get
- get(topic: string): Promise<any>
-
Parameters
Returns Promise<any>
load
- load(file: string): Promise<any>
-
Parameters
Returns Promise<any>
observe
- observe(...topics: string[]): Observable<Ha4usMessage>
- observe(topic: string, ...params: any[]): Observable<Ha4usMessage>
-
Parameters
Returns Observable<Ha4usMessage>
stream of messages
-
Parameters
-
topic: string
-
Rest ...params: any[]
Returns Observable<Ha4usMessage>
require
-
Parameters
Returns any
the exported module
save
- save(data: any, file: string): Promise<void>
-
Parameters
Returns Promise<void>
schedule
- schedule(eventOrOpts: SimpleTime | SchedulingOptions, ...times: SimpleTime[]): Observable<ScheduleEvent>
-
Parameters
-
eventOrOpts: SimpleTime | SchedulingOptions
-
Rest ...times: SimpleTime[]
Returns Observable<ScheduleEvent>
set
- set(topic: string, value: any): Promise<any>
-
Parameters
Returns Promise<any>
status
- status(topic: string, value: any, retained: boolean): void
-
Parameters
-
topic: string
-
value: any
-
retained: boolean
Returns void
This is the scripting environment for scripts developed for ha4us-scripts.