ruby_home 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fb157eb26583418aa02ef31fe2b4ed2f8f40f8cb57e46f78e7603cdd531256b
-  data.tar.gz: 5ed756570a2e0f3992a0b4b53eb0521bc94d7c46f55e5318a80e6bf74da27304
+  metadata.gz: faee051d71617c37bbbaf0274d1469db94770d0623bc415a7f8448ff7ce4408b
+  data.tar.gz: c207e5bb1bec2c07d86183e912c21a3f8f4e8c3c4c27b639cd955a9a3d21b887
 SHA512:
-  metadata.gz: a8732ab9a3caa1e9d61a371bbed0495eb523d6e0b1e0c248f1f7f1fc7d6ab6848ccaa8a5105a78214ad4375bb15df57e84df00d664cf4ad554bbab89a53e375d
-  data.tar.gz: 3f0b97b56c9785b1664a5fa7885407a37ae75bce6924f1b8c7dbee6b72ab3037b8037f5872c38e7fad6ed5bd88fa34f73f955a70138774b6b1fe18bfe218956a
+  metadata.gz: 601d7ef1d41989e34ae7ba3a336dcf3b36c93a693a0bfb8d998afc2aae7e9bcf243c65406eab992269f03e627ef71f0b01be904969b37e063c2472f4b438a022
+  data.tar.gz: 7f5ee6ca44cabbdbf316e1a21c388ba09173e4a69853a8505d80249bd4602ee9f0cf609c8a6755fc6b6337c540d4a712573f1d4984b1435dd008ed04a77d8b49

data/.github/workflows/tests.yml

@@ -0,0 +1,41 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  ubuntu:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [3.0, 2.7, 2.6, 2.5]
+    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, 2.5]
+    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/CHANGELOG.md

@@ -0,0 +1,13 @@
+# ruby_home Changelog
+
+## [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/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
 
@@ -17,7 +16,7 @@ For OS X users, libsodium is available via homebrew and can be installed with:
 
     brew install libsodium
 
-For Debian users, libsodium is available both via apt:
+For Debian users, libsodium is available via apt:
 
     sudo apt-get install libsodium-dev
 
@@ -33,13 +32,13 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself with:
 
     $ gem install ruby_home
 
 ## Basic usage
 
-Create a fan with an on/off switch.
+Create a fan with an on/off switch:
 
 ```ruby
 require 'ruby_home'
@@ -58,9 +57,46 @@ 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
+The configuration options can be set by using the `configure` helper:
 
 ```ruby
 RubyHome.configure do |c|
@@ -74,9 +110,10 @@ The following is the full list of available configuration options:
 |---|---|---|---|---|
 | `discovery_name` |  The user-visible name of the accessory | `"RubyHome"` | `"My Home"` | String |
 | `model_name` |  The model name of the accessory | `"RubyHome"` | `"Device1,1"` | String |
-| `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 |
+| `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,
@@ -117,9 +155,9 @@ RubyHome.run
 
 ## Updating a characteristics value
 
-If you have a service with characteristics that can be changed outside of Ruby Home. You'll want to keep Ruby Home in sync with these modifications. Otherwise, the characteristics current value won't correspond with reality. The simplest way to do this is a background job that periodically polls the devices current status and updates the corresponding characteristics value if it's changed.
+If you have a service with characteristics that can be changed outside of Ruby Home, you'll want to keep Ruby Home in sync with these modifications. Otherwise, the characteristics current value won't correspond with reality. The simplest way to do this is a background job that periodically polls the devices current status and updates the corresponding characteristics value if it's changed.
 
-Given a fan which can be switched on / off with a remote control. Which has a JSON API endpoint at http://example.org/fan_status.json that returns its current status `{ "on": true }` or `{ "on": false }`. We can spawn a thread that keeps polling the fans current status and if its changed update our fan service "on" characteristic.
+Given a fan which can be switched on / off with a remote control, which has a JSON API endpoint at http://example.org/fan_status.json that returns its current status `{ "on": true }` or `{ "on": false }`, we can spawn a thread that keeps polling the fans current status and if it's changed update our fan service "on" characteristic.
 
 ```ruby
 require 'json'
@@ -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/examples/air_purifier.rb

@@ -0,0 +1,67 @@
+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,120 @@
+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