Class: OpenHAB::Core::Items::RollershutterItem

Inherits:
GenericItem
  • Object
show all
Includes:
NumericItem
Defined in:
lib/openhab/core/items/rollershutter_item.rb

Overview

A RollershutterItem allows the control of roller shutters, i.e. moving them up, down, stopping or setting it to close to a certain percentage.

Examples:

Roll up all Rollershutters in a group

Shutters.up

Log a warning for all rollershutters that are not up

Shutters.reject(&:up?).each do |item|
  logger.warn("#{item.name} is not rolled up!")
end

Set rollershutter to a specified position

Example_Rollershutter << 40

Constant Summary

Constants included from Semantics

Semantics::Equipment, Semantics::Location, Semantics::Point, Semantics::Property, Semantics::Tag

Constants included from Persistence

Persistence::HistoricState

Instance Attribute Summary collapse

Attributes inherited from GenericItem

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

Attributes included from Semantics

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

Attributes included from Item

#accepted_command_types, #accepted_data_types, #all_groups, #channel, #channel_uid, #channel_uids, #channels, #groups, #links, #metadata, #name, #provider, #thing, #things

Instance Method Summary collapse

Methods inherited from GenericItem

#command, #modify, #null?, #refresh, #state?, #time_series=, #undef?, #update

Methods included from Semantics

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

Methods included from Item

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

Methods included from DSL::Items::TimedCommand

#command

Methods included from Persistence

#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, #sum_between, #sum_since, #sum_until, #updated_between?, #updated_since?, #updated_until?, #variance_between, #variance_since, #variance_until

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

#ensure

Instance Attribute Details

#state ⇒ PercentType, ... (readonly)

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
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
 
# File 'lib/openhab/core/items/rollershutter_item.rb', line 29

class RollershutterItem < GenericItem
  include NumericItem

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

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

  # @!method up
  #   Send the {UP} command to the item
  #   @return [RollershutterItem] `self`

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

  # @!method down
  #   Send the {DOWN} command to the item
  #   @return [RollershutterItem] `self`

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

  # @!method stop
  #   Send the {STOP} command to the item
  #   @return [RollershutterItem] `self`

  # @!method move
  #   Send the {MOVE} command to the item
  #   @return [RollershutterItem] `self`

  # raw numbers translate directly to PercentType, not a DecimalType
  # @!visibility private
  def format_type(command)
    return Types::PercentType.new(command) if command.is_a?(Numeric)

    super
  end
end

Instance Method Details

#down ⇒ RollershutterItem

Send the DOWN command to the item

Returns:




# File 'lib/openhab/core/items/rollershutter_item.rb', line 48

#down! ⇒ RollershutterItem

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

Returns:




# File 'lib/openhab/core/items/rollershutter_item.rb', line 52

#down? ⇒ true, false

Check if the item state == DOWN

Returns:

  • (true, false) 



# File 'lib/openhab/core/items/rollershutter_item.rb', line 36

#move ⇒ RollershutterItem

Send the MOVE command to the item

Returns:




# File 'lib/openhab/core/items/rollershutter_item.rb', line 60

#stop ⇒ RollershutterItem

Send the STOP command to the item

Returns:




# File 'lib/openhab/core/items/rollershutter_item.rb', line 56

#up ⇒ RollershutterItem

Send the UP command to the item

Returns:




# File 'lib/openhab/core/items/rollershutter_item.rb', line 40

#up! ⇒ RollershutterItem

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

Returns:




# File 'lib/openhab/core/items/rollershutter_item.rb', line 44

#up? ⇒ true, false

Check if the item state == UP

Returns:

  • (true, false) 



# File 'lib/openhab/core/items/rollershutter_item.rb', line 32