openHAB

Module: OpenHAB::DSL::Rules::Terse

Included in:
OpenHAB::DSL, Builder
Defined in:
lib/openhab/dsl/rules/terse.rb

Overview

If you have a single trigger and execution block, you can use a terse rule: All parameters to the trigger are passed through, and an optional name: parameter is added.

Examples:

changed TestSwitch do |event|
  logger.info("TestSwitch changed to #{event.state}")
end
received_command TestSwitch, name: "My Test Switch Rule", command: ON do
  logger.info("TestSwitch received command ON")
end

Instance Method Summary collapse

Instance Method Details

#changed(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a changed trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



50
 
# File 'lib/openhab/dsl/rules/terse.rb', line 50

def_terse_rule(:changed)

#channel(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a channel trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



51
 
# File 'lib/openhab/dsl/rules/terse.rb', line 51

def_terse_rule(:channel)

#channel_linked(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a channel_linked trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



52
 
# File 'lib/openhab/dsl/rules/terse.rb', line 52

def_terse_rule(:channel_linked)

#channel_unlinked(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a channel_unlinked trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



53
 
# File 'lib/openhab/dsl/rules/terse.rb', line 53

def_terse_rule(:channel_unlinked)

#cron(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a cron trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



54
 
# File 'lib/openhab/dsl/rules/terse.rb', line 54

def_terse_rule(:cron)

#every(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a every trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



55
 
# File 'lib/openhab/dsl/rules/terse.rb', line 55

def_terse_rule(:every)

#item_added(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a item_added trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



56
 
# File 'lib/openhab/dsl/rules/terse.rb', line 56

def_terse_rule(:item_added)

#item_removed(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a item_removed trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



58
 
# File 'lib/openhab/dsl/rules/terse.rb', line 58

def_terse_rule(:item_removed)

#item_updated(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a item_updated trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



57
 
# File 'lib/openhab/dsl/rules/terse.rb', line 57

def_terse_rule(:item_updated)

#on_start(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a on_start trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



59
 
# File 'lib/openhab/dsl/rules/terse.rb', line 59

def_terse_rule(:on_start)

#received_command(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a received_command trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



60
 
# File 'lib/openhab/dsl/rules/terse.rb', line 60

def_terse_rule(:received_command)

#thing_added(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a thing_added trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



61
 
# File 'lib/openhab/dsl/rules/terse.rb', line 61

def_terse_rule(:thing_added)

#thing_removed(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a thing_removed trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



63
 
# File 'lib/openhab/dsl/rules/terse.rb', line 63

def_terse_rule(:thing_removed)

#thing_updated(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a thing_updated trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



62
 
# File 'lib/openhab/dsl/rules/terse.rb', line 62

def_terse_rule(:thing_updated)

#updated(*args, name: nil, id: nil, on_load: false, **kwargs) { ... } ⇒ void

This method returns an undefined value.

Create a new rule with a updated trigger.

Parameters:

  • name (String) (defaults to: nil) —

    The name for the rule.

  • id (String) (defaults to: nil) —

    The ID for the rule.

  • on_load (true, false) (defaults to: false) —

    If the rule should also trigger immediately when the script loads.

Yields:

  • The execution block for the rule.

See Also:



64
 
# File 'lib/openhab/dsl/rules/terse.rb', line 64

def_terse_rule(:updated)