ruby_home 0.2.1 → 0.2.6

data/examples/heater_cooler.rb

@@ -0,0 +1,92 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+heater_cooler = RubyHome::ServiceFactory.create(:heater_cooler,
+  current_temperature: 20, # required
+  target_heater_cooler_state: 1, # required
+  current_heater_cooler_state: 2, # required
+  active: 1, # required
+  name: "heater cooler", # optional
+  rotation_speed: 0, # optional
+  temperature_display_units: 0, # optional
+  heating_threshold_temperature: 20, # optional
+  cooling_threshold_temperature: 10, # optional
+  swing_mode: 1, # optional
+  lock_physical_controls: 0) # optional
+
+heater_cooler.current_temperature.after_update do |current_temperature|
+  puts "heater cooler current temperature in celsius #{current_temperature}"
+end
+
+target_heater_cooler_state_values = {
+  0 => "Auto",
+  1 => "Heat",
+  2 => "Cool"
+}
+heater_cooler.target_heater_cooler_state.after_update do |target_heater_cooler_state|
+  state = target_heater_cooler_state_values[target_heater_cooler_state]
+  puts "heater cooler target heater cooler state is #{state}"
+end
+
+current_heater_cooler_state_values = {
+  0 => "Inactive",
+  1 => "Idle",
+  2 => "Heating",
+  3 => "Cooling"
+}
+heater_cooler.current_heater_cooler_state.after_update do |current_heater_cooler_state|
+  state = current_heater_cooler_state_values[current_heater_cooler_state]
+  puts "heater cooler target heater cooler state is #{state}"
+end
+
+heater_cooler.active.after_update do |active|
+  if active == 0
+    puts "heater cooler is inactive"
+  elsif active == 1
+    puts "heater cooler is active"
+  end
+end
+
+heater_cooler.rotation_speed.after_update do |rotation_speed|
+  puts "heater cooler is spinning at #{rotation_speed} speed"
+end
+
+heater_cooler.temperature_display_units.after_update do |temperature_display_unit|
+  if temperature_display_unit == 0
+    puts "heater cooler temperature display units Celsius"
+  elsif temperature_display_unit == 1
+    puts "heater cooler temperature display units Fahrenheit"
+  end
+end
+
+heater_cooler.heating_threshold_temperature.after_update do |heating_threshold_temperature|
+  # maximum_value: 25
+  # minimum_value: 0
+  # step_value: 0.1
+  puts "heater cooler heating threshold temperature #{heating_threshold_temperature}"
+end
+
+heater_cooler.cooling_threshold_temperature.after_update do |cooling_threshold_temperature|
+  # maximum_value: 35
+  # minimum_value: 10
+  # step_value: 0.1
+  puts "heater cooler cooling threshold temperature temperature #{cooling_threshold_temperature}"
+end
+
+heater_cooler.swing_mode.after_update do |swing_mode|
+  if swing_mode == 0
+    puts "heater cooler swimg is disabled"
+  elsif swing_mode == 1
+    puts "heater cooler swimg is enabled"
+  end
+end
+
+heater_cooler.lock_physical_controls.after_update do |lock_physical_controls|
+  if lock_physical_controls == 0
+    puts "heater cooler control lock disabled"
+  elsif lock_physical_controls == 1
+    puts "heater cooler control lock enabled"
+  end
+end
+
+RubyHome.run

data/examples/humidifier_dehumidifier.rb

