trigger_switch_d 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,54 +1,68 @@
-= trigger_switch_d
+== trigger_switch_d
 
 * http://github.com/pfspontus/trigger_switch_d
 
-==License
-See link:License.txt
+== LICENSE
 
-==Requirements
+See link:LICENSE.txt
+
+== REQUIREMENTS
 
 Mac OSX 
-USB dongle (such as tellstick from http://www.telldus.se)
-ruby-serialport (http://ruby-serialport.rubyforge.org/)
-VCP USB drivers (available at http://ftdichip.com)
+* USB dongle (such as tellstick from http://www.telldus.se)
+* ruby-serialport (http://ruby-serialport.rubyforge.org/)
+* VCP USB drivers (available at http://ftdichip.com)
+
+== DESCRIPTION
 
-==Description
 Scheduled (tsd) is run as a daemon without any need for user interaction.
 It sends commands to remote triggered devices such as lamps and switches,
 to activate/deactive them at scheduled times.
 
-==Installation
+
+== INSTALLATION
+
 1. Get source
 
 	<tt>git clone git://github.com/pfspontus/trigger_switch_d.git</tt>
 	
 2. install gem:
 
-   <tt>sudo gem install trigger_switch_d</tt>
+ 	<tt>sudo gem install trigger_switch_d</tt>
+
+== USAGE
 
-==Usage
-1. Register you remote triggered devices in a file called devices
-   using the following format:
-  ---
-    - name: "yttertrapp"
-      switches: 
-      - unit_code: "5"
-        house_code: A
-        model_name: plain_text
+Before running tsd you need to do a few things.
 
-2. Create a schedule in a file called scheduled_actions using the
+1. Setup required folders and files (home or system) by running
+
+	<tt>ts_setup (home|system)</tt>
+	
+make the necessary adjustments in environment.rb 
+
+2. Register you remote triggered devices in a file called devices
+   using the following format (yaml):<br>
+<pre>---
+- name: "yttertrapp"
+  switches: 
+  - unit_code: "5"
+    house_code: A
+    model_name: plain_tex
+</pre>
+
+3. Create a schedule in a file called scheduled_actions using the
    following format:
 
    tänd yttertrapp klockan 08:15
 
-   where "tänd" is the action, yttertrapp is the device etc. Available
-   actions are "tänd" and "släck". Device names are the ones from step 1.
+where "tänd" is the action, yttertrapp is the device etc. Available
+actions are "tänd" and "släck". Device names are the ones from step 1.
 
-3. Copy the files devices and scheduled_actions to the sub-directory db
+4. Copy the files devices and scheduled_actions to the sub-directory db
 
-4. run ./bin/tsd
+5. run tsd
 
-==Communicating with tsd when it is running
+== COMMUNICATING WITH TSD WHEN IT IS RUNNING
 
 Start IRB from a terminal and use UNIXSocket.open("/tmp/com.adhocskill.trigger_switch_d")
 to open a socket. Strings that tsd will respond to are: 
@@ -62,45 +76,48 @@ The list of strings (commands) will get longer with time.
 
 Here's an example session:
 
->> sock = UNIXSocket.open("/tmp/com.adhocskill.trigger_switch_d")
-=> #<UNIXSocket:0x1017ede78>
->> sock.send("list_schedule",0)
-=> 13
->> puts sock.recvfrom(1000)[0]
---- 
-- "släck källare vid soluppgång"
-- "släck källare klockan 00:15"
-- "tänd källare klockan 04:00"
-- "tänd yttertrapp vid solnedgång"
-- "släck yttertrapp vid soluppgång"
-- "tänd källare vid solnedgång"
-=> nil
->> sock.send("bye",0)
-=> 3
->> puts sock.recvfrom(1000)[0]
-bye
-=> nil
->> 
-
-==Sunrise and sunset
+bq. >> sock = UNIXSocket.open("/tmp/com.adhocskill.trigger_switch_d")<br>
+=> #<UNIXSocket:0x1017ede78><br>
+>> sock.send("list_schedule",0)<br>
+=> 13<br>
+>> puts sock.recvfrom(1000)[0]<br>
+--- <br>
+- "släck källare vid soluppgång"<br>
+- "släck källare klockan 00:15"<br>
+- "tänd källare klockan 04:00"<br>
+- "tänd yttertrapp vid solnedgång"<br>
+- "släck yttertrapp vid soluppgång"<br>
+- "tänd källare vid solnedgång"<br>
+=> nil<br>
+>> sock.send("bye",0)<br>
+=> 3<br>
+>> puts sock.recvfrom(1000)[0]<br>
+bye<br>
+=> nil<br>
+>> <br>
+
+== SUNRISE AND SUNSET
+
 You can schedule an action to occur at sunrise or sunset by typing
 "vid soluppgång" or "vid solnedgång" instead of "klockan HH:MM" when
 you schedule your actions. As and example:
 
    släck yttertrapp vid soluppgång
 
-==Locale
+== LOCALE
+
 The file lookup.dsl in the config folder, contains words associated with the
 actions. The file is pretty much self explanatory feel free to set the words
 to the language of your choice.
 
-==File structure
-bin::			executable scripts
-config::		environment files
-db::			files used by tsd
-doc::			rdoc documentation of the whole project
-feature::		cucumber feature/step files
-lib::			project source
-log::			scheduled puts a running log here
-sample::		some sample files to put in db or config
-spec::			rspec bdd files
+== FILE STRUCTURE
+
+<pre>bin			executable scripts
+config		environment files
+db			files used by tsd
+doc			rdoc documentation of the whole project
+feature		cucumber feature/step files
+lib			project source
+log			scheduled puts a running log here
+sample		some sample files to put in db or config
+spec			rspec bdd files</pre>

data/bin/ts_setup

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby
+# TriggerSwitchD, executes commands to activate/deactive remote switches.
+# (c) Copyright 2010 Pontus Strömdahl, AdhocSkill. 
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# ==Usage
+# 1. Deside if you want the required files in your home folder or in a
+#    more system wide folder. If you go for the home folder files will
+#    be created in ~/.trigger_switch_d. If you go for the system wide
+#    folder files will be created in /etc/trigger_switch_d
+#
+# 2. Type:
+#
+#    (for home folder)
+#    ts_setup home 
+#
+#    (for system wide folder)
+#    ts_setup system
+
+if ((ARGV.length != 1) || ((ARGV[0] =~ /^(home|system)$/) == nil))
+  puts <<-EOS
+# ==Usage
+# 1. Deside if you want the required files in your home folder or in a
+#    more system wide folder. If you go for the home folder files will
+#    be created in ~/.trigger_switch_d. If you go for the system wide
+#    folder files will be created in /etc/trigger_switch_d
+#
+# 2. Type:
+#
+#    (for home folder)
+#    ts_setup home 
+#
+#    (for system wide folder)
+#    ts_setup system
+  EOS
+  exit
+end
+
+def create(path)
+  db = "db"
+  config = "config"
+  config_path = "#{path}/#{config}"
+  db_path = "#{path}/#{db}"
+  `mkdir #{path}`
+  `mkdir #{path}/log`
+  `mkdir #{db_path}`
+  `mkdir #{config_path}`
+  `touch #{db_path}/devices`
+  `touch #{db_path}/scheduled_actions`
+  `cp samples/environment.rb #{config_path}`
+end
+
+case ARGV[0]
+when "home" then create("#{File.expand_path("~")}/.trigger_switch_d")
+when "system" then create("/etc/trigger_switch_d")
+end

data/bin/{teach → ts_teach}

@@ -37,7 +37,7 @@ require 'tellstick'
 require 'trigger_switch_d'
 
 #code to run tellstick app
-File.open(TriggerSwitchD::ConfigFactory::ENV_PATH,"r") do |config_file|
+File.open(TriggerSwitchD::ConfigFactory::ProperEnvironmentFile.new.path,"r") do |config_file|
   TriggerSwitchD::ConfigFactory.new(config_file)
 end
 stick = Tellstick::create(TriggerSwitchD::Config.output,ARGV[2])

data/bin/{turn_off → ts_turn_off}

@@ -34,7 +34,7 @@ require 'tellstick'
 require 'trigger_switch_d'
 
 #code to run tellstick app
-File.open(TriggerSwitchD::ConfigFactory::ENV_PATH,"r") do |config_file|
+File.open(TriggerSwitchD::ConfigFactory::ProperEnvironmentFile.new.path,"r") do |config_file|
   TriggerSwitchD::ConfigFactory.new(config_file)
 end
 stick = Tellstick::create(TriggerSwitchD::Config.output,ARGV[2])

data/bin/{turn_on → ts_turn_on}

@@ -34,7 +34,7 @@ require 'tellstick'
 require 'trigger_switch_d'
 
 #code to run tellstick app
-File.open(TriggerSwitchD::ConfigFactory::ENV_PATH,"r") do |config_file|
+File.open(TriggerSwitchD::ConfigFactory::ProperEnvironmentFile.new.path,"r") do |config_file|
   TriggerSwitchD::ConfigFactory.new(config_file)
 end
 stick = Tellstick::create(TriggerSwitchD::Config.output,ARGV[2])

data/bin/tsd

@@ -61,7 +61,7 @@ require 'tellstick'
 require 'trigger_switch_d'
 
 if $0 == __FILE__
-  file = File.open(TriggerSwitchD::ConfigFactory::ENV_PATH,"r")
+  file = File.open(TriggerSwitchD::ConfigFactory::ProperEnvironmentFile.new.path,"r")
   app = TriggerSwitchD::Application.new(file)
   file.close
 	app.start

data/config/environment.rb.sample

@@ -0,0 +1,42 @@
+# TriggerSwitchD, executes commands to activate/deactive remote switches.
+# (c) Copyright 2010 Pontus Strömdahl, AdhocSkill. 
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+#longitude and latitude for Malmö, Sweden. decimal form
+Config.geo_position = {:north => 54.57525, :west => -12.94125}
+
+#Paths: base for files tsd.log, devices, scheduled_actions and lookup.dsl (leave alone if uncertain) 
+Config.log_path = "log"
+Config.db_path = "db"
+Config.dsl_path = "config"
+Config.vcp_port = "/dev/tty.usbserial-A6008UFF"
+
+#Log: can be one of :file, :development or :spec (:spec is for the rspecs, ie don't use)
+#     when log_object is set to :file, the log is written to tsd.log (log_path + /tsd.log)
+#     when log_object is set to :development the log is written to STDOUT, useful for debugging
+# Config.log_object = :file
+Config.log_object = :development
+# Config.log_object = :spec
+
+#Output: can be one of :development, :tellstick or :spec (:spec is for the rspecs, ie don't use)
+#        when output is set to :development output is written to STDOUT, useful for debugging
+#        when output is set to :vcp output is sent to the usb port that has a virtual com port 
+# Config.output = :vcp
+Config.output = :development
+# Config.output = :spec
+
+#Unix socket: (leave alone if uncertain)
+Config.unix_socket_path = "/tmp"

data/config/lookup.dsl

@@ -0,0 +1,7 @@
+--- 
+släck: deactivate
+klockan: at
+solnedgång: sunset
+vid: at
+soluppgång: sunrise
+tänd: activate

data/lib/tellstick/code_converter.rb

@@ -0,0 +1,56 @@
+# TriggerSwitchD, executes commands to activate/deactive remote switches.
+# (c) Copyright 2010 Pontus Strömdahl, AdhocSkill. 
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tellstick
+  #Validates and converts code string to a positive integer
+  #Uses an array patters to validate code against
+  class CodeConverter
+    def initialize(patterns,integer_offset=0)
+      @patterns = patterns
+      @integer_offset = integer_offset
+    end
+    
+    def to_i(code)
+      choices = %w{integer_str upcase_str lowcase_str}
+      self.class.send(choices[find_parser(code)],code,@integer_offset)
+    end
+
+    private
+    def find_parser(code)
+      @patterns.each_with_index do |pattern,index|
+        result = self.class.match_code(code,pattern,index)
+        return result unless result == nil
+      end
+    end
+
+    def self.match_code(code,pattern,index)
+      return index if ((code =~ pattern) == 0)
+      nil
+    end
+
+    def self.integer_str(*args)
+      args[0].to_i + args[1]
+    end
+
+    def self.upcase_str(*args)
+      args[0][0]-"A"[0]
+    end
+
+    def self.lowcase_str(*args)
+      args[0][0]-"a"[0]
+    end
+  end
+end

data/lib/tellstick/protocol/nexa.rb

@@ -16,6 +16,7 @@
 
 
 require File.join(File.dirname(__FILE__),"protocol_loader")
+require File.join(File.dirname(__FILE__),"..","code_converter")
 
 module Tellstick
   module Nexa #:nodoc:
@@ -26,23 +27,37 @@ module Tellstick
     def turn_off(house,unit)
       output.puts "S#{codify(house)}#{codify(unit.to_s)}$k$k$kk$$kk$$k$k$}+"
     end
-    def teach(house,unit)
-      turn_on(house,unit)
+    def teach(*args)
+      turn_on(*args)
     end
     def output
       @output
     end
+    
     private
+    
+    attr_reader :convert_it
+    def convert_it
+      @convert_it ||= CodeConverter.new([/[1234]/,/[A-D]/,/[a-d]/],-1)
+    end
+
     def codify(code)
-      tmp_code = ((code =~ /[1234]/) == 0) ? code.to_i - 1: 0
-      tmp_code = code[0]-"A"[0] if ((code =~ /[A-D]/) == 0)      
-      tmp_code = code[0]-"a"[0] if ((code =~ /[a-d]/) == 0)
-      result = ["$k$k", "$k$k", "$k$k", "$k$k"]
-      (0..result.length-1).each do |bit|
-        result[result.length-1-bit] = "$kk$" if (tmp_code & 1) == 1
-        tmp_code >>= 1
+      Nexa::adjust_result(convert_it.to_i(code)).reverse
+    end
+
+    def self.adjust_result(code)
+      choices = %w{$k$k $kk$}
+      translate_to_bit_array(code).map do |bit|
+        choices[bit]
+      end.reverse
+    end
+
+    def self.translate_to_bit_array(code)
+      (0..3).map do
+        val = (code & 1)
+        code >>= 1
+        val
       end
-      result.reverse
     end
   end
 end

data/lib/tellstick/protocol/not_connected.rb

@@ -18,25 +18,17 @@
 module Tellstick
   module NotConnected #:nodoc:
 
-    def turn_on(house,unit)
-      [output,STDOUT].each {|o| o.puts attention }
-    end
-
-    def turn_off(house,unit)
-      [output,STDOUT].each {|o| o.puts attention }
-    end
-
-    def teach(house,unit)
-      [output,STDOUT].each {|o| o.puts attention }
+    def attention(*args)
+      [output,STDOUT].each {|out| out.puts "Koppla in usb stickan först" }
     end
+    
+    alias turn_on attention
+    alias turn_off attention
+    alias teach attention
 
     def output
       @output
     end
 
-private
-    def attention
-      "Koppla in usb stickan först"
-    end
   end
 end

data/lib/tellstick/protocol/null_protocol.rb

@@ -17,25 +17,17 @@
 
 module Tellstick
   module NullProtocol #:nodoc:
-    def turn_on(house,unit)
-      [output,STDOUT].each {|o| o.puts attention }
-    end
-
-    def turn_off(house,unit)
-      [output,STDOUT].each {|o| o.puts attention }
-    end
 
-    def teach(house,unit)
-      [output,STDOUT].each {|o| o.puts attention }
+    def attention(*args)
+      [output,STDOUT].each {|out| out.puts "Protokollet finns inte" }
     end
     
+    alias turn_on attention
+    alias turn_off attention
+    alias teach attention
+
     def output
       @output
     end
-
-    private
-    def attention
-      "Protokollet finns inte"
-    end
   end
 end

data/lib/tellstick/protocol/proove.rb

@@ -16,22 +16,26 @@
 
 
 require File.join(File.dirname(__FILE__),"protocol_loader")
+require File.join(File.dirname(__FILE__),"..","code_converter")
 
 module Tellstick
   module Proove #:nodoc:
     include ProtocolLoader
-    def turn_on(house,unit)
-      output.puts build_command_string(house,unit,true)
+    def turn_on(*args)
+      args << true
+      output.puts build_command_string(*Proove::preprocess_build_command_args(*args))
     end
 
-    def turn_off(house,unit)
-      output.puts build_command_string(house,unit,false)
+    def turn_off(*args)
+      args << false
+      output.puts build_command_string(*Proove::preprocess_build_command_args(*args))
     end
 
-    def teach(house,unit)
-      (1..5).each do |i|
-        output.puts build_command_string(house,unit,true,2)
-        output.gets
+    def teach(*args)
+      args += [true,2]
+      (1..5).each do
+        @output.puts build_command_string(*Proove::preprocess_build_command_args(*args))
+        @output.gets
         sleep 0.2
       end
     end
@@ -41,43 +45,64 @@ module Tellstick
     end
     
     private
-    def part_for(code,number_of_bits)
+    
+    attr_reader :convert_it
+    def convert_it
+      @convert_it ||= CodeConverter.new([/\d+/,/[A-D]/,/[a-d]/])
+    end
+    
+    def self.part_for(code,number_of_bits)
       result = ""
-      (0..number_of_bits).each do |i|
-        result << (((code & 1) << (number_of_bits - i) == 1)? "10" : "01")
+      (0..number_of_bits).each do |index|
+        result << (((code & 1) << (number_of_bits - index) == 1)? "10" : "01")
       end
       result
     end
     
-    def translate(code_part)
-      result = ""
+    def self.character_bit_pattern(code,character)
+      code <<= 4
+      return (code | 8) if character == "1"
+      (code | 10)  
+    end
+    
+    def self.translate(code_part)
     	code = 9
-    	code_part.scan(/./).each_with_index do |c,i|
-        code <<= 4
-        if c == "1"
-          code |= 8
-        else
-          code |= 10
-        end
-        if (i % 2 == 0)
-          result << code.chr
-          code = 0
-        end
+    	translate_inner(code_part) do |result, character,index|
+        code = code_tmp = character_bit_pattern(code,character)
+        code = 0 if (index % 2 == 0)
+        translate_update_result(result,code_tmp,index)
+      end
+    end
+    
+    def self.translate_update_result(result,code,index)
+      return result if (index % 2 != 0)
+      result << code.chr
+    end
+        
+    def self.translate_inner(code_part)
+      index = 0
+    	code_part.scan(/./).inject("") do |result, character|
+    	  result = yield(result, character, index)
+    	  index += 1
+    	  result
       end
-      result
     end
     
-    def build_command_string(house,unit,on,number_repeat=5)
-      house_code = ((house =~ /\d+/) == 0) ? house.to_i : 0
-      house_code = house[0]-"A"[0] if ((house =~ /[A-Z]/) == 0)      
-      house_code = house[0]-"a"[0] if ((house =~ /[a-z]/) == 0)
+    def self.signal_part(house_code, unit,on_off)
       unit_code = unit.to_i - 1
-      
-      on_off = on ? "10" : "01"
-      
-    	signal_part = "#{part_for(house_code,25)}01#{on_off}#{part_for(unit_code,3)}0"
-    	
-      "R#{number_repeat.chr}T\177\377\030\001\204#{translate(signal_part)}+"
+      Proove::translate("#{part_for(house_code,25)}01#{on_off}#{part_for(unit_code,3)}0")
     end
+    
+    def self.preprocess_build_command_args(*args)
+      args << 5 if args.length < 4
+      args
+    end
+    
+    def build_command_string(*args)
+      house,unit,on,number_repeat = args
+      house_code = convert_it.to_i(house) 
+      on_off = on ? "10" : "01"
+      "R#{number_repeat.chr}T\177\377\030\001\204#{Proove::signal_part(house_code,unit,on_off)}+"
+    end    
   end
 end

data/lib/tellstick/protocol/protocol_loader.rb

@@ -18,9 +18,8 @@
 module Tellstick
   module ProtocolLoader #:nodoc:
     def self.included(klass)
-      p = klass
-      key = p.name.gsub("Tellstick::","").split(/(?=[A-Z])/).map{|w| w.downcase}.join("_")
-      $protocol[key] = p
+      key = klass.name.gsub("Tellstick::","").split(/(?=[A-Z])/).map{|name| name.downcase}.join("_")
+      $protocol[key] = klass
     end
   end
 end