ban 0.0.1

data/spec/ban_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Ban do
+  it 'should have a version number' do
+    Ban::VERSION.should_not be_nil
+  end
+  
+  let(:low_str) { '21588|24|322|1' }
+  let(:low_str7bit) do
+    [
+      50, 0, 49,  0, 53, 0, 56, 0, 56, 0, 124, 0, 50, 0,
+      52, 0, 124, 0, 51, 0, 50, 0, 50, 0, 124, 0, 49, 0
+    ]
+  end
+  let(:high_str) { "\xFD" }
+  let(:high_str7bit) do
+    [
+      125, 1
+    ]
+  end
+  
+  context '.decode' do
+    it 'should decode low' do
+      described_class.decode7bit(low_str7bit).should == low_str
+    end
+    
+    it 'should decode high' do
+      described_class.decode7bit(high_str7bit).should == high_str
+    end
+  end
+  
+  context '.encode' do
+    it 'should encode low' do
+      described_class.encode7bit(low_str).should == low_str7bit
+    end
+
+    it 'should encode high' do
+      described_class.encode7bit(high_str).should == high_str7bit
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+
+require 'ban'

data/src/HomeControl.ino

@@ -0,0 +1,144 @@
+#include <Firmata.h>
+#include <RCSwitch.h>
+#include <IRremote.h>
+
+// Firmata Commands
+enum Messages {
+  RECV_RC_ON   = 0x20,
+  RECV_RC_OFF  = 0x21,
+  SEND_RC      = 0x35,
+  SEND_IR      = 0x36,
+  SEND_DOOR    = 0x37,
+};
+
+// Used Pins
+enum Pins {
+  PIN_IR       = 11,
+  PIN_RC_SEND  = 8,
+  PIN_RC_RECV  = 0, // Receiver on interrupt 0 => that is pin #2
+  PIN_DOOR     = 9
+};
+
+// Door States
+enum DoorStates {
+  DOOR_OPEN    = HIGH,
+  DOOR_CLOSED  = LOW
+};
+
+// Global constants
+IRrecv irrecv(PIN_IR);
+RCSwitch rcSwitchControl = RCSwitch();
+int lastDoorState = DOOR_CLOSED;
+
+/* Extracts the switch portion of the rcAddres.
+ */
+static byte getSwitch(char* rcAddress) {
+  // Parse the switch number and if it should be turned on
+  return (rcAddress[5] - 'A') + 1;
+}
+
+/* Turns the switch on.
+ * @param rcAddress The data used to switch are in this format
+ *                  "11110A". The first five chars are the group
+ *                  of the switch the next is the switch char.
+ */
+void rcSwitchOn(char* rcAddress) {
+  byte switchNr = getSwitch(rcAddress);
+  rcAddress[5] = '\0'; // remove everything but the bit pattern
+  rcSwitchControl.switchOn(rcAddress, switchNr);
+}
+
+/* Turns the switch off.
+ * @param rcAddress The data used to switch are in this format
+ *                  "11110A". The first five chars are the group
+ *                  of the switch the next is the switch char.
+ */
+void rcSwitchOff(char* rcAddress) {
+  byte switchNr = getSwitch(rcAddress);
+  rcAddress[5] = '\0'; // remove everything but the bit pattern
+  rcSwitchControl.switchOff(rcAddress, switchNr);
+}
+
+void stringDataProxy(char* data) {
+  switch((byte)data[0]) {
+    case RECV_RC_ON:
+      rcSwitchOn(&data[1]);
+      break;
+    case RECV_RC_OFF:
+      rcSwitchOff(&data[1]);
+      break;
+    default:
+      // TODO error handling
+      break;
+  }
+}
+
+void setup()
+{
+  rcSwitchControl.enableTransmit(PIN_RC_SEND);
+  rcSwitchControl.enableReceive(PIN_RC_RECV);
+  irrecv.enableIRIn();
+
+  pinMode(PIN_DOOR, INPUT);
+
+  Firmata.setFirmwareNameAndVersion("Home Control", 1, 1);
+  Firmata.attach(STRING_DATA, stringDataProxy);
+  Firmata.begin();
+}
+
+void rcReceiveAndTransmit() {
+  if (rcSwitchControl.available()) {
+    long decimal = rcSwitchControl.getReceivedValue();
+
+    if (decimal == 0) {
+      Firmata.sendString(SEND_RC, "Error: Unknown encoding");
+    } else {
+      char instructionBuffer[70];
+      String instruction = String(decimal); // 21780
+      String sep = String('|');
+      instruction += sep;
+      instruction += String(rcSwitchControl.getReceivedBitlength()); // 24 bit
+      instruction += sep;
+      instruction += String(rcSwitchControl.getReceivedDelay()); // 322 (ms)
+      instruction += sep;
+      instruction += String(rcSwitchControl.getReceivedProtocol()); // 1
+      instruction.toCharArray(instructionBuffer, sizeof(instructionBuffer));
+      Firmata.sendSysex(SEND_RC, (byte)instruction.length(),
+                                 (byte *)instructionBuffer);
+    }
+
+    rcSwitchControl.resetAvailable();
+  }
+}
+
+void irReceiveAndTransmit() {
+  decode_results results;
+
+  if (irrecv.decode(&results)) {
+    String ircode = String(results.value);
+    char ircodeBuffer[20];
+    ircode.toCharArray(ircodeBuffer, sizeof(ircodeBuffer));
+    Firmata.sendSysex(SEND_IR, (byte)ircode.length(),
+                               (byte *)ircodeBuffer);
+    irrecv.resume();
+  }
+}
+
+void processDoorAndTransmit() {
+  int newDoorState = digitalRead(PIN_DOOR);
+
+  if (newDoorState != lastDoorState) {
+    // state of the door changed
+    Firmata.sendString(SEND_DOOR,
+      (newDoorState == DOOR_OPEN ? "OPEN" : "CLOSE"));
+    lastDoorState = newDoorState;
+  }
+}
+
+void loop()
+{
+  rcReceiveAndTransmit();
+  irReceiveAndTransmit();
+  processDoorAndTransmit();
+  while(Firmata.available()) Firmata.processInput();
+}

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: ban
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vincent Landgraf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: arduino_firmata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A home control system based on firmata
+email:
+- setcool@gmx.de
+executables:
+- ban
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ban.gemspec
+- bin/ban
+- doc/ban-layout.png
+- doc/ban-layout.svg
+- doc/ban.fzz
+- examples/client.rb
+- ino.ini
+- lib/ban.rb
+- lib/ban/board.rb
+- lib/ban/cli.rb
+- lib/ban/event.rb
+- lib/ban/events/door_event.rb
+- lib/ban/events/ir_event.rb
+- lib/ban/events/rc_event.rb
+- lib/ban/server.rb
+- lib/ban/version.rb
+- spec/ban/events/door_event_spec.rb
+- spec/ban/events/ir_event_spec.rb
+- spec/ban/events/rc_event_spec.rb
+- spec/ban_spec.rb
+- spec/spec_helper.rb
+- src/HomeControl.ino
+homepage: https://github.com/threez/ban
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Ban is a arduino firmware (based on firmata) that receives incoming remote
+  control switch commands, infrared commands, door open/close signaling and can send
+  out remote control commands also. Ban distributes all this information over a websocket.
+test_files:
+- spec/ban/events/door_event_spec.rb
+- spec/ban/events/ir_event_spec.rb
+- spec/ban/events/rc_event_spec.rb
+- spec/ban_spec.rb
+- spec/spec_helper.rb