@@ -0,0 +1,88 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+humidifier_dehumidifier = RubyHome::ServiceFactory.create(:humidifier_dehumidifier,
+  active: 1, # required
+  target_humidifier_dehumidifier_state: 0, # required
+  current_humidifier_dehumidifier_state: 1, # required
+  current_relative_humidity: 30, # required
+  name: "humidifier dehumidifier", # optional
+  rotation_speed: 0, # optional
+  relative_humidity_humidifier_threshold: 100, # optional
+  relative_humidity_dehumidifier_threshold: 0, # optional
+  water_level: 50, # optional
+  swing_mode: 1, # optional
+  lock_physical_controls: 0) # optional
+
+humidifier_dehumidifier.active.after_update do |active|
+  if active == 0
+    puts "humidifier dehumidifier is inactive"
+  elsif active == 1
+    puts "humidifier dehumidifier is active"
+  end
+end
+
+target_humidifier_dehumidifier_state_values = {
+  0 => "Humidifier or Dehumidifier",
+  1 => "Humidifier",
+  2 => "Dehumidifier"
+}
+humidifier_dehumidifier.target_humidifier_dehumidifier_state.after_update do |target_humidifier_dehumidifier_state|
+  state = target_humidifier_dehumidifier_state_values[target_humidifier_dehumidifier_state]
+  puts "humidifier dehumidifier target humidifier dehumidifier state is #{state}"
+end
+
+current_humidifier_dehumidifier_state_values = {
+  0 => "Inactive",
+  1 => "Idle",
+  2 => "Humidifying",
+  3 => "Dehumidifying"
+}
+humidifier_dehumidifier.current_humidifier_dehumidifier_state.after_update do |current_humidifier_dehumidifier_state|
+  state = current_humidifier_dehumidifier_state_values[current_humidifier_dehumidifier_state]
+  puts "humidifier dehumidifier target humidifier dehumidifier state is #{state}"
+end
+
+humidifier_dehumidifier.current_relative_humidity.after_update do |current_relative_humidity|
+  puts "humidifier dehumidifier current relative humidity at #{current_relative_humidity}"
+end
+
+humidifier_dehumidifier.rotation_speed.after_update do |rotation_speed|
+  puts "humidifier dehumidifier is spinning at #{rotation_speed} speed"
+end
+
+humidifier_dehumidifier.relative_humidity_humidifier_threshold.after_update do |relative_humidity_humidifier_threshold|
+  # maximum_value: 100
+  # minimum_value: 0
+  # step_value: 1
+  puts "humidifier dehumidifier relative humidity humidifier threshold temperature #{relative_humidity_humidifier_threshold}"
+end
+
+humidifier_dehumidifier.relative_humidity_dehumidifier_threshold.after_update do |relative_humidity_dehumidifier_threshold|
+  # maximum_value: 100
+  # minimum_value: 0
+  # step_value: 1
+  puts "humidifier dehumidifier relative humidity humidifier threshold temperature #{relative_humidity_dehumidifier_threshold}"
+end
+
+humidifier_dehumidifier.water_level.after_update do |water_level|
+  puts "humidifier dehumidifier water level #{water_level}"
+end
+
+humidifier_dehumidifier.swing_mode.after_update do |swing_mode|
+  if swing_mode == 0
+    puts "humidifier dehumidifier swimg is disabled"
+  elsif swing_mode == 1
+    puts "humidifier dehumidifier swimg is enabled"
+  end
+end
+
+humidifier_dehumidifier.lock_physical_controls.after_update do |lock_physical_controls|
+  if lock_physical_controls == 0
+    puts "humidifier dehumidifier control lock disabled"
+  elsif lock_physical_controls == 1
+    puts "humidifier dehumidifier control lock enabled"
+  end
+end
+
+RubyHome.run

data/examples/humidity_sensor.rb

@@ -0,0 +1,62 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+humidity_sensor = RubyHome::ServiceFactory.create(:humidity_sensor,
+  current_relative_humidity: 20, # required
+  name: "humidity sensor", # optional
+  status_low_battery: 0, # optional
+  status_tampered: 0, # optional
+  status_fault: 0, # optional
+  status_active: true) # optional
+
+humidity_sensor.current_relative_humidity.after_update do |current_relative_humidity|
+  puts "humidity sensor current relative humidity #{current_relative_humidity}"
+end
+
+humidity_sensor.status_low_battery.after_update do |status_low_battery|
+  if status_low_battery == 0
+    puts "humidity sensor low battery is battery level normal"
+  elsif status_low_battery == 1
+    puts "humidity sensor low battery is battery level low"
+  end
+end
+
+humidity_sensor.status_tampered.after_update do |status_tampered|
+  if status_tampered == 0
+    puts "humidity sensor status_tampered not tampered"
+  elsif status_tampered == 1
+    puts "humidity sensor status_tampered tampered"
+  end
+end
+
+humidity_sensor.status_fault.after_update do |status_fault|
+  if status_fault == 0
+    puts "humidity sensor status_fault no fault"
+  elsif status_fault == 1
+    puts "humidity sensor status_fault general fault"
+  end
+end
+
+humidity_sensor.status_active.after_update do |active|
+  if active
+    puts "humidity sensor is active"
+  else
+    puts "humidity sensor is inactive"
+  end
+end
+
+Thread.new do
+  sleep 30
+
+  loop do
+    humidity_sensor.current_relative_humidity = (0..100).to_a.sample
+    humidity_sensor.status_low_battery = (0..1).to_a.sample
+    humidity_sensor.status_tampered = (0..1).to_a.sample
+    humidity_sensor.status_fault = (0..1).to_a.sample
+    humidity_sensor.status_active = [true, false].to_a.sample
+
+    sleep 10
+  end
+end
+
+RubyHome.run

