triggers

Methods

(static) ChannelEventTrigger(channel, event, triggerNameopt)

Description:

• Creates a trigger that fires upon specific events in a channel.

Source:

• triggers.js, line 57

Example

ChannelEventTrigger('astro:sun:local:rise#event', 'START');

Parameters:

(static) DateTimeTrigger(itemOrName, timeOnlyopt, offsetopt, triggerNameopt)

Description:

• Creates a trigger that fires at an (optional) date and time specified in a DateTime Item.

Source:

• triggers.js, line 271

Example

DateTimeTrigger('MyDateTimeItem');

Parameters:

(static) GenericCronTrigger(expression, triggerNameopt)

Description:

• Creates a trigger that fires on a cron schedule. The supplied cron expression defines when the trigger will fire.

Source:

• triggers.js, line 239

Example

GenericCronTrigger('0 30 16 * * ? *');

Parameters:

(static) GenericEventTrigger(eventTopic, eventSource, eventTypes, triggerNameopt)

Description:

• Creates a trigger that fires upon a matching event from the event bus.

  Please have a look at the Event Bus docs to learn about events.

Source:

• triggers.js, line 303

Example

// Triggers when an Item is added or removed
GenericEventTrigger('openhab/items/**', '', ['ItemAddedEvent', 'ItemRemovedEvent'])
// Triggers when the Item "OutdoorLights" is commanded by expire
GenericEventTrigger('openhab/items/OutdoorLights/*', 'org.openhab.core.expire', 'ItemCommandEvent')

Parameters:

(static) GroupCommandTrigger(groupOrName, commandopt, triggerNameopt)

Description:

• Creates a trigger that fires upon a member of a group receiving a command. Note that the group Item does not need to change state.

Source:

• triggers.js, line 168

Example

GroupCommandTrigger('my_group', 'OFF');

Parameters:

(static) GroupStateChangeTrigger(groupOrName, oldStateopt, newStateopt, triggerNameopt)

Description:

• Creates a trigger that fires upon a member of a group changing state. Note that group Item does not need to change state.

Source:

• triggers.js, line 133

Example

GroupStateChangeTrigger('my_group', 'OFF', 'ON');

Parameters:

(static) GroupStateUpdateTrigger(groupOrName, stateopt, triggerNameopt)

Description:

• Creates a trigger that fires upon a member of a group receiving a state update. Note that group Item does not need to change state.

Source:

• triggers.js, line 151

Example

GroupStateUpdateTrigger('my_group', 'OFF');

Parameters:

(static) ItemCommandTrigger(itemOrName, commandopt, triggerNameopt)

Description:

• Creates a trigger that fires upon an Item receiving a command. Note that the Item does not need to change state.

Source:

• triggers.js, line 115

Example

ItemCommandTrigger('my_item'); // received command
ItemCommandTrigger('my_item', 'OFF'); // received command OFF

Parameters:

(static) ItemStateChangeTrigger(itemOrName, oldStateopt, newStateopt, triggerNameopt)

Description:

• Creates a trigger that fires upon an Item changing state.

Source:

• triggers.js, line 78

Example

ItemStateChangeTrigger('my_item'); // changed
ItemStateChangeTrigger('my_item', 'OFF', 'ON'); // changed from OFF to ON
ItemStateChangeTrigger('my_item', undefined, 'ON'); // changed to ON
ItemStateChangeTrigger('my_item', 'OFF', undefined); // changed from OFF

Parameters:

(static) ItemStateUpdateTrigger(itemOrName, stateopt, triggerNameopt)

Description:

• Creates a trigger that fires upon an Item receiving a state update. Note that the Item does not need to change state.

Source:

• triggers.js, line 97

Example

ItemStateUpdateTrigger('my_item'); // received update
ItemStateUpdateTrigger('my_item', 'OFF'); // received update OFF

Parameters:

(static) PIDTrigger(inputItem, setpointItem, kp, ki, kd, kdTimeConstant, loopTime, commandItemopt, integralMinValueopt, integralMaxValueopt, pInspectorItemopt, iInspectorItemopt, dInspectorItemopt, errorInspectorItemopt, triggerNameopt)

Description:

• Creates a trigger for the PID Controller Automation add-on.

Source:

• triggers.js, line 375

Example

rules.JSRule({
  name: 'PID rule',
  triggers: [
    triggers.PIDTrigger('currentTemperature', 'targetTemperature', 1, 1, 1, 1, 10000, undefined, 1, 100);
  ],
  execute: (event) => {
    // Look out what the max value for your Item is!
    const command = parseInt(event.receivedCommand) > 100 ? '100' : event.receivedCommand;
    items.getItem('thermostat').sendCommand(command);
  }
});

Parameters:

(static) PWMTrigger(dutycycleItem, interval, minDutyCycleopt, maxDutyCycleopt, deadManSwitchopt, triggerNameopt)

Description:

• Creates a trigger for the Pulse Width Modulation (PWM) Automation add-on.

Source:

• triggers.js, line 333

Example

rules.JSRule({
  name: 'PWM rule',
  triggers: [
    triggers.PWMTrigger('pwm_dimmer', 10);
  ],
  execute: (event) => {
    items.getItem('pwm_switch').sendCommand(event.receivedCommand);
  }
});

Parameters:

(static) SystemStartlevelTrigger(startlevel, triggerNameopt)

Description:

• Creates a trigger that fires if a given start level is reached by the system

Source:

• triggers.js, line 224

Example

SystemStartlevelTrigger(40)  // Rules loaded
SystemStartlevelTrigger(50)  // Rule engine started
SystemStartlevelTrigger(70)  // User interfaces started
SystemStartlevelTrigger(80)  // Things initialized
SystemStartlevelTrigger(100) // Startup Complete

Parameters:

(static) ThingStatusChangeTrigger(thingUID, statusopt, previousStatusopt, triggerNameopt)

Description:

• Creates a trigger that fires upon a Thing status changing.

Source:

• triggers.js, line 203

Example

ThingStatusChangeTrigger('some:thing:uuid', 'ONLINE', 'OFFLINE');

Parameters:

(static) ThingStatusUpdateTrigger(thingUID, statusopt, triggerNameopt)

Description:

• Creates a trigger that fires upon a Thing status updating.

Source:

• triggers.js, line 185

Example

ThingStatusUpdateTrigger('some:thing:uuid', 'OFFLINE');

Parameters:

(static) TimeOfDayTrigger(time, triggerNameopt)

Description:

• Creates a trigger that fires daily at a specific time. The supplied time defines when the trigger will fire.

Source:

• triggers.js, line 254

Example

TimeOfDayTrigger('19:00');

Parameters: