ruby_home 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cace8911ec7e8999b154e2bbcf7794ff7e9ca890b1b53fb8167091c316565bc6
-  data.tar.gz: 9f623241d8dd6bbca8e504919af18bd2084a722f5c9ee33a701714cbd82f73c1
+  metadata.gz: 01126dd521e4351b6b7b801bfbb2e4bfd9ab6e19d47ce1715dc9c964ea5dfeca
+  data.tar.gz: be5d09f37ec55495c374778c4e2c0baea87edd16ea791ff2f9ca65a90a0666ad
 SHA512:
-  metadata.gz: a4787d16e0be2c98a35d8428ef90ef83cd8462f2fa9189f6243367ef8eca006812a86c26d4c29afa5c3d09827401fb61909f5320b7e1d5ac2d4c5ab0d3e95f78
-  data.tar.gz: 138ef40f9cf8e9c0fa8820c2611d1bf70dd4398578e40139165359d93558fe7df8205676fa660426debc49c9852d7f42d770f9a4b99cb9bf4d224bec21821384
+  metadata.gz: 96fb624e38e24b0b6fc709f6df2f7dd048b2514210f1cd4b43e91a36c2de1bc0f8de22848bb106b44ab7e17f3efbfcab7a3ad839275a819391c745e890e299ea
+  data.tar.gz: bbbc772b8da1669307f63753f23ad07f1ada6e9f675e0a02e174f9653a94f67245cd13564c9d7e57f163fa2ebc1cb4526071df2ef5dc7763466146f446bfb852

data/.github/workflows/tests.yml

@@ -0,0 +1,41 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  ubuntu:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [3.0, 2.7, 2.6]
+    steps:
+    - name: Install libdnssd
+      run: sudo apt-get install libavahi-compat-libdnssd-dev
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Install dependencies
+      run: bundle
+    - name: Run tests
+      run: bundle exec rake
+  mac:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        ruby-version: [3.0, 2.7, 2.6]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Install dependencies
+      run: bundle
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -1,14 +1,14 @@
 .byebug_history
 .rspec_status
+.ruby-version
 /.bundle/
+/.rubocop-*
 /.yardoc
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
 Gemfile.lock
 accessory_info.yml
 identifier_cache.yml
-.ruby-version

data/.rubocop.yml

@@ -1,9 +1,2 @@
-Style:
-  TrailingCommaInLiteral:
-    Enabled: false
-  Documentation:
-    Enabled: false
-  FrozenStringLiteralComment:
-    Enabled: false
-  IndentationConsistency:
-    AllowProtectedAndPrivateMethodsBeIndented: true
+inherit_from:
+  - https://raw.githubusercontent.com/testdouble/standard/master/config/base.yml

data/.standard.yml

@@ -0,0 +1,3 @@
+ignore:
+  - 'examples/*':
+    - Lint/UselessAssignment

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# ruby_home Changelog
+
+## [v0.2.6](https://github.com/karlentwistle/ruby_home/releases/tag/v0.2.6) (2021-05-25)
+
+### Features
+
+* Introduce in memory cache for identifier_cache and accessory_info to improve read performance
+
+## [v0.2.5](https://github.com/karlentwistle/ruby_home/releases/tag/v0.2.5) (2021-01-22)
+
+### Features
+
+* Added support for television service and characteristics (#100, @johndbritton, @getowic)
+* category_identifier can now be configured (#100, @getowic)
+
+### Fixes
+
+* Fix Ruby 3.0 LoadError (#102, @karlentwistle)

data/Gemfile

@@ -1,6 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-git_source(:github) {|repo_name| 'https://github.com/#{repo_name}' }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in ruby_home.gemspec
 gemspec

data/README.md

@@ -1,5 +1,4 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/c81f4cfdf5c13d716487/maintainability)](https://codeclimate.com/github/karlentwistle/ruby_home/maintainability)
-[![Build Status](https://travis-ci.org/karlentwistle/ruby_home.svg?branch=master)](https://travis-ci.org/karlentwistle/ruby_home)
 
 # ruby_home
 
@@ -58,6 +57,43 @@ end
 RubyHome.run
 ```
 
+## Examples
+
+The following example services are available:
+
+### Sensors
+- [Air quality sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/air_quality_sensor.rb)
+- [Carbon dioxide sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/carbon_dioxide_sensor.rb)
+- [Carbon monoxide sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/carbon_monoxide_sensor.rb)
+- [Contact sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/contact_sensor.rb)
+- [Humidity sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/humidity_sensor.rb)
+- [Leak sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/leak_sensor.rb)
+- [Light sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/light_sensor.rb)
+- [Motion sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/motion_sensor.rb)
+- [Occupancy sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/occupancy_sensor.rb)
+- [Smoke sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/smoke_sensor.rb)
+- [Temperature sensor](https://github.com/karlentwistle/ruby_home/blob/master/examples/temperature_sensor.rb)
+
+### Controlables
+- [Air purifier](https://github.com/karlentwistle/ruby_home/blob/master/examples/air_purifier.rb)
+- [Battery service](https://github.com/karlentwistle/ruby_home/blob/master/examples/battery_service.rb)
+- [Door](https://github.com/karlentwistle/ruby_home/blob/master/examples/door.rb)
+- [Fan](https://github.com/karlentwistle/ruby_home/blob/master/examples/fan.rb)
+- [Fan V2](https://github.com/karlentwistle/ruby_home/blob/master/examples/fan_v2.rb)
+- [Garage door opener](https://github.com/karlentwistle/ruby_home/blob/master/examples/garage_door_opener.rb)
+- [Heater cooler](https://github.com/karlentwistle/ruby_home/blob/master/examples/heater_cooler.rb)
+- [Humidifier dehumidifier](https://github.com/karlentwistle/ruby_home/blob/master/examples/humidifier_dehumidifier.rb)
+- [Lightbulb](https://github.com/karlentwistle/ruby_home/blob/master/examples/lightbulb.rb)
+- [Lock mechanism](https://github.com/karlentwistle/ruby_home/blob/master/examples/lock_mechanism.rb)
+- [Outlet](https://github.com/karlentwistle/ruby_home/blob/master/examples/outlet.rb)
+- [Security system](https://github.com/karlentwistle/ruby_home/blob/master/examples/security_system.rb)
+- [Switch](https://github.com/karlentwistle/ruby_home/blob/master/examples/switch.rb)
+- [Television](https://github.com/karlentwistle/ruby_home/blob/master/examples/television.rb)
+- [Thermostat](https://github.com/karlentwistle/ruby_home/blob/master/examples/thermostat.rb)
+- [Window](https://github.com/karlentwistle/ruby_home/blob/master/examples/window.rb)
+- [Window covering](https://github.com/karlentwistle/ruby_home/blob/master/examples/window_covering.rb)
+
+
 ## Configuration
 
 The configuration options can be set by using the `configure` helper:
@@ -77,6 +113,7 @@ The following is the full list of available configuration options:
 | `password` | Used for pairing, must conform to the format XXX-XX-XXX where each X is a 0-9 digit and dashes are required | Randomly generated | `"101-48-005"` | String |
 | `host` | The hostname or IP address of the interface to listen on | `"0.0.0.0"` | `"192.168.0.2"` | String  |
 | `port` | The port that should be used when starting the built-in web server | `4567` | `8080` | Integer |
+| `category_identifier` | Indicates the [category](https://github.com/karlentwistle/ruby_home/blob/master/lib/ruby_home/config/categories.yml) that best describes the primary function of the accessory. | `:bridge` | `:fan` | Symbol |
 
 ## Customization
 
@@ -90,7 +127,8 @@ accessory_information = RubyHome::ServiceFactory.create(:accessory_information,
   manufacturer: 'Fake Company',
   model: 'BSB001',
   name: 'Kickass fan bridge',
-  serial_number: 'AB1-UK-A123456'
+  serial_number: 'AB1-UK-A123456',
+  category_identifier: :fan
 )
 
 fan = RubyHome::ServiceFactory.create(:fan,
@@ -148,81 +186,6 @@ end
 RubyHome.run
 ```
 
-## More examples
-
-### Create a garage door opener
-
-```ruby
-require 'ruby_home'
-
-accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
-door = RubyHome::ServiceFactory.create(:garage_door_opener)
-
-door.target_door_state.after_update do |updated_value|
-  if updated_value == 0 # open
-    sleep 1
-    door.current_door_state = 0
-  elsif updated_value == 1 #closed
-    sleep 1
-    door.current_door_state = 1
-  end
-end
-
-RubyHome.run
-```
-
-### Create a thermostat
-
-```ruby
-require 'ruby_home'
-
-accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
-thermostat = RubyHome::ServiceFactory.create(:thermostat,
-  current_heating_cooling_state: 0, # off
-  target_heating_cooling_state: 0, # off
-  current_temperature: 18,
-  target_temperature: 18,
-  temperature_display_units: 0
-)
-
-thermostat.target_temperature.after_update do |updated_value|
-  if thermostat.current_temperature < updated_value
-    thermostat.target_heating_cooling_state = 1 # heat
-  elsif thermostat.current_temperature > updated_value
-    thermostat.target_heating_cooling_state = 2 # cool
-  end
-end
-
-thermostat.target_heating_cooling_state.after_update do |updated_value|
-  if updated_value == 1
-    thermostat.current_heating_cooling_state = 1  # heat
-  elsif updated_value == 2
-    thermostat.current_heating_cooling_state = 2 # cool
-  else
-    thermostat.current_heating_cooling_state = 0 # off
-  end
-end
-
-Thread.new do
-  loop do
-    sleep 5 # seconds
-
-    puts "current_temperature: #{thermostat.current_temperature.value.to_i}"
-    puts "target_temperature: #{thermostat.target_temperature.value.to_i}"
-
-    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
-    else
-      thermostat.target_heating_cooling_state = 3 # auto
-    end
-  end
-end
-
-RubyHome.run
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,7 +1,7 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require_relative 'lib/ruby_home'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require_relative "lib/ruby_home"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/examples/air_purifier.rb

@@ -0,0 +1,66 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+air_purifier = RubyHome::ServiceFactory.create(:air_purifier,
+  target_air_purifier_state: 0, # required
+  current_air_purifier_state: 0, # required
+  active: 0, # required
+  name: "air purifier", # optional
+  rotation_speed: 0, # optional
+  swing_mode: 1, # optional
+  lock_physical_controls: 0) # optional
+
+target_air_purifier_state_values = {
+  0 => "Manual",
+  1 => "Auto"
+}
+air_purifier.target_air_purifier_state.after_update do |target_air_purifier_state|
+  state = target_air_purifier_state_values[target_air_purifier_state]
+  puts "air purifier target air purifier state #{state}"
+end
+
+current_air_purifier_state_values = {
+  0 => "Inactive",
+  1 => "Idle",
+  2 => "Purifying Air"
+}
+air_purifier.current_air_purifier_state.after_update do |current_air_purifier_state|
+  state = current_air_purifier_state_values[current_air_purifier_state]
+  puts "air purifier current air purifier state is #{state}"
+end
+
+air_purifier.active.after_update do |active|
+  if active == 0
+    puts "air purifier is inactive"
+    air_purifier.target_air_purifier_state = 0
+    sleep 1
+    air_purifier.current_air_purifier_state = 0
+  elsif active == 1
+    puts "air purifier is active"
+    air_purifier.target_air_purifier_state = 1
+    sleep 1
+    air_purifier.current_air_purifier_state = 2
+  end
+end
+
+air_purifier.swing_mode.after_update do |swing_mode|
+  if swing_mode == 0
+    puts "air purifier swing is disabled"
+  elsif swing_mode == 1
+    puts "air purifier swing is enabled"
+  end
+end
+
+air_purifier.rotation_speed.after_update do |rotation_speed|
+  puts "air_purifier is spinning at #{rotation_speed} speed"
+end
+
+air_purifier.lock_physical_controls.after_update do |lock_physical_controls|
+  if lock_physical_controls == 0
+    puts "air purifier control lock disabled"
+  elsif lock_physical_controls == 1
+    puts "air purifier control lock enabled"
+  end
+end
+
+RubyHome.run

data/examples/air_quality_sensor.rb

@@ -0,0 +1,119 @@
+require "ruby_home"
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+air_quality_sensor = RubyHome::ServiceFactory.create(:air_quality_sensor,
+  air_quality: 0, # required
+  name: "air quality sensor", # optional
+  carbon_dioxide_level: 0, # optional
+  carbon_monoxide_level: 0, # optional
+  voc_density: 0, # optional
+  pm10_density: 0, # optional
+  pm2_5_density: 0, # optional
+  sulphur_dioxide_density: 0, # optional
+  nitrogen_dioxide_density: 0, # optional
+  ozone_density: 0, # optional
+  status_low_battery: 0, # optional
+  status_tampered: 0, # optional
+  status_fault: 0, # optional
+  status_active: true) # optional
+
+air_quality_values = {
+  0 => "Unknown",
+  1 => "Excellent",
+  2 => "Good",
+  3 => "Fair",
+  4 => "Inferior",
+  5 => "Poor"
+}
+air_quality_sensor.air_quality.after_update do |air_quality|
+  state = air_quality_values[air_quality]
+  puts "air quality sensor air quality is #{state}"
+end
+
+air_quality_sensor.carbon_dioxide_level.after_update do |carbon_dioxide_level|
+  puts "air quality sensor carbon_dioxide_level #{carbon_dioxide_level}"
+end
+
+air_quality_sensor.carbon_monoxide_level.after_update do |carbon_monoxide_level|
+  puts "air quality sensor carbon_monoxide_level #{carbon_monoxide_level}"
+end
+
+air_quality_sensor.voc_density.after_update do |voc_density|
+  puts "air quality sensor voc_density #{voc_density}"
+end
+
+air_quality_sensor.pm10_density.after_update do |pm10_density|
+  puts "air quality sensor pm10_density #{pm10_density}"
+end
+
+air_quality_sensor.pm2_5_density.after_update do |pm2_5_density|
+  puts "air quality sensor pm2_5_density #{pm2_5_density}"
+end
+
+air_quality_sensor.sulphur_dioxide_density.after_update do |sulphur_dioxide_density|
+  puts "air quality sensor sulphur_dioxide_density #{sulphur_dioxide_density}"
+end
+
+air_quality_sensor.nitrogen_dioxide_density.after_update do |nitrogen_dioxide_density|
+  puts "air quality sensor nitrogen_dioxide_density #{nitrogen_dioxide_density}"
+end
+
+air_quality_sensor.ozone_density.after_update do |ozone_density|
+  puts "air quality sensor ozone_density #{ozone_density}"
+end
+
+air_quality_sensor.status_low_battery.after_update do |status_low_battery|
+  if status_low_battery == 0
+    puts "air quality sensor battery level normal"
+  elsif status_low_battery == 1
+    puts "air quality sensor battery level lormal"
+  end
+end
+
+air_quality_sensor.status_tampered.after_update do |status_tampered|
+  if status_tampered == 0
+    puts "air quality sensor status_tampered not tampered"
+  elsif status_tampered == 1
+    puts "air quality sensor status_tampered tampered"
+  end
+end
+
+air_quality_sensor.status_fault.after_update do |status_fault|
+  if status_fault == 0
+    puts "air quality sensor status_fault no fault"
+  elsif status_fault == 1
+    puts "air quality sensor status_fault general fault"
+  end
+end
+
+air_quality_sensor.status_active.after_update do |active|
+  if active
+    puts "air quality sensor is active"
+  else
+    puts "air quality sensor is inactive"
+  end
+end
+
+Thread.new do
+  sleep 30
+
+  loop do
+    air_quality_sensor.air_quality = air_quality_values.keys.sample
+    air_quality_sensor.carbon_dioxide_level = (0..100000).to_a.sample
+    air_quality_sensor.carbon_monoxide_level = (0..100).to_a.sample
+    air_quality_sensor.voc_density = (0..1000).to_a.sample
+    air_quality_sensor.pm10_density = (0..1000).to_a.sample
+    air_quality_sensor.pm2_5_density = (0..1000).to_a.sample
+    air_quality_sensor.sulphur_dioxide_density = (0..1000).to_a.sample
+    air_quality_sensor.nitrogen_dioxide_density = (0..1000).to_a.sample
+    air_quality_sensor.ozone_density = (0..1000).to_a.sample
+    air_quality_sensor.status_low_battery = (0..1).to_a.sample
+    air_quality_sensor.status_tampered = (0..1).to_a.sample
+    air_quality_sensor.status_fault = (0..1).to_a.sample
+    air_quality_sensor.status_active = [true, false].to_a.sample
+
+    sleep 10
+  end
+end
+
+RubyHome.run