ruby_home 0.2.1 → 0.2.2

data/examples/outlet.rb

@@ -0,0 +1,30 @@
+require 'ruby_home'
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+outlet = RubyHome::ServiceFactory.create(:outlet,
+  outlet_in_use: false, # required
+  on: false, # required
+  name: "occupancy sensor", # optional
+)
+
+outlet.outlet_in_use.after_update do |outlet_in_use|
+  if outlet_in_use
+    puts "outlet in use"
+  else
+    puts "outlet not in use"
+  end
+end
+
+outlet.on.after_update do |on|
+  if on
+    puts "outlet is on"
+    sleep 1
+    outlet.outlet_in_use = true
+  else
+    puts "outlet is off"
+    sleep 1
+    outlet.outlet_in_use = false
+  end
+end
+
+RubyHome.run

data/examples/security_system.rb

@@ -0,0 +1,54 @@
+require 'ruby_home'
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+security_system = RubyHome::ServiceFactory.create(:security_system,
+  security_system_target_state: 0, # required
+  security_system_current_state: 0, # required
+  name: 'security system', # optional
+  security_system_alarm_type: 0, # optional
+  status_tampered: 0, # optional
+  status_fault: 0 # optional
+)
+
+security_system_target_state_values = {
+  0 => 'Stay Arm',
+  1 => 'Away Arm',
+  2 => 'Night Arm',
+  3 => 'Disarm'
+}
+security_system.security_system_target_state.after_update do |security_system_target_state|
+  state = security_system_target_state_values[security_system_target_state]
+  puts "security system security_system_target_state #{state}"
+  sleep 1
+  security_system.security_system_current_state = security_system_target_state
+end
+
+security_system_current_state_values = {
+  0 => 'Stay Arm',
+  1 => 'Away Arm',
+  2 => 'Night Arm',
+  3 => 'Disarmed',
+  4 => 'Alarm Triggered'
+}
+security_system.security_system_current_state.after_update do |security_system_current_state|
+  state = security_system_current_state_values[security_system_current_state]
+  puts "security system security_system_current_state state #{state}"
+end
+
+security_system.status_tampered.after_update do |status_tampered|
+  if status_tampered == 0
+    puts "security system status_tampered not tampered"
+  elsif status_tampered == 1
+    puts "security system status_tampered tampered"
+  end
+end
+
+security_system.status_fault.after_update do |status_fault|
+  if status_fault == 0
+    puts "security system status_fault no fault"
+  elsif status_fault == 1
+    puts "security system status_fault general fault"
+  end
+end
+
+RubyHome.run

data/examples/smoke_sensor.rb

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

data/examples/switch.rb

@@ -0,0 +1,17 @@
+require 'ruby_home'
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+switch = RubyHome::ServiceFactory.create(:switch,
+  on: false, # required
+  name: 'switch', # optional
+)
+
+switch.on.after_update do |on|
+  if on
+    puts "switch is on"
+  else
+    puts "switch is off"
+  end
+end
+
+RubyHome.run

data/examples/temperature_sensor.rb

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

data/examples/thermostat.rb

@@ -0,0 +1,114 @@
+require 'ruby_home'
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+thermostat = RubyHome::ServiceFactory.create(:thermostat,
+  temperature_display_units: 0, # required
+  target_temperature: 18, # required
+  current_temperature: 18, # required
+  target_heating_cooling_state: 0, # required
+  current_heating_cooling_state: 0, # required
+  name: "thermostat", # optional
+  heating_threshold_temperature: 20, # optional
+  cooling_threshold_temperature: 10, # optional
+  target_relative_humidity: 0, # optional
+  current_relative_humidity: 0, # optional
+)
+
+thermostat.temperature_display_units.after_update do |temperature_display_unit|
+  if temperature_display_unit == 0
+    puts "thermostat temperature display units Celsius"
+  elsif temperature_display_unit == 1
+    puts "thermostat temperature display units Fahrenheit"
+  end
+end
+
+thermostat.target_temperature.after_update do |target_temperature|
+  puts "thermostat target_temperature #{target_temperature}"
+
+  if target_temperature.to_i > thermostat.current_temperature.to_i
+    thermostat.target_heating_cooling_state = 1
+  elsif target_temperature < thermostat.current_temperature
+    thermostat.target_heating_cooling_state = 2
+  elsif target_temperature.to_i == thermostat.current_temperature.to_i
+    thermostat.target_heating_cooling_state = 0
+  end
+end
+
+thermostat.current_temperature.after_update do |current_temperature|
+  puts "thermostat current_temperature #{current_temperature}"
+
+  if current_temperature.to_i < thermostat.target_temperature.to_i
+    thermostat.target_heating_cooling_state = 1
+  elsif current_temperature.to_i > thermostat.target_temperature.to_i
+    thermostat.target_heating_cooling_state = 2
+  elsif current_temperature.to_i == thermostat.target_temperature.to_i
+    thermostat.target_heating_cooling_state = 0
+  end
+end
+
+target_heating_cooling_state_values = {
+  0 => 'Off',
+  1 => 'Heat',
+  2 => 'Cool',
+  3 => 'Auto',
+}
+thermostat.target_heating_cooling_state.after_update do |target_heating_cooling_state|
+  state = target_heating_cooling_state_values[target_heating_cooling_state]
+  puts "heater cooler target heating cooler state is #{state}"
+
+  return if thermostat.current_heating_cooling_state == target_heating_cooling_state
+
+  if target_heating_cooling_state == 1
+    thermostat.current_heating_cooling_state = 1
+  elsif target_heating_cooling_state == 2
+    thermostat.current_heating_cooling_state = 2
+  elsif target_heating_cooling_state == 0
+    thermostat.current_heating_cooling_state = 0
+  end
+end
+
+current_heating_cooling_state_values = {
+  0 => 'Off',
+  1 => 'Heat',
+  2 => 'Cool',
+}
+thermostat.current_heating_cooling_state.after_update do |current_heating_cooling_state|
+  state = current_heating_cooling_state_values[current_heating_cooling_state]
+  puts "heater cooler current heating cooler state is #{state}"
+end
+
+thermostat.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
+
+thermostat.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
+
+thermostat.target_relative_humidity.after_update do |target_relative_humidity|
+  puts "thermostat target_relative_humidity #{target_relative_humidity}"
+end
+
+thermostat.current_relative_humidity.after_update do |current_relative_humidity|
+  puts "thermostat current_relative_humidity #{current_relative_humidity}"
+end
+
+Thread.new do
+  loop do
+    sleep 5
+
+    if thermostat.target_temperature.to_i > thermostat.current_temperature.to_i
+      thermostat.current_temperature += 1
+    elsif thermostat.target_temperature.to_i < thermostat.current_temperature.to_i
+      thermostat.current_temperature -= 1
+    end
+  end
+end
+
+RubyHome.run

