belphanior-2412n-servant 0.0.2

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/belphanior/servant/homenetwork/insteon_2412n_insteon_codec.rb

@@ -0,0 +1,70 @@
+# Copyright 2012 Mark T. Tomczak
+
+module Belphanior
+  module Servant
+    module HomeNetwork
+      class Insteon_2412n_Insteon_Codec
+        class BadCode < RuntimeError
+        end
+        COMMAND_CODE_TABLE = {
+          :on => "11",
+          :fast_on => "12",
+          :off => "13",
+          :fast_off => "14",
+        }
+        BRIGHTNESS_CODE_LIST = [
+          [0, "00"],
+          [0.1, "19"],
+          [0.25, "40"],
+          [0.5, "7F"],
+          [0.75, "BF"],
+          [0.9, "E6"],
+          [1, "FF"]
+        ]
+        INSTEON_PREFIX = "0262"
+
+        def initialize(marshaller)
+          @marshaller = marshaller
+        end
+
+        def device_on(address)
+          send_command(address, :fast_on, "FF")
+        end
+
+        def device_off(address)
+          send_command(address, :fast_off, "FF")
+        end
+
+        # Set the brightness level.
+        # address: 6-hexcode address of INSTEON device.
+        # brightness: float value between 0 and 1
+        def device_set_brightness(address, brightness)
+          send_command(address, :on, brightness_value_to_code(brightness))
+        end
+       private
+
+        # sends command to device specified by address.
+        def send_command(address, command, brightness_code)
+          @marshaller.send(INSTEON_PREFIX + address + "0F" +
+            COMMAND_CODE_TABLE[command] + brightness_code)
+        end
+
+        def brightness_value_to_code(brightness)
+          if brightness < 0 then
+            brightness = 0
+          end
+          if brightness > 1 then
+            brightness = 1
+          end
+          BRIGHTNESS_CODE_LIST.each do |codepair|
+            if brightness <= codepair[0] then
+              return codepair[1]
+            end
+          end
+          return "FF"
+        end
+
+      end
+    end
+  end
+end

data/lib/belphanior/servant/homenetwork/insteon_2412n_marshaller.rb

@@ -0,0 +1,30 @@
+# Marshaller for the Insteon 2412N home automation server
+require 'net/http'
+
+module Belphanior
+  module Servant
+    module HomeNetwork
+      class Insteon_2412n_Marshaller
+        attr_accessor :host
+        class ConnectionFailure < RuntimeError
+        end
+        def initialize(host, network_class=nil)
+          @host = host
+          if network_class
+            @network_class = network_class
+          else
+            @network_class = Net::HTTP
+          end
+        end
+        def send(command)
+          @network_class.start(@host, 80) {|http|
+            # I don't know what the prefix and suffix here mean;
+            # they were determined empirically by examining the output
+            # from the 2412N's built-in web GUI
+            http.post("/3?"+command+"=I=3", "")
+          }
+        end
+      end
+    end
+  end
+end

data/lib/belphanior/servant/homenetwork/insteon_2412n_x10_codec.rb

