pi-lights-control 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbfc3abb1ce7e062601c6c375716ba4397997a03
+  data.tar.gz: 557cb974d3de60fe93a5611745846ef689042691
+SHA512:
+  metadata.gz: b73d59592fbc6676e6f666ef19589ba0defc04e2b01a328999d387bc13e63f429d6059b753188b1dd2ca4e8fe8f08ac12fcf8192b5ee7e49226d2606f024213e
+  data.tar.gz: 3087fc9ee3c6626fb02bce9b546e741b0c67fd4a287d336d1aa8293576fd9a66cfc4866ca72e0dcf35b527ae82ca0a1c6999cb1d0c8664761c975cd2f991e2ad

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## v0.1.0 (2016 Nov 19)
+
+* Support power on/off RF commands
+* Support multiple light set syncing
+* Support eight default light programs

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jpbadger@ucalgary.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pi-lights-control.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 James Badger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# 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.
+
+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.
+
+![FS1000A Receiver/Transmitter Set](https://www.jamesbadger.ca/images/FS1000A.jpg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pi-lights-control'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pi-lights-control
+
+## Usage
+
+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.
+
+TODO
+
+### Library API
+
+Alternatively, you can build applications that integrate this library.
+
+#### Command Class
+
+The `Command` class sets up a single GPIO pin as the output control for a transmitter. It is initialized with the Pin number (defaulting to board numbering). It also supports BCM pin numbering.
+
+```ruby
+c = PiLightsControl::Command.new(12) # => :board numbering
+c = PiLightsControl::Command.new(10, { numbering: :bcm }) # => :bcm numbering
+```
+
+The `Command` class will default to repeating codes six times, as that was a reliable count used in testing. You can however change it:
+
+```ruby
+c = PiLightsControl::Command.new(12)
+c.repeat_count = 8
+```
+
+Turning the lights on or off can be accessed using simple commands:
+
+```ruby
+c = PiLightsControl::Command.new(12)
+c.power_on
+c.power_off
+```
+
+Synchronizing lights will cause any light sets that receive the command to reset to a default state, ensuring all lights are in a "fresh slate".
+
+```ruby
+c = PiLightsControl::Command.new(12)
+c.sync_lights
+```
+
+There are eight different programs that can be configured for the lights.
+
+```ruby
+c = PiLightsControl::Command.new(12)
+c.program(:combination) # Cycles through the other 7 programs
+c.program(:steady) # Lights are continuously on
+c.program(:slow_blink) # Lights are on 1/2 second, then off 1/2 second
+c.program(:fast_blink) # Lights blink on/off much faster
+c.program(:slow_fade) # Lights fade from off to on at a slow rate
+c.program(:fast_fade) # Lights fade from off to on at a fast rate
+c.program(:blink_steady) # Lights blink twice, then are steady for a second or two
+c.program(:step_fade) # Lights fade from off to on but at discrete brightness steps instead of a continuous increase/decrease
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/openfirmware/pi-lights-control. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pi-lights-control"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/pi-lights-control

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "pi-lights-control"

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

@@ -0,0 +1,45 @@
+module PiLightsControl
+  class Command
+    attr_accessor :repeat_count
+
+    def initialize(pin, options = {})
+      RPi::GPIO.set_numbering options[:numbering] || :board
+      @repeat_count = 6
+      @pin = pin
+    end
+
+    def power_off
+      transmit_command(PiLightsControl::COMMAND_TABLE[:power_off])
+    end
+
+    def power_on
+      transmit_command(PiLightsControl::COMMAND_TABLE[:power_on])
+    end
+
+    def program(name)
+      program_name = "program_#{name.to_s}"
+      transmit_command(PiLightsControl::COMMAND_TABLE[program_name.to_sym])
+    end
+
+    def sync_lights
+      transmit_command(PiLightsControl::COMMAND_TABLE[:sync_lights])
+    end
+
+    private
+
+    def transmit_command(command)
+      @repeat_count.times do
+        command.each do |code|
+          high_length = PiLightsControl::CODE_TABLE[code][0]
+          low_length = PiLightsControl::CODE_TABLE[code][1]
+
+          RPi::GPIO.set_high @pin
+          sleep(high_length * PiLightsControl::TIME_DELAY / 1000000.0)
+
+          RPi::GPIO.set_low @pin
+          sleep(low_length * PiLightsControl::TIME_DELAY / 1000000.0)
+        end
+      end
+    end
+  end
+end

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

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

data/lib/pi-lights-control.rb

@@ -0,0 +1,27 @@
+require 'rpi_gpio'
+
+require "pi-lights-control/command"
+require "pi-lights-control/version"
+
+module PiLightsControl
+  CODE_TABLE = {
+    0 => [4, 4],
+    1 => [4, 8],
+    2 => [4, 71],
+    3 => [26, 12]
+  }
+  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]
+  }
+  TIME_DELAY = 120 # microseconds
+end

data/pi-lights-control.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pi-lights-control/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pi-lights-control"
+  spec.version       = PiLightsControl::VERSION
+  spec.authors       = ["James Badger"]
+  spec.email         = ["james@jamesbadger.ca"]
+
+  spec.summary       = %q{Control one model of xmas lights via Raspberry Pi}
+  spec.description   = %q{Control a specific model of Christmas lights using a Raspberry Pi and a 433.920 MHz transmitter connected via GPIO.}
+  spec.homepage      = "https://github.com/openfirmware/pi-lights-control"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rpi_gpio", "~> 0.3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: pi-lights-control
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Badger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rpi_gpio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Control a specific model of Christmas lights using a Raspberry Pi and
+  a 433.920 MHz transmitter connected via GPIO.
+email:
+- james@jamesbadger.ca
+executables:
+- pi-lights-control
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/pi-lights-control
+- lib/pi-lights-control.rb
+- lib/pi-lights-control/command.rb
+- lib/pi-lights-control/version.rb
+- pi-lights-control.gemspec
+homepage: https://github.com/openfirmware/pi-lights-control
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Control one model of xmas lights via Raspberry Pi
+test_files: []