data/examples/leak_sensor.rb

@@ -0,0 +1,66 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+leak_sensor = RubyHome::ServiceFactory.create(:leak_sensor,
+  leak_detected: 0, # required
+  name: "leak sensor", # optional
+  status_low_battery: 0, # optional
+  status_tampered: 0, # optional
+  status_fault: 0, # optional
+  status_active: true) # optional
+
+leak_sensor.leak_detected.after_update do |leak_detected|
+  if leak_detected == 0
+    puts "leak sensor leak detected leak not detected"
+  elsif leak_detected == 1
+    puts "leak sensor leak detected leak detected"
+  end
+end
+
+leak_sensor.status_low_battery.after_update do |status_low_battery|
+  if status_low_battery == 0
+    puts "leak sensor low battery is battery level normal"
+  elsif status_low_battery == 1
+    puts "leak sensor low battery is battery level low"
+  end
+end
+
+leak_sensor.status_tampered.after_update do |status_tampered|
+  if status_tampered == 0
+    puts "leak sensor status_tampered not tampered"
+  elsif status_tampered == 1
+    puts "leak sensor status_tampered tampered"
+  end
+end
+
+leak_sensor.status_fault.after_update do |status_fault|
+  if status_fault == 0
+    puts "leak sensor status_fault no fault"
+  elsif status_fault == 1
+    puts "leak sensor status_fault general fault"
+  end
+end
+
+leak_sensor.status_active.after_update do |active|
+  if active
+    puts "leak sensor is active"
+  else
+    puts "leak sensor is inactive"
+  end
+end
+
+Thread.new do
+  sleep 30
+
+  loop do
+    leak_sensor.leak_detected = (0..1).to_a.sample
+    leak_sensor.status_low_battery = (0..1).to_a.sample
+    leak_sensor.status_tampered = (0..1).to_a.sample
+    leak_sensor.status_fault = (0..1).to_a.sample
+    leak_sensor.status_active = [true, false].to_a.sample
+
+    sleep 10
+  end
+end
+
+RubyHome.run

data/examples/light_sensor.rb

@@ -0,0 +1,64 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+light_sensor = RubyHome::ServiceFactory.create(:light_sensor,
+  current_ambient_light_level: 50000, # required
+  name: "light sensor", # optional
+  status_low_battery: 0, # optional
+  status_tampered: 0, # optional
+  status_fault: 0, # optional
+  status_active: true) # optional
+
+light_sensor.current_ambient_light_level.after_update do |current_ambient_light_level|
+  # maximum_value: 100000
+  # minimum_value: 0.0001
+  puts "light sensor current ambient light level #{current_ambient_light_level}"
+end
+
+light_sensor.status_low_battery.after_update do |status_low_battery|
+  if status_low_battery == 0
+    puts "light sensor low battery is battery level normal"
+  elsif status_low_battery == 1
+    puts "light sensor low battery is battery level low"
+  end
+end
+
+light_sensor.status_tampered.after_update do |status_tampered|
+  if status_tampered == 0
+    puts "light sensor status_tampered not tampered"
+  elsif status_tampered == 1
+    puts "light sensor status_tampered tampered"
+  end
+end
+
+light_sensor.status_fault.after_update do |status_fault|
+  if status_fault == 0
+    puts "light sensor status_fault no fault"
+  elsif status_fault == 1
+    puts "light sensor status_fault general fault"
+  end
+end
+
+light_sensor.status_active.after_update do |active|
+  if active
+    puts "light sensor is active"
+  else
+    puts "light sensor is inactive"
+  end
+end
+
+Thread.new do
+  sleep 30
+
+  loop do
+    light_sensor.current_ambient_light_level = (1..100000).to_a.sample
+    light_sensor.status_low_battery = (0..1).to_a.sample
+    light_sensor.status_tampered = (0..1).to_a.sample
+    light_sensor.status_fault = (0..1).to_a.sample
+    light_sensor.status_active = [true, false].to_a.sample
+
+    sleep 10
+  end
+end
+
+RubyHome.run

