ruby_home 0.2.1 → 0.2.6

data/examples/battery_service.rb

@@ -0,0 +1,58 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+battery_service = RubyHome::ServiceFactory.create(:battery_service,
+  status_low_battery: 0, # required
+  charging_state: 0, # required
+  battery_level: 20, # required
+  name: "battery service") # optional
+
+battery_service.status_low_battery.after_update do |status_low_battery|
+  if status_low_battery == 0
+    puts "battery service status low battery is battery level normal"
+  elsif status_low_battery == 1
+    puts "battery service status low battery is battery level low"
+  end
+end
+
+battery_service.charging_state.after_update do |charging_state|
+  if charging_state == 0
+    puts "battery service charging state is not charging"
+  elsif charging_state == 1
+    puts "battery service charging state is charging"
+  elsif charging_state == 2
+    puts "battery service charging state is not chargeable"
+  end
+end
+
+battery_service.battery_level.after_update do |battery_level|
+  puts "battery service battery level #{battery_level}"
+
+  if battery_level < 10 && battery_service.status_low_battery != 1
+    battery_service.status_low_battery = 1
+  end
+
+  if battery_level > 11 && battery_service.status_low_battery != 0
+    battery_service.status_low_battery = 0
+  end
+end
+
+Thread.new do
+  sleep 30
+
+  loop do
+    battery_service.charging_state = 0
+    while battery_service.battery_level > 0
+      battery_service.battery_level -= 1
+      sleep 1
+    end
+
+    battery_service.charging_state = 1
+    while battery_service.battery_level < 101
+      battery_service.battery_level += 1
+      sleep 1
+    end
+  end
+end
+
+RubyHome.run

data/examples/carbon_dioxide_sensor.rb

@@ -0,0 +1,78 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+carbon_dioxide_sensor = RubyHome::ServiceFactory.create(:carbon_dioxide_sensor,
+  carbon_dioxide_detected: 0, # required
+  name: "carbon dioxide sensor", # optional
+  carbon_dioxide_peak_level: 0, # optional
+  carbon_dioxide_level: 0, # optional
+  status_tampered: 0, # optional
+  status_low_battery: 0, # optional
+  status_fault: 0, # optional
+  status_active: true) # optional
+
+carbon_dioxide_sensor.carbon_dioxide_detected.after_update do |carbon_dioxide_detected|
+  if carbon_dioxide_detected == 0
+    puts "carbon dioxide sensor carbon dioxide detected CO2 levels normal"
+  elsif carbon_dioxide_detected == 1
+    puts "carbon dioxide sensor carbon dioxide detected CO2 levels abnormal"
+  end
+end
+
+carbon_dioxide_sensor.carbon_dioxide_peak_level.after_update do |carbon_dioxide_peak_level|
+  puts "carbon dioxide sensor carbon_dioxide_peak_level #{carbon_dioxide_peak_level}"
+end
+
+carbon_dioxide_sensor.carbon_dioxide_level.after_update do |carbon_dioxide_level|
+  puts "carbon dioxide sensor carbon_dioxide_level #{carbon_dioxide_level}"
+end
+
+carbon_dioxide_sensor.status_tampered.after_update do |status_tampered|
+  if status_tampered == 0
+    puts "carbon dioxide sensor status_tampered not tampered"
+  elsif status_tampered == 1
+    puts "carbon dioxide sensor status_tampered tampered"
+  end
+end
+
+carbon_dioxide_sensor.status_low_battery.after_update do |status_low_battery|
+  if status_low_battery == 0
+    puts "carbon dioxide sensor low battery is battery level normal"
+  elsif status_low_battery == 1
+    puts "carbon dioxide sensor low battery is battery level low"
+  end
+end
+
+carbon_dioxide_sensor.status_fault.after_update do |status_fault|
+  if status_fault == 0
+    puts "carbon dioxide sensor status_fault no fault"
+  elsif status_fault == 1
+    puts "carbon dioxide sensor status_fault general fault"
+  end
+end
+
+carbon_dioxide_sensor.status_active.after_update do |active|
+  if active
+    puts "carbon dioxide sensor is active"
+  else
+    puts "carbon dioxide sensor is inactive"
+  end
+end
+
+Thread.new do
+  sleep 30
+
+  loop do
+    carbon_dioxide_sensor.carbon_dioxide_detected = (0..1).to_a.sample
+    carbon_dioxide_sensor.carbon_dioxide_peak_level = (0..100000).to_a.sample
+    carbon_dioxide_sensor.carbon_dioxide_level = (0..100000).to_a.sample
+    carbon_dioxide_sensor.status_tampered = (0..1).to_a.sample
+    carbon_dioxide_sensor.status_low_battery = (0..1).to_a.sample
+    carbon_dioxide_sensor.status_fault = (0..1).to_a.sample
+    carbon_dioxide_sensor.status_active = [true, false].to_a.sample
+
+    sleep 10
+  end
+end
+
+RubyHome.run

