Class: OpenHAB::Core::Items::ColorItem
- Inherits:
-
DimmerItem
- Object
- GenericItem
- SwitchItem
- DimmerItem
- OpenHAB::Core::Items::ColorItem
- Defined in:
- lib/openhab/core/items/color_item.rb
Overview
ColorItem represents a color values, e.g. for LED lights.
Note that it inherits from DimmerItem, so you can call SwitchItem#on, SwitchItem#off, SwitchItem#on?, SwitchItem#off?, etc. on it. Its state type is an HSBType, which is stored as Hue, Saturation, and Brightness, but has easy helpers for working with RGB values of various forms.
Constant Summary
Constants included from Semantics
Semantics::Equipment, Semantics::Location, Semantics::Point, Semantics::Property, Semantics::Tag
Constants included from Persistence
Instance Attribute Summary collapse
- #state ⇒ HSBType? readonly
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 DimmerItem
#brighten, #decrease, #dim, #increase
Methods inherited from SwitchItem
#off, #off!, #off?, #on, #on!, #on?, #toggle
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
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
Instance Attribute Details
#state ⇒ HSBType? (readonly)
38 39 40 41 42 43 44 45 46 47 |
# File 'lib/openhab/core/items/color_item.rb', line 38 class ColorItem < DimmerItem # Make sure to do the String => HSBType conversion in Ruby, # where we add support for hex # @!visibility private def format_type(type) return Types::HSBType.new(type) if type.respond_to?(:to_str) super end end |