Class: OpenHAB::Core::Items::GenericItem

Overview

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

• #category ⇒ String

  The item's category.

• #formatted_state ⇒ String readonly

  Format the item's state according to its state description.

• #label ⇒ String

  The item's descriptive label.

• #name ⇒ String readonly

  The item's name.

• #raw_state ⇒ State readonly

  Get the raw item state.

• #state ⇒ State^? readonly

  OpenHAB item state if state is not UNDEF or NULL, nil otherwise.

• #tags ⇒ Array<String>

  The item's 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, #provider, #thing, #things

Instance Method Summary collapse

• #command(command) ⇒ self^? (also: #command!, #<<)

  Send a command to this item.

• #modify(force: false) { ... } ⇒ Object

  Defers notifying openHAB of modifications to multiple attributes until the block is complete.

• #null? ⇒ true, false

  Check if the item state == NULL.

• #refresh ⇒ Item

  Send the REFRESH command to the item.

• #state? ⇒ true, false

  Check if the item has a state (not UNDEF or NULL).

• #time_series=(time_series) ⇒ void

  Set a new time series.

• #undef? ⇒ true, false

  Check if the item state == UNDEF.

• #update(state) ⇒ self^? (also: #update!)

  Send an update to this item.

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 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, #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

308
309
310
311
312
313
314
315
316

# File 'lib/openhab/core/items/generic_item.rb', line 308

def category=(value)
  modify do
    value = value&.to_s
    next if category == value

    @modified = true
    set_category(value)
  end
end

logger.info(Exterior_WindDirection.formatted_state) # => "NE (36°)"

103
104
105

# File 'lib/openhab/core/items/generic_item.rb', line 103

def formatted_state
  GenericItem.item_states_event_builder.get_display_state(self)
end

# File 'lib/openhab/core/items/generic_item.rb', line 66

# File 'lib/openhab/core/items/generic_item.rb', line 62

81

# File 'lib/openhab/core/items/generic_item.rb', line 81

alias_method :raw_state, :state

115
116
117

# File 'lib/openhab/core/items/generic_item.rb', line 115

def state
  raw_state if state?
end

330
331
332
333
334
335
336
337
338
339

# File 'lib/openhab/core/items/generic_item.rb', line 330

def tags=(values)
  modify do
    values = DSL::Items::ItemBuilder.normalize_tags(*values)
    next if values.to_set == tags.to_set

    @modified = true
    remove_all_tags
    add_tags(values)
  end
end

MySwitch.command(ON) # The preferred method is `MySwitch.on`
Garage_Door.command(DOWN) # The preferred method is `Garage_Door.down`
SetTemperature.command 20 | "°C"

SetTemperature.command(22.5) # if it accepts a DecimalType

SetTemperature.command("22.5 °C") # The string will be parsed and converted to a QuantityType

159
160
161
162
163
164

# File 'lib/openhab/core/items/generic_item.rb', line 159

def command(command)
  command = format_command(command)
  logger.trace "Sending Command #{command} to #{name}"
  $events.send_command(self, command)
  Proxy.new(self)
end

MySwitch.modify do
  MySwitch.label = "New Label"
  MySwitch.tags = :labeled
end

269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291

# File 'lib/openhab/core/items/generic_item.rb', line 269

def modify(force: false)
  raise ArgumentError, "you must pass a block to modify" unless block_given?
  return yield if instance_variable_defined?(:@modifying) && @modifying

  begin
    provider = self.provider
    if provider && !provider.is_a?(org.openhab.core.common.registry.ManagedProvider)
      raise FrozenError, "Cannot modify item #{name} from provider #{provider.inspect}." unless force

      provider = nil
      logger.debug { "Forcing modifications to non-managed item #{name}" }
    end
    @modified = false
    @modifying = true

    r = yield

    provider&.update(self) if @modified
    r
  ensure
    @modifying = false
  end
end

# File 'lib/openhab/core/items/generic_item.rb', line 119

# File 'lib/openhab/core/items/generic_item.rb', line 174

88
89
90

# File 'lib/openhab/core/items/generic_item.rb', line 88

def state?
  !raw_state.is_a?(Types::UnDefType)
end

# File 'lib/openhab/core/items/generic_item.rb', line 240

# File 'lib/openhab/core/items/generic_item.rb', line 123

DoorStatus.update(OPEN)
InsideTemperature.update 20 | "°C"

DoorStatus.update(nil)
DoorStatus.update(NULL)

PeopleCount.update(5) # A plain NumberItem

InsideTemperature.update("22.5 °C") # The string will be parsed and converted to a QuantityType

202
203
204
205
206
207

# File 'lib/openhab/core/items/generic_item.rb', line 202

def update(state)
  state = format_update(state)
  logger.trace "Sending Update #{state} to #{name}"
  $events.post_update(self, state)
  Proxy.new(self)
end