data/examples/carbon_monoxide_sensor.rb

@@ -0,0 +1,78 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+carbon_monoxide_sensor = RubyHome::ServiceFactory.create(:carbon_monoxide_sensor,
+  carbon_monoxide_detected: 0, # required
+  name: "carbon monoxide sensor", # optional
+  carbon_monoxide_peak_level: 0, # optional
+  carbon_monoxide_level: 0, # optional
+  status_tampered: 0, # optional
+  status_low_battery: 0, # optional
+  status_fault: 0, # optional
+  status_active: true) # optional
+
+carbon_monoxide_sensor.carbon_monoxide_detected.after_update do |carbon_monoxide_detected|
+  if carbon_monoxide_detected == 0
+    puts "carbon monoxide sensor carbon monoxide detected CO2 levels normal"
+  elsif carbon_monoxide_detected == 1
+    puts "carbon monoxide sensor carbon monoxide detected CO2 levels abnormal"
+  end
+end
+
+carbon_monoxide_sensor.carbon_monoxide_peak_level.after_update do |carbon_monoxide_peak_level|
+  puts "carbon monoxide sensor carbon_monoxide_peak_level #{carbon_monoxide_peak_level}"
+end
+
+carbon_monoxide_sensor.carbon_monoxide_level.after_update do |carbon_monoxide_level|
+  puts "carbon monoxide sensor carbon_monoxide_level #{carbon_monoxide_level}"
+end
+
+carbon_monoxide_sensor.status_tampered.after_update do |status_tampered|
+  if status_tampered == 0
+    puts "carbon monoxide sensor status_tampered not tampered"
+  elsif status_tampered == 1
+    puts "carbon monoxide sensor status_tampered tampered"
+  end
+end
+
+carbon_monoxide_sensor.status_low_battery.after_update do |status_low_battery|
+  if status_low_battery == 0
+    puts "carbon monoxide sensor low battery is battery level normal"
+  elsif status_low_battery == 1
+    puts "carbon monoxide sensor low battery is battery level low"
+  end
+end
+
+carbon_monoxide_sensor.status_fault.after_update do |status_fault|
+  if status_fault == 0
+    puts "carbon monoxide sensor status_fault no fault"
+  elsif status_fault == 1
+    puts "carbon monoxide sensor status_fault general fault"
+  end
+end
+
+carbon_monoxide_sensor.status_active.after_update do |active|
+  if active
+    puts "carbon monoxide sensor is active"
+  else
+    puts "carbon monoxide sensor is inactive"
+  end
+end
+
+Thread.new do
+  sleep 30
+
+  loop do
+    carbon_monoxide_sensor.carbon_monoxide_detected = (0..1).to_a.sample
+    carbon_monoxide_sensor.carbon_monoxide_peak_level = (0..100).to_a.sample
+    carbon_monoxide_sensor.carbon_monoxide_level = (0..100).to_a.sample
+    carbon_monoxide_sensor.status_tampered = (0..1).to_a.sample
+    carbon_monoxide_sensor.status_low_battery = (0..1).to_a.sample
+    carbon_monoxide_sensor.status_fault = (0..1).to_a.sample
+    carbon_monoxide_sensor.status_active = [true, false].to_a.sample
+
+    sleep 10
+  end
+end
+
+RubyHome.run

data/examples/contact_sensor.rb

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

data/examples/door.rb

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

data/examples/fan.rb

@@ -0,0 +1,30 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+fan = RubyHome::ServiceFactory.create(:fan,
+  on: false, # required
+  name: "fan", # optional
+  rotation_speed: 50, # optional
+  rotation_direction: 0) # optional
+
+fan.on.after_update do |on|
+  if on
+    puts "fan is on"
+  else
+    puts "fan is off"
+  end
+end
+
+fan.rotation_speed.after_update do |rotation_speed|
+  puts "fan is spinning at #{rotation_speed} speed"
+end
+
+fan.rotation_direction.after_update do |rotation_direction|
+  if rotation_direction == 0
+    puts "fan rotating clockwise"
+  elsif rotation_direction == 1
+    puts "fan rotating counter clockwise"
+  end
+end
+
+RubyHome.run