data/examples/window.rb

@@ -0,0 +1,49 @@
+require 'ruby_home'
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+window = RubyHome::ServiceFactory.create(:window,
+  target_position: 0, # required
+  position_state: 1, # required
+  current_position: 0, # required
+  name: "window", # optional
+  obstruction_detected: false, # optional
+)
+
+window.target_position.after_update do |target_position|
+  puts "window target position #{target_position}"
+
+  if target_position < window.current_position
+    window.position_state = 0
+  elsif target_position > window.current_position
+    window.position_state = 1
+  end
+
+  sleep 1
+
+  window.current_position = target_position
+  window.position_state = 2
+end
+
+position_state_values = {
+  0 => 'Decreasing',
+  1 => 'Increasing',
+  2 => 'Stopped'
+}
+window.position_state.after_update do |position_state|
+  state = position_state_values[position_state]
+  puts "window position state #{state}"
+end
+
+window.current_position.after_update do |current_position|
+  puts "window current position #{current_position}"
+end
+
+window.obstruction_detected.after_update do |obstruction_detected|
+  if obstruction_detected
+    puts "window obstruction detected"
+  else
+    puts "window no obstruction detected"
+  end
+end
+
+RubyHome.run

data/examples/window_covering.rb

@@ -0,0 +1,73 @@
+require 'ruby_home'
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+window_covering = RubyHome::ServiceFactory.create(:window_covering,
+  target_position: 0, # required
+  position_state: 1, # required
+  current_position: 0, # required
+  name: "window_covering", # optional
+  obstruction_detected: false, # optional
+  current_vertical_tilt_angle: 0, # optional
+  target_vertical_tilt_angle: 0, # optional
+  current_horizontal_tilt_angle: 0, # optional
+  target_horizontal_tilt_angle: 0 # optional
+)
+
+window_covering.target_position.after_update do |target_position|
+  puts "window covering target position #{target_position}"
+
+  if target_position < window_covering.current_position
+    window_covering.position_state = 0
+  elsif target_position > window_covering.current_position
+    window_covering.position_state = 1
+  end
+
+  sleep 1
+
+  window_covering.current_position = target_position
+  window_covering.position_state = 2
+end
+
+position_state_values = {
+  0 => 'Decreasing',
+  1 => 'Increasing',
+  2 => 'Stopped'
+}
+window_covering.position_state.after_update do |position_state|
+  state = position_state_values[position_state]
+  puts "window covering position state #{state}"
+end
+
+window_covering.current_position.after_update do |current_position|
+  puts "window covering current position #{current_position}"
+end
+
+window_covering.obstruction_detected.after_update do |obstruction_detected|
+  if obstruction_detected
+    puts "window covering obstruction detected"
+  else
+    puts "window covering no obstruction detected"
+  end
+end
+
+window_covering.current_vertical_tilt_angle.after_update do |current_vertical_tilt_angle|
+  puts "window covering current_vertical_tilt_angle #{current_vertical_tilt_angle}"
+end
+
+window_covering.target_vertical_tilt_angle.after_update do |target_vertical_tilt_angle|
+  puts "window covering target_vertical_tilt_angle #{target_vertical_tilt_angle}"
+  sleep 1
+  window_covering.current_vertical_tilt_angle = target_vertical_tilt_angle
+end
+
+window_covering.current_horizontal_tilt_angle.after_update do |current_horizontal_tilt_angle|
+  puts "window covering current_horizontal_tilt_angle #{current_horizontal_tilt_angle}"
+end
+
+window_covering.target_horizontal_tilt_angle.after_update do |target_horizontal_tilt_angle|
+  puts "window covering target_horizontal_tilt_angle #{target_horizontal_tilt_angle}"
+  sleep 1
+  window_covering.current_horizontal_tilt_angle = target_horizontal_tilt_angle
+end
+
+RubyHome.run