data/examples/lightbulb.rb

@@ -0,0 +1,31 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+lightbulb = RubyHome::ServiceFactory.create(:lightbulb,
+  on: true, # required
+  name: "lightbulb", # optional
+  brightness: 100, # optional
+  saturation: 100, # optional
+  hue: 360) # optional
+
+lightbulb.on.after_update do |on|
+  if on
+    puts "lightbulb is on"
+  else
+    puts "lightbulb is off"
+  end
+end
+
+lightbulb.brightness.after_update do |brightness|
+  puts "lightbulb is at #{brightness} brightness"
+end
+
+lightbulb.saturation.after_update do |saturation|
+  puts "lightbulb is at #{saturation} saturation"
+end
+
+lightbulb.hue.after_update do |hue|
+  puts "lightbulb is at #{hue} hue"
+end
+
+RubyHome.run

data/examples/lock_mechanism.rb

@@ -0,0 +1,34 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+lock_mechanism = RubyHome::ServiceFactory.create(:lock_mechanism,
+  lock_target_state: 1, # required
+  lock_current_state: 1, # required
+  name: "lock") # optional
+
+lock_mechanism.lock_target_state.after_update do |lock_target_state|
+  if lock_target_state == 0
+    puts "lock target state is unsecured"
+
+    sleep 1
+    lock_mechanism.lock_current_state = 0
+  elsif lock_target_state == 1
+    puts "lock target state is secured"
+
+    sleep 1
+    lock_mechanism.lock_current_state = 1
+  end
+end
+
+lock_current_state_values = {
+  0 => "Unsecured",
+  1 => "Secured",
+  2 => "Jammed",
+  3 => "Unknown"
+}
+lock_mechanism.lock_current_state.after_update do |lock_current_state|
+  state = lock_current_state_values[lock_current_state]
+  puts "lock current state #{state}"
+end
+
+RubyHome.run

data/examples/motion_sensor.rb

@@ -0,0 +1,66 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+motion_sensor = RubyHome::ServiceFactory.create(:motion_sensor,
+  motion_detected: false, # required
+  name: "motion sensor", # optional
+  status_low_battery: 0, # optional
+  status_tampered: 0, # optional
+  status_fault: 0, # optional
+  status_active: true) # optional
+
+motion_sensor.motion_detected.after_update do |motion_detected|
+  if motion_detected
+    puts "motion sensor detected motion"
+  else
+    puts "motion sensor no motion detected"
+  end
+end
+
+motion_sensor.status_low_battery.after_update do |status_low_battery|
+  if status_low_battery == 0
+    puts "motion sensor battery level normal"
+  elsif status_low_battery == 1
+    puts "motion sensor battery level lormal"
+  end
+end
+
+motion_sensor.status_tampered.after_update do |status_tampered|
+  if status_tampered == 0
+    puts "motion sensor status_tampered not tampered"
+  elsif status_tampered == 1
+    puts "motion sensor status_tampered tampered"
+  end
+end
+
+motion_sensor.status_fault.after_update do |status_fault|
+  if status_fault == 0
+    puts "motion sensor status_fault no fault"
+  elsif status_fault == 1
+    puts "motion sensor status_fault general fault"
+  end
+end
+
+motion_sensor.status_active.after_update do |active|
+  if active
+    puts "motion sensor is active"
+  else
+    puts "motion sensor is inactive"
+  end
+end
+
+Thread.new do
+  sleep 30
+
+  loop do
+    motion_sensor.motion_detected = [true, false].to_a.sample
+    motion_sensor.status_low_battery = (0..1).to_a.sample
+    motion_sensor.status_tampered = (0..1).to_a.sample
+    motion_sensor.status_fault = (0..1).to_a.sample
+    motion_sensor.status_active = [true, false].to_a.sample
+
+    sleep 10
+  end
+end
+
+RubyHome.run