@hotzware/openhab-tools/types/rulesx/alarmClock.d.ts

Tools for the openHAB JavaScript Automation Add-On.

/**
 * Creates an alarm clock with time and days configurable over Items, therefore compatible with Sitemaps.
 *
 * The manager rule that creates and updates the alarm clock rule {@link _createClockRule} on change of settings Items.
 * Also creates and removes the alarm clock rule on command ON/OFF of switchItem.
 *
 * @example
 * rulesx.createAlarmClock('Florian_alarm1', data => { console.log('Successfully tested alarm clock.'); });
 *
 * @memberof rulesx
 * @param {string} switchItem name of Item to switch the alarm on/off
 * @param {function} alarmFunc function to execute when the alarm clock fires
 */
export function createAlarmClock(switchItem: string, alarmFunc: Function): void;
/**
 * Creates all required Items for an alarm clock.
 *
 * @memberof rulesx
 * @param {String} switchItemName name of Item to switch alarm on/off
 * @param {String} switchItemLabel label of Item to switch alarm on/off
 * @param {String} persistenceGroup name of group whose members are persisted & restored on startup
 * @param {Boolean} [sitemapSnippet=false] whether to output a Sitemap snippet for alarm configuration
 * @param {String[]} [weekdaysLabels=['Montag', 'Dienstag', 'Mittwoch', 'Donnerstag', 'Freitag', 'Samstag', 'Sonntag']] names of weekdays in your language, starting with Monday & ending with Sunday
 */
export function createAlarmClockItems(switchItemName: string, switchItemLabel: string, persistenceGroup: string, sitemapSnippet?: boolean, weekdaysLabels?: string[]): void;
//# sourceMappingURL=alarmClock.d.ts.map