data/examples/fan_v2.rb

@@ -0,0 +1,68 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+fan = RubyHome::ServiceFactory.create(:fan_v2,
+  active: 1, # required
+  name: "fan", # optional
+  swing_mode: 1, # optional
+  rotation_speed: 0, # optional
+  rotation_direction: 0, # optional
+  lock_physical_controls: 0, # optional
+  target_fan_state: 0, # optional
+  current_fan_state: 0) # optional
+
+fan.active.after_update do |active|
+  if active == 0
+    puts "fan is inactive"
+  elsif active == 1
+    puts "fan is active"
+  end
+end
+
+fan.swing_mode.after_update do |swing_mode|
+  if swing_mode == 0
+    puts "fan swing is disabled"
+  elsif swing_mode == 1
+    puts "fan swing is enabled"
+  end
+end
+
+fan.rotation_speed.after_update do |rotation_speed|
+  puts "fan is spinning at #{rotation_speed} speed"
+end
+
+fan.rotation_direction.after_update do |rotation_direction|
+  if rotation_direction == 0
+    puts "fan rotating clockwise"
+  elsif rotation_direction == 1
+    puts "fan rotating counter clockwise"
+  end
+end
+
+fan.lock_physical_controls.after_update do |lock_physical_controls|
+  if lock_physical_controls == 0
+    puts "fan control lock disabled"
+  elsif lock_physical_controls == 1
+    puts "fan control lock enabled"
+  end
+end
+
+fan.target_fan_state.after_update do |target_fan_state|
+  if target_fan_state == 0
+    puts "fan target fan state manual"
+  elsif target_fan_state == 1
+    puts "fan target fan state auto"
+  end
+end
+
+fan.current_fan_state.after_update do |current_fan_state|
+  if current_fan_state == 0
+    puts "fan current fan state inactive"
+  elsif current_fan_state == 1
+    puts "fan current fan state idle"
+  elsif current_fan_state == 2
+    puts "fan current fan state blowing air"
+  end
+end
+
+RubyHome.run

data/examples/garage_door_opener.rb

@@ -0,0 +1,71 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+garage_door_opener = RubyHome::ServiceFactory.create(:garage_door_opener,
+  obstruction_detected: false, # required
+  target_door_state: 1, # required
+  current_door_state: 1, # required
+  name: "garage door opener", # optional
+  lock_target_state: 1, # optional
+  lock_current_state: 1) # optional
+
+garage_door_opener.obstruction_detected.after_update do |obstruction_detected|
+  if obstruction_detected
+    puts "garage door opener obstruction detected"
+  else
+    puts "garage door opener no obstruction detected"
+  end
+end
+
+target_door_state_values = {
+  0 => "Open",
+  1 => "Closed"
+}
+garage_door_opener.target_door_state.after_update do |target_door_state|
+  state = target_door_state_values[target_door_state]
+  puts "garage door opener target door state is #{state}"
+
+  if target_door_state == 0
+    garage_door_opener.current_door_state = 2
+    sleep 1
+    garage_door_opener.current_door_state = 0
+  elsif target_door_state == 1
+    garage_door_opener.current_door_state = 3
+    sleep 1
+    garage_door_opener.current_door_state = 1
+  end
+end
+
+current_door_state_values = {
+  0 => "Open",
+  1 => "Closed",
+  2 => "Opening",
+  3 => "Closing",
+  4 => "Stopped"
+}
+garage_door_opener.current_door_state.after_update do |current_door_state|
+  state = current_door_state_values[current_door_state]
+  puts "garage door opener current door state door state is #{state}"
+end
+
+garage_door_opener.lock_target_state.after_update do |lock_target_state|
+  if lock_target_state == 0
+    puts "garage door opener lock target state is unsecured"
+  elsif lock_target_state == 1
+    puts "garage door opener lock target state is secured"
+  end
+end
+
+garage_door_opener.lock_current_state.after_update do |lock_current_state|
+  if lock_current_state == 0
+    puts "garage door opener lock current state is unsecured"
+  elsif lock_current_state == 1
+    puts "garage door opener lock current state is secured"
+  elsif lock_current_state == 2
+    puts "garage door opener lock current state is jammed"
+  elsif lock_current_state == 3
+    puts "garage door opener lock current state is unknown"
+  end
+end
+
+RubyHome.run