@@ -0,0 +1,81 @@
+module Belphanior
+  module Servant
+    module HomeNetwork
+      class Insteon_2412n_x10_Codec
+        class BadCode < RuntimeError
+        end
+        HOUSE_CODE_TABLE = {
+          "A"=>"6", "B"=>"E", "C"=>"2", "D"=>"A",
+          "E"=>"1", "F"=>"9", "G"=>"5", "H"=>"D",
+          "I"=>"7", "J"=>"F", "K"=>"3", "L"=>"B",
+          "M"=>"0", "N"=>"8", "O"=>"4", "P"=>"C",
+        }
+        UNIT_CODE_TABLE = {
+          "1"=>"6", "2"=>"E", "3"=>"2", "4"=>"A",
+          "5"=>"1", "6"=>"9", "7"=>"5", "8"=>"D",
+          "9"=>"7", "10"=>"F", "11"=>"3", "12"=>"B",
+          "13"=>"0", "14"=>"8", "15"=>"4", "16"=>"C",
+        }
+        COMMAND_CODE_TABLE = {
+          :all_on => "6",
+          :on => "2",
+          :brighter => "5",
+          :off => "3",
+          :all_off => "0",
+          :dimmer => "4",
+        }
+        X10_PREFIX = "0263"
+        ADDRESS_SUFFIX = "00"
+        COMMAND_SUFFIX = "80"
+
+        def initialize(marshaller)
+          @marshaller = marshaller
+        end
+
+        def device_on(identifier)
+          send_command(identifier, :on)
+        end
+
+        def device_off(identifier)
+          send_command(identifier, :off)
+        end
+        
+        def device_brighter(identifier)
+          send_command(identifier, :brighter)
+        end
+
+        def device_dimmer(identifier)
+          send_command(identifier, :dimmer)
+        end
+        private
+
+        # sends command to device specified by house and unit string
+        def send_command(house_and_unit, command)
+          house_code, unit_code = select_code(house_and_unit)
+          @marshaller.send(X10_PREFIX + house_code + unit_code + ADDRESS_SUFFIX)
+          @marshaller.send(X10_PREFIX + house_code + COMMAND_CODE_TABLE[command] +
+                           COMMAND_SUFFIX)
+        end
+
+        # Converts house, unit code string to hex command string
+        def select_code(house_and_unit)
+          if not house_and_unit.length <= 3
+            raise BadCode,
+            "Code should be three characters or less."
+          end
+          house = house_and_unit[0..0]
+          unit = house_and_unit[1..2]
+          if not HOUSE_CODE_TABLE.has_key? house
+            raise BadCode,
+            "House code was '" << house << "', must be between 'A' and 'P'"
+          end
+          if not UNIT_CODE_TABLE.has_key? unit
+            raise BadCode,
+            "Unit code was '" << unit << "', must be between '1' and '16'"
+          end
+          [HOUSE_CODE_TABLE[house], UNIT_CODE_TABLE[unit]]
+        end
+      end
+    end
+  end
+end

data/lib/belphanior/servant/homenetwork/test/tc_insteon_2412n_codec.rb

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'belphanior/servant/homenetwork/insteon_2412n_x10_codec'
+require 'test/unit'
+require 'mocha'
+
+
+# Test of X10 code generator for Insteon 2412N central controller
+
+class TestInsteon_2412N_X10_Codec < Test::Unit::TestCase
+  def setup
+    @marshaller = mock(
+      'Belphanior::Servant::HomeNetwork::Insteon_2412n_Marshaller')
+    @codec = Belphanior::Servant::HomeNetwork::Insteon_2412n_x10_Codec.new(
+      @marshaller)
+  end
+
+  def test_house_codes
+    # map from house codes to hex names
+    house_code_table = {
+      "A"=>"6", "B"=>"E", "C"=>"2", "D"=>"A",
+      "E"=>"1", "F"=>"9", "G"=>"5", "H"=>"D",
+      "I"=>"7", "J"=>"F", "K"=>"3", "L"=>"B",
+      "M"=>"0", "N"=>"8", "O"=>"4", "P"=>"C",
+    }
+    unit_1_code = "6"
+    house_code_table.each do |key, value|
+      cur_sequence = sequence(key)
+      @marshaller.expects(:send).with(
+        "0263"+value+unit_1_code+"00").in_sequence(cur_sequence)
+      @marshaller.expects(:send).in_sequence(cur_sequence)
+      @codec.device_on(key+"1")
+    end
+  end
+  def test_unit_codes
+    # map from house codes to hex names
+    unit_code_table = {
+      "1"=>"6", "2"=>"E", "3"=>"2", "4"=>"A",
+      "5"=>"1", "6"=>"9", "7"=>"5", "8"=>"D",
+      "9"=>"7", "10"=>"F", "11"=>"3", "12"=>"B",
+      "13"=>"0", "14"=>"8", "15"=>"4", "16"=>"C",
+    }
+    house_a_code = "6"
+    unit_code_table.each do |key, value|
+      cur_sequence = sequence(key)
+      @marshaller.expects(:send).with(
+        "0263"+house_a_code+value+"00").in_sequence(cur_sequence)
+      @marshaller.expects(:send).in_sequence(cur_sequence)
+      @codec.device_on("A"+key)
+    end
+  end
+  def test_command_codes
+    code_segments = [
+                     "2",  # on
+                     "5",  # brighter
+                     "3",  # off
+                     "4",  # dimmer
+                     ]
+    house_a_code = "6"
+    cur_sequence = sequence("command codes")
+    code_segments.each do |code|
+      @marshaller.expects(:send).in_sequence(cur_sequence)
+      @marshaller.expects(:send).with("0263" + house_a_code + 
+        code + "80").in_sequence(cur_sequence)
+    end
+    @codec.device_on("A1")
+    @codec.device_brighter("A1")
+    @codec.device_off("A1")
+    @codec.device_dimmer("A1")
+  end
+end

