Class: OpenHAB::Core::Items::SwitchItem

Overview

Switches.on

Switches.select(&:off?).each(&:on)

# Turn on switch
SwitchItem << true

# Turn off switch
SwitchItem << false

# Turn off switch if any in another group is on
SwitchItem << Switches.any?(&:on?)

items.grep(SwitchItem)
     .each(&:toggle)

Constant Summary

Constants included from Semantics

OpenHAB::Core::Items::Semantics::Equipment, OpenHAB::Core::Items::Semantics::Location, OpenHAB::Core::Items::Semantics::Point, OpenHAB::Core::Items::Semantics::Property, OpenHAB::Core::Items::Semantics::Tag

Constants included from Persistence

Persistence::HistoricState

Instance Attribute Summary collapse

• #state ⇒ OnOffType^? readonly
• #was ⇒ OnOffType^? readonly

Attributes inherited from GenericItem

#category, #label, #name, #raw_state, #tags

Attributes included from Item

#accepted_command_types, #accepted_data_types, #all_groups, #channel, #channel_uid, #channel_uids, #channels, #command_description, #formatted_state, #groups, #last_state, #last_state_change, #last_state_update, #links, #metadata, #name, #provider, #state_description, #thing, #things

Attributes included from Semantics

#equipment, #equipment_type, #location, #location_type, #point_type, #property_type, #semantic_type

Instance Method Summary collapse

• #off ⇒ SwitchItem

  Send the OFF command to the item.

• #off! ⇒ SwitchItem

  Send the OFF command to the item, even when ensure_states! is in effect.

• #off? ⇒ true, false

  Check if the item state == OFF.

• #on ⇒ SwitchItem

  Send the ON command to the item.

• #on! ⇒ SwitchItem

  Send the ON command to the item, even when ensure_states! is in effect.

• #on? ⇒ true, false

  Check if the item state == ON.

• #toggle(source: nil) ⇒ self

  Send a command to invert the state of the switch.

• #was_off? ⇒ true, false

  Check if #was is (implicitly convertible to) OFF.

• #was_on? ⇒ true, false

  Check if #was is (implicitly convertible to) ON.

Methods inherited from GenericItem

#modify, #null?, #state?, #time_series=, #undef?, #was?, #was_null?, #was_undef?

Methods included from Item

#call_item?, #color_item?, #command, #contact_item?, #date_time_item?, #dimmer_item?, #group_item?, #image_item?, #inspect, #link, #location_item?, #member_of?, #number_item?, #player_item?, #refresh, #rollershutter_item?, #string_item?, #switch_item?, #tagged?, #to_s, #unlink, #update

Methods included from Semantics

add, #equipment?, #location?, lookup, #point?, #points, remove, #semantic?, tags

Methods included from DSL::Items::Ensure::Ensurable

#ensure

Methods included from Persistence

#all_states_between, #all_states_since, #all_states_until, #average_between, #average_since, #average_until, #changed_between?, #changed_since?, #changed_until?, #count_between, #count_since, #count_state_changes_between, #count_state_changes_since, #count_state_changes_until, #count_until, #delta_between, #delta_since, #delta_until, #deviation_between, #deviation_since, #deviation_until, #evolution_rate, #evolution_rate_between, #evolution_rate_since, #evolution_rate_until, #historic_state, #last_change, #last_update, #maximum_between, #maximum_since, #maximum_until, #median_between, #median_since, #median_until, #minimum_between, #minimum_since, #minimum_until, #next_change, #next_state, #next_update, #persist, #persisted_state, #previous_state, #remove_all_states_between, #remove_all_states_since, #remove_all_states_until, #riemann_sum_between, #riemann_sum_since, #riemann_sum_until, #sum_between, #sum_since, #sum_until, #updated_between?, #updated_since?, #updated_until?, #variance_between, #variance_since, #variance_until

Methods included from DSL::Items::TimedCommand

#command

41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

# File 'lib/openhab/core/items/switch_item.rb', line 41

class SwitchItem < GenericItem
  # Convert boolean commands to ON/OFF
  # @!visibility private
  def format_type(command)
    return Types::OnOffType.from(command) if [true, false].include?(command)

    super
  end

  #
  # Send a command to invert the state of the switch
  #
  # @return [self]
  #
  def toggle(source: nil)
    command!(!on?, source:)
  end

  # @!method on?
  #   Check if the item state == {ON}
  #   @return [true,false]

  # @!method off?
  #   Check if the item state == {OFF}
  #   @return [true,false]

  # @!method on
  #   Send the {ON} command to the item
  #   @return [SwitchItem] `self`

  # @!method on!
  #   Send the {ON} command to the item, even when {OpenHAB::DSL.ensure_states! ensure_states!} is in effect.
  #   @return [SwitchItem] `self`

  # @!method off
  #   Send the {OFF} command to the item
  #   @return [SwitchItem] `self`

  # @!method off!
  #   Send the {OFF} command to the item, even when {OpenHAB::DSL.ensure_states! ensure_states!} is in effect.
  #   @return [SwitchItem] `self`

  # @!method was_on?
  #   Check if {#was} is (implicitly convertible to) {ON}
  #   @return [true, false]

  # @!method was_off?
  #   Check if {#was} is (implicitly convertible to) {OFF}
  #   @return [true, false]
end

41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

# File 'lib/openhab/core/items/switch_item.rb', line 41

class SwitchItem < GenericItem
  # Convert boolean commands to ON/OFF
  # @!visibility private
  def format_type(command)
    return Types::OnOffType.from(command) if [true, false].include?(command)

    super
  end

  #
  # Send a command to invert the state of the switch
  #
  # @return [self]
  #
  def toggle(source: nil)
    command!(!on?, source:)
  end

  # @!method on?
  #   Check if the item state == {ON}
  #   @return [true,false]

  # @!method off?
  #   Check if the item state == {OFF}
  #   @return [true,false]

  # @!method on
  #   Send the {ON} command to the item
  #   @return [SwitchItem] `self`

  # @!method on!
  #   Send the {ON} command to the item, even when {OpenHAB::DSL.ensure_states! ensure_states!} is in effect.
  #   @return [SwitchItem] `self`

  # @!method off
  #   Send the {OFF} command to the item
  #   @return [SwitchItem] `self`

  # @!method off!
  #   Send the {OFF} command to the item, even when {OpenHAB::DSL.ensure_states! ensure_states!} is in effect.
  #   @return [SwitchItem] `self`

  # @!method was_on?
  #   Check if {#was} is (implicitly convertible to) {ON}
  #   @return [true, false]

  # @!method was_off?
  #   Check if {#was} is (implicitly convertible to) {OFF}
  #   @return [true, false]
end

# File 'lib/openhab/core/items/switch_item.rb', line 75

# File 'lib/openhab/core/items/switch_item.rb', line 79

# File 'lib/openhab/core/items/switch_item.rb', line 63

# File 'lib/openhab/core/items/switch_item.rb', line 67

# File 'lib/openhab/core/items/switch_item.rb', line 71

# File 'lib/openhab/core/items/switch_item.rb', line 59

55
56
57

# File 'lib/openhab/core/items/switch_item.rb', line 55

def toggle(source: nil)
  command!(!on?, source:)
end

# File 'lib/openhab/core/items/switch_item.rb', line 87

# File 'lib/openhab/core/items/switch_item.rb', line 83