pi-lights-control 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbfc3abb1ce7e062601c6c375716ba4397997a03
-  data.tar.gz: 557cb974d3de60fe93a5611745846ef689042691
+  metadata.gz: 85d3641e75455c5cfeab30f37440f883d6cd9d08
+  data.tar.gz: f782c16c5118db1487003f39539e5cc4217249f7
 SHA512:
-  metadata.gz: b73d59592fbc6676e6f666ef19589ba0defc04e2b01a328999d387bc13e63f429d6059b753188b1dd2ca4e8fe8f08ac12fcf8192b5ee7e49226d2606f024213e
-  data.tar.gz: 3087fc9ee3c6626fb02bce9b546e741b0c67fd4a287d336d1aa8293576fd9a66cfc4866ca72e0dcf35b527ae82ca0a1c6999cb1d0c8664761c975cd2f991e2ad
+  metadata.gz: 1902a4eeebcb9eeb78f37c8e020751e2dc97f0ac88723bf82962829a4781288eebf9aebc553f7ec30db79068f1f55388f9bfba642119ae91672e1e6a9d0e8110
+  data.tar.gz: 1d18644a4819eb70db4de901db65d488665e2e86ef98b8eed757bd79be08bc4b81deb1286f8364ddeb27ebfe63d037fe0220ce2aab2a96bdae72189a59c2895f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.2.0 (2016 Nov 19)
+
+* Add CLI tool for controlling lights
+* Fix missing GPIO pin setup command
+* Auto clean up GPIO pins after each signal command
+
 ## v0.1.0 (2016 Nov 19)
 
 * Support power on/off RF commands

data/README.md

@@ -28,9 +28,64 @@ You can use this gem in two ways, as a Ruby library or as an executable.
 
 ### Executable Usage
 
-Using the executable from the command line allows you to quickly test the library.
+Using the executable from the command line allows you to quickly test the library. After installing the gem, the `pi-lights-control` binary will be available in your gem bin path.
+
+```shell
+$ pi-lights-control
+NAME
+    pi-lights-control - Control Home Collection Lights over GPIO and RF Transmitter
+
+SYNOPSIS
+    pi-lights-control [global options] command [command options] [arguments...]
+
+GLOBAL OPTIONS
+    --help        - Show this message
+    -p, --pin=arg - GPIO pin number for RF Transmitter. Mandatory. (default: none)
+
+COMMANDS
+    help    - Shows a list of commands or help for one command
+    off     - Turn lights off
+    on      - Turn lights on
+    program - Run a lights program
+    sync    - Sync multiple light sets
+```
+
+The `--pin` argument is mandatory as all the commands need to know which pin to control. The `off`, `on` commands should be self-explanatory.
+
+The `sync` command will send a code that resets all lights to the same state.
+
+The `program` command has multiple sub-commands:
+
+```shell
+$ pi-lights-control help program
+NAME
+    program - Run a lights program
+
+SYNOPSIS
+    pi-lights-control [global options] program blink_steady
+    pi-lights-control [global options] program combination
+    pi-lights-control [global options] program fast_blink
+    pi-lights-control [global options] program fast_fade
+    pi-lights-control [global options] program slow_blink
+    pi-lights-control [global options] program slow_fade
+    pi-lights-control [global options] program steady
+    pi-lights-control [global options] program step_fade
+
+DESCRIPTION
+    Sends a command to run a specific lights program
+
+COMMANDS
+    blink_steady - Blink Steady
+    combination  - Combination
+    fast_blink   - Fast Blink
+    fast_fade    - Fast Fade
+    slow_blink   - Slow Blink
+    slow_fade    - Slow Fade
+    steady       - Steady
+    step_fade    - Step Fade
+```
 
-TODO
+Remember to send the `--pin` argument!
 
 ### Library API
 
@@ -81,6 +136,8 @@ c.program(:blink_steady) # Lights blink twice, then are steady for a second or t
 c.program(:step_fade) # Lights fade from off to on but at discrete brightness steps instead of a continuous increase/decrease
 ```
 
+(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:

data/exe/pi-lights-control

@@ -1,3 +1,127 @@
 #!/usr/bin/env ruby
 
+require "gli"
 require "pi-lights-control"
+
+include GLI::App
+
+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 "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?
+    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"
+command :off do |c|
+  c.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.power_off
+  end
+end
+
+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?
+    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"
+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)
+    end
+  end
+end
+
+exit run(ARGV)

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

@@ -3,7 +3,7 @@ module PiLightsControl
     attr_accessor :repeat_count
 
     def initialize(pin, options = {})
-      RPi::GPIO.set_numbering options[:numbering] || :board
+      RPi::GPIO.set_numbering(options[:numbering] || :board)
       @repeat_count = 6
       @pin = pin
     end
@@ -28,6 +28,7 @@ module PiLightsControl
     private
 
     def transmit_command(command)
+      RPi::GPIO.setup @pin, as: :output
       @repeat_count.times do
         command.each do |code|
           high_length = PiLightsControl::CODE_TABLE[code][0]
@@ -40,6 +41,7 @@ module PiLightsControl
           sleep(low_length * PiLightsControl::TIME_DELAY / 1000000.0)
         end
       end
+      RPi::GPIO.clean_up @pin
     end
   end
 end

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

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

data/pi-lights-control.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "gli", "~> 2.14.0"
   spec.add_dependency "rpi_gpio", "~> 0.3.2"
 
   spec.add_development_dependency "bundler", "~> 1.13"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pi-lights-control
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Badger
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2016-11-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: rpi_gpio
   requirement: !ruby/object:Gem::Requirement