trigger_switch_d 0.1.0

data/LICENSE.txt

@@ -0,0 +1,54 @@
+TriggerSwitchD is copyrighted free software by Pontus Strömdahl, AdhocSkill, 
+<pontus.stromdahl@adhocskill.com>.You can redistribute it and/or modify
+it under either the terms of the GPL (see COPYING.txt file),
+or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.rdoc

@@ -0,0 +1,106 @@
+= trigger_switch_d
+
+* http://github.com/pfspontus/trigger_switch_d
+
+==License
+See link:License.txt
+
+==Requirements
+
+Mac OSX 
+USB dongle (such as tellstick from http://www.telldus.se)
+ruby-ftd2xx gem (git://github.com/pfspontus/ruby-ftd2xx)
+ftd2xx USB drivers (available at http://ftdichip.com)
+
+==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
+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>
+
+==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
+
+2. 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.
+
+3. Copy the files devices and scheduled_actions to the sub-directory db
+
+4. run ./bin/tsd
+
+==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: 
+
+* list_schedule 
+* list_devices
+* bye			(disconnects client socket without stopping daemon)
+* stop			(disconnects client socket and stops daemon)
+
+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
+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
+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

data/bin/teach

@@ -0,0 +1,44 @@
+#!/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/>.
+#
+# ==Description
+# teach is used to make a remote triggered device respond to an action
+# specified by the user.
+# ==Usage
+# 1. Deside what channel/house code, unitcode and protocol/model you
+#    should use for your remote triggered device, for example:
+#
+#		    unit_code: 5
+#		    house_code: A
+#		    model_name: nexa
+#
+# 2. Refer to the documentation for your device to put it in selflearning
+#    mode, and then run:
+#
+#    ./bin/teach A 5 nexa
+
+$LOAD_PATH.push File.join(File.dirname(__FILE__),".." ,"lib" )
+require 'tellstick'
+
+#code to run tellstick app
+output = Tellstick::TellstickIO.new
+stick = Tellstick::create(output,ARGV[2])
+stick.teach(ARGV[0],ARGV[1])
+output.close
+
+

data/bin/tsd

@@ -0,0 +1,68 @@
+#!/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby
+
+# ==License
+# 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/>.
+#
+# ==Description
+# Scheduled 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.
+# ==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
+#
+# 2. 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.
+#
+# 3. Copy the files devices and scheduled_actions to the sub-directory db
+#
+# 4. run ./bin/scheduled
+#
+# ==Communicating with scheduled when it is running
+# Can interact via IPC
+# ==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
+# currently swedish to schedule actions
+
+
+$LOAD_PATH.push File.join(File.dirname(__FILE__),".." ,"lib" )
+require 'tellstick'
+require 'trigger_switch_d'
+
+if $0 == __FILE__
+  file = File.open("config/config.rb","r")
+  app = TriggerSwitchD::Application.new(file)
+  file.close
+	app.start
+end

data/bin/turn_off

@@ -0,0 +1,42 @@
+#!/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 what channel/house code, unitcode and protocol/model you
+#    should use for your remote triggered device, for example:
+#
+#		    unit_code: 5
+#		    house_code: A
+#		    model_name: nexa
+#
+# 2. To turn off device, run:
+#
+#    ./bin/turn_off A 5 nexa
+
+
+$LOAD_PATH.push File.join(File.dirname(__FILE__),".." ,"lib" )
+require 'tellstick'
+
+#code to run tellstick app
+output = Tellstick::TellstickIO.new
+stick = Tellstick::create(output,ARGV[2])
+stick.turn_off(ARGV[0],ARGV[1])
+output.close
+
+
+

data/bin/turn_on

@@ -0,0 +1,39 @@
+#!/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 what channel/house code, unitcode and protocol/model you
+#    should use for your remote triggered device, for example:
+#
+#		    unit_code: 5
+#		    house_code: A
+#		    model_name: nexa
+#
+# 2. To turn on device, run:
+#
+#    ./bin/turn_on A 5 nexa
+
+
+$LOAD_PATH.push File.join(File.dirname(__FILE__),".." ,"lib" )
+require 'tellstick'
+
+#code to run tellstick app
+output = Tellstick::TellstickIO.new
+stick = Tellstick::create(output,ARGV[2])
+stick.turn_on(ARGV[0],ARGV[1])
+output.close

data/doc/classes/Tellstick/Tellstick.html

@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Tellstick::Tellstick</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Tellstick::Tellstick</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/tellstick/tellstick_rb.html">
+                lib/tellstick/tellstick.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+use create to instasiate
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>