data/lib/belphanior/servant/homenetwork/test/tc_insteon_2412n_insteon_codec.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'belphanior/servant/homenetwork/insteon_2412n_insteon_codec'
+require 'test/unit'
+require 'mocha'
+
+
+# Test of INSTEON code generator for Insteon 2412N central controller
+
+class TestInsteon_2412N_Insteon_Codec < Test::Unit::TestCase
+  def setup
+    @marshaller = mock(
+      'Belphanior::Servant::HomeNetwork::Insteon_2412n_Marshaller')
+    @codec = Belphanior::Servant::HomeNetwork::Insteon_2412n_Insteon_Codec.new(
+      @marshaller)
+    @insteon_prefix = "0262"
+  end
+
+  def test_on_off
+    address = "001122"
+    fast_on_code = "12"
+    fast_off_code = "14"
+    @marshaller.expects(:send).with(
+      @insteon_prefix + address + "0F" + fast_on_code + "FF")
+    @codec.device_on(address)
+  end
+
+  def test_brightness
+    address = "001122"
+    on_code = "11"
+    @marshaller.expects(:send).with(
+      @insteon_prefix + address + "0F" + on_code + "00")
+    @codec.device_set_brightness(address, 0)
+
+    @marshaller.expects(:send).with(
+      @insteon_prefix + address + "0F" + on_code + "FF")
+    @codec.device_set_brightness(address, 1)
+
+    # Exact equality
+    @marshaller.expects(:send).with(
+      @insteon_prefix + address + "0F" + on_code + "7F")
+    @codec.device_set_brightness(address, 0.5)
+
+    # Near-equality
+    @marshaller.expects(:send).with(
+      @insteon_prefix + address + "0F" + on_code + "7F")
+    @codec.device_set_brightness(address, 0.4)
+
+    # Out of bounds
+    @marshaller.expects(:send).with(
+      @insteon_prefix + address + "0F" + on_code + "00")
+    @codec.device_set_brightness(address, -1)
+
+    @marshaller.expects(:send).with(
+      @insteon_prefix + address + "0F" + on_code + "FF")
+    @codec.device_set_brightness(address, 1.5)
+  end
+end

data/lib/belphanior/servant/homenetwork/test/tc_insteon_2412n_marshaller.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'belphanior/servant/homenetwork/insteon_2412n_marshaller'
+require 'test/unit'
+require 'mocha'
+
+
+class TestInsteon_2412N_Marshaller < Test::Unit::TestCase
+  def setup
+    @netmock = mock('Net::HTTP')
+    @requestmock = mock()
+    @marshaller =
+      Belphanior::Servant::HomeNetwork::Insteon_2412n_Marshaller.new(
+      'localhost', @netmock)
+  end
+  def test_send
+    input = "02636600"
+    @netmock.expects(:start).with('localhost',80).yields(@requestmock)
+    @requestmock.expects(:post).with("/3?"+input+"=I=3","")
+    @marshaller.send(input)
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: belphanior-2412n-servant
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Mark T. Tomczak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: belphanior-servant
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id001
+description: "    The Belphanior 2412n servant interfaces to a Smarthome 2412n SmartLinc controller\n    (http://www.smarthome.com/2412N/SmartLinc-INSTEON-Central-Controller/p.aspx). It can\n    be used to send commands directly to the controller to switch lights and appliances\n    on and off and control brightness and intensity.\n"
+email: belphanior+2412n-servant@fixermark.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- lib/belphanior/servant/homenetwork/insteon_2412n_marshaller.rb
+- lib/belphanior/servant/homenetwork/insteon_2412n_x10_codec.rb
+- lib/belphanior/servant/homenetwork/insteon_2412n_insteon_codec.rb
+- lib/belphanior/servant/homenetwork/test/tc_insteon_2412n_codec.rb
+- lib/belphanior/servant/homenetwork/test/tc_insteon_2412n_insteon_codec.rb
+- lib/belphanior/servant/homenetwork/test/tc_insteon_2412n_marshaller.rb
+homepage: http://belphanior.net
+licenses: 
+- http://www.apache.org/licenses/LICENSE-2.0.txt
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Control an x10 or INSTEON system using the Belphanior home-network protocol and a Smarthome 2412n SmartLinc central controller.
+test_files: 
+- lib/belphanior/servant/homenetwork/test/tc_insteon_2412n_codec.rb
+- lib/belphanior/servant/homenetwork/test/tc_insteon_2412n_insteon_codec.rb
+- lib/belphanior/servant/homenetwork/test/tc_insteon_2412n_marshaller.rb