Run

The run property is the automation code that is executed when a rule is triggered. This property accepts a block of code and executes it. The block is automatically passed an event object which can be used to access multiple properties about the triggering event. The code for the automation can be entirely within the run block can call methods defined in the ruby script.

Update/Change Event Properties

The following properties exist when a run block is triggered from an updated or changed trigger.

• was* properties are only available for changed trigger.
• For compatibility, last is also aliased to was.

Command Event Properties

The following properties exist when a run block is triggered from a received_command trigger.

Thing Event Properties

The following properties exist when a run block is triggered from an updated or changed trigger on a Thing.

{} Style used for single line blocks

rule 'Access Event Properties' do
  changed TestSwitch
  run { |event| logger.info("#{event.item.id} triggered from #{event.was} to #{event.state}") }
end

do/end style used for multi-line blocks

rule 'Multi Line Run Block' do
  changed TestSwitch
  run do |event|
    logger.info("#{event.item.id} triggered")
    logger.info("from #{event.was}") if event.was
    logger.info("to #{event.state}") if event.state
   end
end

Rules can have multiple run blocks and they are executed in order, Useful when used in combination with delay

rule 'Multiple Run Blocks' do
  changed TestSwitch
  run { |event| logger.info("#{event.item.id} triggered") }
  run { |event| logger.info("from #{event.was}") if event.was }
  run { |event| logger.info("to #{event.state}") if event.state  }
end

Channel Event Properties

The following property exists when a run block is triggered from a channel trigger on a Thing. It can be used to get to the Thing.

rule "Keypad Code Received test" do
  channel "mqtt:homie300:mosquitto:backgate:keypad#code"

  run do |event|
    logger.info("Received keycode from #{event.channel.thing.uid.id}")
  end
end