@hotzware/openhab-tools/types/thingsx/health.d.ts

Tools for the openHAB JavaScript Automation Add-On.

/**
 * Re-enables a Thing by disabling, and then enabling it again.
 *
 * @memberof thingsx
 * @param {string} thingUID
 */
export function reEnableThing(thingUID: string): void;
/**
 * Creates a rule that posts Thing statuses to String Items.
 * The rule takes the name of a group of String Items, generates a Thing UID for each member Item using string replace operations, and then posts the Thing status on every Thing status change to the Items.
 * The rule also runs when start level 100 is reached and regularly (every 5 minutes, starting with minute 0).
 *
 * @example
 * thingsx.createThingStatusRule('gYamahaState', ['_state', '_'], ['', ':']);
 * // This removes "_state" from the Item name and replaces all "_" with ":" to get the Thing UID from the members of the "gYamahaState" group members.
 *
 * @memberof thingsx
 * @param {string} groupName
 * @param {string|Array<string>} patterns Pattern(s) to replace.
 * @param {string|Array<string>} replacements String(s) that is/are used for replacing.
 */
export function createThingStatusToItemRule(groupName: string, patterns: string | Array<string>, replacements: string | Array<string>): void;
/**
 * Creates a rule that posts Thing statuses to String Items.
 * The rule takes the name of a group of String Items, generates a Thing UID for each member Item using string replace operations, and then posts the Thing status on every Thing status change to the Items.
 * The rule also runs when start level 100 is reached and regularly (every 5 minutes, starting with minute 0).
 *
 * @example
 * thingsx.createThingStatusRule('gYamahaState', ['_state', '_'], ['', ':']);
 * // This removes "_state" fromt the Item name and replaces all "_" with ":" to get the Thing UID from the members of the "gYamahaState" group members.
 *
 * @memberof thingsx
 * @param {string} thingUID
 * @param {string|Array<string>} patterns Pattern(s) to replace.
 * @param {string|Array<string>} replacements String(s) that is/are used for replacing.
 */
/**
 * Creates a rule that sends a notification if a Thing goes offline and another one if it goes back online.
 *
 * @memberof thingsx
 * @param {string} thingUID
 * @param {string[]} [recipients] the recipients of the notification: leave empty to send a broadcast notification or put the email addresses of the openHAB Cloud users to receive the notification
 * @param {number} [offlineDuration=60] the duration to wait for the Thing to come back online before sending the offline notification
 * @param {number} [onlineDuration=30] the duration to wait for the Thing to stay online before sending the online notification
 * @param {string} [offlineMessage='WARNUNG: %LABEL nicht mehr erreichbar (%STATUS)!'] the message to send when the Thing goes offline: use %UID, %LABEL, and %STATUS as placeholders for the respective values
 * @param {string} [onlineMessage='%LABEL wieder erreichbar.'] the message to send when the Thing goes back online: use %UID and %LABEL as placeholders for the respective values
 */
export function createThingStatusNotificationRule(thingUID: string, recipients?: string[], offlineDuration?: number, onlineDuration?: number, offlineMessage?: string, onlineMessage?: string): void;
/**
 * Creates a rule that re-enables a Thing on command ON to a given Item.
 *
 * @memberof thingsx
 * @param {string} itemName
 * @param {string} thingUID
 */
export function createReEnableThingWithItemRule(itemName: string, thingUID: string): void;
//# sourceMappingURL=health.d.ts.map