Class: OpenHAB::Core::Items::LocationItem

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

Overview

A LocationItem can be used to store GPS related information, addresses etc.

This is useful for location awareness related functions

Examples:

Send point commands

Location << '30,20'   # latitude of 30, longitude of 20
Location << '30,20,80' # latitude of 30, longitude of 20, altitude of 80
Location << PointType.new('40,20')

Determine the distance between two locations

logger.info "Distance from Location 1 to Location 2: #{Location1.state - Location2.state}"
logger.info "Distance from Location 1 to Location 2: #{Location1.state - PointType.new('40,20')}"

Constant Summary

Constants included from Semantics

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

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

Method Summary

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

#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, #changed_between?, #changed_since?, #count_between, #count_since, #count_state_changes_between, #count_state_changes_since, #delta_between, #delta_since, #deviation_between, #deviation_since, #evolution_rate, #historic_state, #last_update, #maximum_between, #maximum_since, #minimum_between, #minimum_since, #persist, #previous_state, #sum_between, #sum_since, #updated_between?, #updated_since?, #variance_between, #variance_since

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

#ensure

Instance Attribute Details

#state ⇒ PointType? (readonly)

Returns:



28
29
 
# File 'lib/openhab/core/items/location_item.rb', line 28

class LocationItem < GenericItem
end