pi-lights-control 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85d3641e75455c5cfeab30f37440f883d6cd9d08
-  data.tar.gz: f782c16c5118db1487003f39539e5cc4217249f7
+  metadata.gz: 1b7a8a8550a1b6fbdca33a0f8ea7772caa417690
+  data.tar.gz: cabf059d2b62b01cfd1cd24876aef0a27f217c1f
 SHA512:
-  metadata.gz: 1902a4eeebcb9eeb78f37c8e020751e2dc97f0ac88723bf82962829a4781288eebf9aebc553f7ec30db79068f1f55388f9bfba642119ae91672e1e6a9d0e8110
-  data.tar.gz: 1d18644a4819eb70db4de901db65d488665e2e86ef98b8eed757bd79be08bc4b81deb1286f8364ddeb27ebfe63d037fe0220ce2aab2a96bdae72189a59c2895f
+  metadata.gz: 0842ac706aa95f7cfd1f3037d5563f7637cefc967e471ca70e8881c8967955b9b6123db17dafa05794c984767d13c2f7ef128bea19016d2b4ca7fbecc526388a
+  data.tar.gz: 3a52c2e9bb8bcef9169bf38afc6b9987876880a71bb634750536f4a659eab0192d3bdbc623bbc0f6d2de1faf53b958f3cba78354202869aa1c0437141a9ad00b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v1.0.0 (2016 Nov 20)
+
+* Finalize API
+* Clean up Ruby formatting
+
 ## v0.2.0 (2016 Nov 19)
 
 * Add CLI tool for controlling lights

data/README.md

@@ -1,6 +1,8 @@
 # Pi Lights Control
 
-This gem provides an executable and a library for sending radio frequency commands from a Raspberry Pi connected with a 433.920 MHz transmitter to one or more sets of Home Collection Remote Control Christmas Lights.
+[![Gem Version](https://badge.fury.io/rb/pi-lights-control.svg)](https://badge.fury.io/rb/pi-lights-control)
+
+This gem provides an executable and a library for sending radio frequency commands from a Raspberry Pi connected with a 433.920 MHz transmitter to one or more sets of Home Collection Remote Control Christmas Lights (Product #151-3478-6). I have only tested it with the C9 light set, it *might* work with the C6 light set too.
 
 The gem should be compatible with any Raspberry Pi that has GPIO pins. It has been tested with a 433.920 MHz FS1000A module (pictured below) for Arduino/Raspberry Pi compatible devices. It **will not** build on MacOS as epoll is only supported on Linux.
 
@@ -138,21 +140,6 @@ c.program(:step_fade) # Lights fade from off to on but at discrete brightness st
 
 (Secret: The default remote actually sends 16 different codes! However codes 9–16 trigger the same eight programs as codes 1–8.)
 
-## Roadmap
-
-For v0.1.0:
-
-* Support power on/off for lights
-* Support all light programs and sync
-
-For v0.2.0:
-
-* Add executable
-
-For v0.3.0:
-
-* Any cleanup/refactoring before v1.0
-
 ## 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/exe/pi-lights-control

@@ -1,125 +1,61 @@
 #!/usr/bin/env ruby
 
-require "gli"
-require "pi-lights-control"
+require 'gli'
+require 'pi-lights-control'
 
 include GLI::App
 
-program_desc "Control Home Collection Lights over GPIO and RF Transmitter"
+program_desc 'Control Home Collection Lights over GPIO and RF Transmitter'
 
-desc "GPIO pin number for RF Transmitter. Mandatory."
-flag [:p,:pin], type: Integer
+desc 'GPIO pin number for RF Transmitter. Mandatory.'
+flag [:p, :pin], type: Integer
 
-desc "Turn lights on"
-long_desc "Sends a \"power on\" command to the lights"
+desc 'Turn lights on'
+long_desc 'Sends a "power on" command to the lights'
 command :on do |c|
-  c.action do |global_options,options,args|
-    help_now!("No pin number specified") if global_options[:pin].nil?
+  c.action do |global_options|
+    help_now!('No pin number specified') if global_options[:pin].nil?
     command = PiLightsControl::Command.new(global_options[:pin].to_i)
     command.power_on
   end
 end
 
-desc "Turn lights off"
-long_desc "Sends a \"power off\" command to the lights"
+desc 'Turn lights off'
+long_desc 'Sends a "power off" command to the lights'
 command :off do |c|
-  c.action do |global_options,options,args|
-    help_now!("No pin number specified") if global_options[:pin].nil?
+  c.action do |global_options|
+    help_now!('No pin number specified') if global_options[:pin].nil?
     command = PiLightsControl::Command.new(global_options[:pin].to_i)
     command.power_off
   end
 end
 
-desc "Sync multiple light sets"
-long_desc "Sends a \"sync\" command to any lights in range"
+desc 'Sync multiple light sets'
+long_desc 'Sends a "sync" command to any lights in range'
 command :sync do |c|
-  c.action do |global_options,options,args|
-    help_now!("No pin number specified") if global_options[:pin].nil?
+  c.action do |global_options|
+    help_now!('No pin number specified') if global_options[:pin].nil?
     command = PiLightsControl::Command.new(global_options[:pin].to_i)
     command.sync_lights
   end
 end
 
-desc "Run a lights program"
-long_desc "Sends a command to run a specific lights program"
+desc 'Run a lights program'
+long_desc %(
+Sends a command to run a specific lights program. One of 'combination',
+'steady', 'slow_blink', 'fast_blink', 'slow_fade', 'fast_fade',
+'blink_steady', or 'step_fade'.
+)
 command :program do |c|
-  c.desc "Combination"
-  c.long_desc "Cycles through the other 7 programs"
-  c.command :combination do |p|
-    p.action do |global_options,options,args|
-      help_now!("No pin number specified") if global_options[:pin].nil?
-      command = PiLightsControl::Command.new(global_options[:pin].to_i)
-      command.program(:combination)
-    end
-  end
-
-  c.desc "Steady"
-  c.long_desc "Lights are continuously on"
-  c.command :steady do |p|
-    p.action do |global_options,options,args|
-      help_now!("No pin number specified") if global_options[:pin].nil?
-      command = PiLightsControl::Command.new(global_options[:pin].to_i)
-      command.program(:steady)
-    end
-  end
-
-  c.desc "Slow Blink"
-  c.long_desc "Lights are on 1/2 second, then off 1/2 second"
-  c.command :slow_blink do |p|
-    p.action do |global_options,options,args|
-      help_now!("No pin number specified") if global_options[:pin].nil?
-      command = PiLightsControl::Command.new(global_options[:pin].to_i)
-      command.program(:slow_blink)
-    end
-  end
-
-  c.desc "Fast Blink"
-  c.long_desc "Lights blink on/off much faster"
-  c.command :fast_blink do |p|
-    p.action do |global_options,options,args|
-      help_now!("No pin number specified") if global_options[:pin].nil?
-      command = PiLightsControl::Command.new(global_options[:pin].to_i)
-      command.program(:fast_blink)
-    end
-  end
-
-  c.desc "Slow Fade"
-  c.long_desc "Lights fade from off to on at a slow rate"
-  c.command :slow_fade do |p|
-    p.action do |global_options,options,args|
-      help_now!("No pin number specified") if global_options[:pin].nil?
-      command = PiLightsControl::Command.new(global_options[:pin].to_i)
-      command.program(:slow_fade)
-    end
-  end
-
-  c.desc "Fast Fade"
-  c.long_desc "Lights fade from off to on at a fast rate"
-  c.command :fast_fade do |p|
-    p.action do |global_options,options,args|
-      help_now!("No pin number specified") if global_options[:pin].nil?
-      command = PiLightsControl::Command.new(global_options[:pin].to_i)
-      command.program(:fast_fade)
-    end
-  end
-
-  c.desc "Blink Steady"
-  c.long_desc "Lights blink twice, then are steady for a second or two"
-  c.command :blink_steady do |p|
-    p.action do |global_options,options,args|
-      help_now!("No pin number specified") if global_options[:pin].nil?
-      command = PiLightsControl::Command.new(global_options[:pin].to_i)
-      command.program(:blink_steady)
-    end
-  end
-
-  c.desc "Step Fade"
-  c.long_desc "Lights fade from off to on but at discrete brightness steps instead of a continuous increase/decrease"
-  c.command :step_fade do |p|
-    p.action do |global_options,options,args|
-      help_now!("No pin number specified") if global_options[:pin].nil?
-      command = PiLightsControl::Command.new(global_options[:pin].to_i)
-      command.program(:step_fade)
+  c.action do |global_options, _options, args|
+    program_name = args[0]
+    case program_name
+    when 'combination', 'steady', 'slow_blink', 'fast_blink',
+         'slow_fade', 'fast_fade', 'blink_steady', 'step_fade'
+      command = PiLightsControl::Command.new(global_options[:pin].to_i)
+      command.program(program_name.to_sym)
+    else
+      help_now!('Unknown program name')
     end
   end
 end

data/lib/pi-lights-control.rb

@@ -9,19 +9,19 @@ module PiLightsControl
     1 => [4, 8],
     2 => [4, 71],
     3 => [26, 12]
-  }
+  }.freeze
   COMMAND_TABLE = {
-    power_off:            [3,0,1,0,1,1,0,0,1,1,1,0,1,0,0,0,1,2],
-    power_on:             [3,0,1,0,1,1,0,0,1,1,1,0,1,0,0,0,0,2],
-    sync_lights:          [3,0,0,1,1,0,1,1,1,0,0,0,1,1,1,0,0,2],
-    program_combination:  [3,0,1,0,1,1,0,0,1,1,1,1,0,0,0,0,0,2],
-    program_steady:       [3,0,1,0,1,1,0,0,1,1,1,1,0,0,0,0,1,2],
-    program_slow_blink:   [3,0,1,0,1,1,0,0,1,1,1,1,0,0,0,1,0,2],
-    program_fast_blink:   [3,0,1,0,1,1,0,0,1,1,1,1,0,0,0,1,1,2],
-    program_slow_fade:    [3,0,1,0,1,1,0,0,1,1,1,1,0,0,1,0,0,2],
-    program_fast_fade:    [3,0,1,0,1,1,0,0,1,1,1,1,0,0,1,0,1,2],
-    program_blink_steady: [3,0,1,0,1,1,0,0,1,1,1,1,0,0,1,1,0,2],
-    program_step_fade:    [3,0,1,0,1,1,0,0,1,1,1,1,0,0,1,1,1,2]
-  }
+    power_off:            [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 0, 0, 0, 1, 2],
+    power_on:             [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 0, 0, 0, 0, 2],
+    sync_lights:          [3, 0, 0, 1, 1, 0, 1, 1, 1, 0, 0, 0, 1, 1, 1, 0, 0, 2],
+    program_combination:  [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0, 2],
+    program_steady:       [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 2],
+    program_slow_blink:   [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 2],
+    program_fast_blink:   [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 0, 1, 1, 2],
+    program_slow_fade:    [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 1, 0, 0, 2],
+    program_fast_fade:    [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 1, 0, 1, 2],
+    program_blink_steady: [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 1, 1, 0, 2],
+    program_step_fade:    [3, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 1, 1, 1, 2]
+  }.freeze
   TIME_DELAY = 120 # microseconds
 end

data/lib/pi-lights-control/command.rb

@@ -17,7 +17,7 @@ module PiLightsControl
     end
 
     def program(name)
-      program_name = "program_#{name.to_s}"
+      program_name = "program_#{name}"
       transmit_command(PiLightsControl::COMMAND_TABLE[program_name.to_sym])
     end
 
@@ -35,10 +35,10 @@ module PiLightsControl
           low_length = PiLightsControl::CODE_TABLE[code][1]
 
           RPi::GPIO.set_high @pin
-          sleep(high_length * PiLightsControl::TIME_DELAY / 1000000.0)
+          sleep(high_length * PiLightsControl::TIME_DELAY / 1E6)
 
           RPi::GPIO.set_low @pin
-          sleep(low_length * PiLightsControl::TIME_DELAY / 1000000.0)
+          sleep(low_length * PiLightsControl::TIME_DELAY / 1E6)
         end
       end
       RPi::GPIO.clean_up @pin

data/lib/pi-lights-control/version.rb

@@ -1,3 +1,3 @@
 module PiLightsControl
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pi-lights-control
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - James Badger