zerbo 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+/.rvmrc
+/.bundle
+/Gemfile.lock
+/pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Tim Pope
+
+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.rdoc

@@ -0,0 +1,33 @@
+= Zerbo
+
+Interface with the Zeo Personal Sleep Coach over USB with Ruby.
+
+== Prerequisites
+
+* Depends on ruby-serialport, which is currently limited to Ruby 1.8.
+
+* Requires constructing your own USB cable.  See
+  http://zeorawdata.sourceforge.net/starting.html for details.  You may need to
+  install the drivers from http://www.ftdichip.com/Drivers/VCP.htm as well.
+
+* You may have to do some source diving, as the documentation is basically
+  limited to this file (don't worry, the source is pretty short, too).
+
+== Usage
+
+  zeo = Zerbo.connect('/dev/zeo')
+
+On OS X, the device you want can probably be found in
+<tt>/dev/tty.usbserial*</tt>.  On Linux, look at <tt>/dev/ttyUSB*</tt>.  I
+can't speak for Windows, but the Python library works there, so presumably
+Zerbo can be made to work as well.
+
+  zeo.on_sleep_stage do |stage|
+    puts stage
+  end
+
+  zeo.on_event do |event|
+    p event
+  end
+
+  zeo.run

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/zerbo.rb

@@ -0,0 +1,331 @@
+class Zerbo
+
+  class Error < RuntimeError
+  end
+
+  # Bind to a serial port.
+  def self.connect(device='/dev/zeo')
+    new(device)
+  end
+
+  attr_reader :device
+
+  def initialize(device=nil)
+    device ||= '/dev/zeo'
+    if device.respond_to?(:read)
+      @device = device
+    else
+      require 'serialport'
+      @device = SerialPort.new(device, 38400)
+      unless RUBY_PLATFORM =~ /darwin/
+        @device.read_timeout = 0
+      end
+    end
+    @callbacks = []
+  end
+
+  def next_packet
+    true until read(1) == 'A'
+    version = read(1)
+    checksum, length, inverse = read(5).unpack('Cvv')
+    raise Error, "Invalid length" unless length ^ inverse == 65535
+    raise Error, "Unsupported version #{version}" unless version == '4'
+    time, subtime, sequence = read(4).unpack('CvC')
+    data = read(length)
+    sum = 0
+    data.each_byte do |b|
+      sum += b
+    end
+    raise Error, "Invalid checksum" unless sum % 256 == checksum
+    instantiate(time, subtime, sequence, data)
+  end
+  alias next next_packet
+
+  def read(*args)
+    device.read(*args)
+  end
+  protected :read
+
+  def instantiate(time, subtime, sequence, data)
+    type, rest = data.unpack('Ca*')
+    if type.zero?
+      type, rest = rest.unpack('Ca*')
+    end
+    klass = DATA_TYPE_CLASSES.detect {|c| c.id == type}
+    klass.new(self, time, subtime, sequence, rest)
+  end
+  protected :instantiate
+
+  def add_callback(klass = Object, &block)
+    @callbacks << [klass, block]
+    self
+  end
+
+  def on_event(&block)
+    add_callback(Event, &block)
+  end
+
+  def on_sleep_stage(&block)
+    add_callback(SleepStage, &block)
+  end
+
+  def run
+    loop do
+      packet = next_packet
+      @callbacks.each do |(klass, block)|
+        if packet.kind_of?(klass)
+          block.call(packet)
+        end
+      end
+    end
+  end
+
+  def inspect
+    "#<#{self.class.inspect} #{device.inspect}>"
+  end
+
+  protected
+
+
+  DATA_TYPE_CLASSES = []
+
+  class Packet
+
+    def self.inherited(klass)
+      DATA_TYPE_CLASSES << klass
+    end
+
+    class <<self
+      attr_accessor :id
+    end
+
+    attr_reader :owner, :type, :sequence, :data
+
+    def type
+      self.class.id
+    end
+
+    def initialize(owner, time, subtime, sequence, data)
+      @owner = owner
+      @sequence = sequence
+      @data = data
+    end
+
+    def guess_length
+      data.index('A')
+    end
+
+    def to_i
+      if data.length == 2
+        unpack('v').first
+      elsif data.length == 4
+        unpack('V').first
+      else
+        raise NotImplementedError
+      end
+    end
+
+    def inspect
+      format_inspect((to_i || data).inspect)
+    end
+
+    protected
+
+    def unpack(arg)
+      @data.unpack(arg)
+    end
+
+    def format_inspect(custom)
+      "#<#{self.class.inspect}(#{sequence}) #{custom}>"
+    end
+
+  end
+
+  class SliceEnd < Packet
+    self.id = 0x02
+  end
+
+  class Version < Packet
+    self.id = 0x03
+  end
+
+  class Waveform < Packet
+    self.id = 0x80
+    undef to_i
+
+    def raw
+      data.unpack('v128').map do |v|
+        v > 0x7fff ? -0x10000 ^ v : v
+      end
+    end
+
+    def filtered
+      unless @filtered
+        # blindly stolen from the Python library.
+        filter = [
+          0.0056, 0.0190, 0.0113, -0.0106, 0.0029, 0.0041,
+          -0.0082, 0.0089, -0.0062, 0.0006, 0.0066, -0.0129,
+          0.0157, -0.0127, 0.0035, 0.0102, -0.0244, 0.0336,
+          -0.0323, 0.0168, 0.0136, -0.0555, 0.1020, -0.1446,
+          0.1743, 0.8150, 0.1743, -0.1446, 0.1020, -0.0555,
+          0.0136, 0.0168, -0.0323, 0.0336, -0.0244, 0.0102,
+          0.0035, -0.0127, 0.0157, -0.0129, 0.0066, 0.0006,
+          -0.0062, 0.0089, -0.0082, 0.0041, 0.0029, -0.0106,
+          0.0113, 0.0190, 0.0056
+        ]
+        p = raw.length
+        q = filter.length
+        n = p + q - 1
+        @filtered = []
+        n.times do |k|
+          t = 0
+          lower = [0, k-(q-1)].max
+          upper = [p-1, k].min
+          lower.upto(upper) do |i|
+            t = t + raw[i] * filter[k-i]
+          end
+          @filtered << (t*1e6).round/1e6
+        end
+      end
+      @filtered
+    end
+
+    def to_a
+      filtered[90...218]
+    end
+
+    def inspect
+      format_inspect(raw.inspect[1..-2])
+    end
+  end
+
+  class FrequencyBins < Packet
+    self.id = 0x83
+    undef to_i
+
+    def to_a
+      unpack('v7')
+    end
+
+    def inspect
+      format_inspect(to_a.inspect[1..-2])
+    end
+  end
+
+  class SQI < Packet
+    self.id = 0x84
+  end
+
+  class ZeoTimeStamp < Packet
+    self.id = 0x8a
+
+    def to_time
+      Time.at(to_i).utc
+    end
+
+    def to_s
+      to_time.strftime('%Y-%m-%dT%H:%M:%S')
+    end
+
+    def inspect
+      format_inspect(to_s)
+    end
+  end
+
+  class Impedence < Packet
+    self.id = 0x97
+  end
+
+  class BadSignal < Packet
+    self.id = 0x9c
+
+    def to_b
+      !to_i.zero?
+    end
+
+    def inspect
+      format_inspect(to_b)
+    end
+  end
+
+  class SleepStage < Packet
+    self.id = 0x9d
+
+    LOOKUP = [
+      'Undefined',
+      'Awake',
+      'REM',
+      'Light',
+      'Deep'
+    ]
+
+    def to_s
+      LOOKUP[to_i]
+    end
+
+    def inspect
+      format_inspect(to_s)
+    end
+
+    def awake?
+      to_s == 'Awake'
+    end
+
+    def asleep?
+      rem? || light? || deep?
+    end
+
+    def rem?
+      to_s == 'REM'
+    end
+
+    def light?
+      to_s == 'Light'
+    end
+
+    def deep?
+      to_s == 'Deep'
+    end
+  end
+
+  class Event < Packet
+    self.id = 0x00
+  end
+
+  class NightStart < Event
+    self.id = 0x05
+  end
+
+  class SleepOnset < Event
+    self.id = 0x07
+  end
+
+  class HeadbandDocked < Event
+    self.id = 0x0e
+  end
+
+  class HeadbandUnDocked < Event
+    self.id = 0x0f
+  end
+
+  class AlarmOff < Event
+    self.id = 0x10
+  end
+
+  class AlarmSnooze < Event
+    self.id = 0x11
+  end
+
+  class AlarmPlay < Event
+    self.id = 0x13
+  end
+
+  class NightEnd < Event
+    self.id = 0x15
+  end
+
+  class NewHeadband < Event
+    self.id = 0x24
+  end
+
+end

data/lib/zerbo/version.rb

@@ -0,0 +1,3 @@
+module Zerbo
+  VERSION = "0.0.1"
+end

data/zerbo.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "zerbo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "zerbo"
+  s.version     = Zerbo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tim Pope"]
+  s.email       = "ruby@tpo"+'pe.org'
+  s.homepage    = "http://github.com/tpope/zerbo"
+  s.summary     = "Zeo Personal Sleep Coach Ruby Interface"
+  s.description = "Build a serial cable for your Zeo and interface with it with this library."
+
+  s.rubyforge_project = "zerbo"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("ruby-serialport")
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: zerbo
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tim Pope
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-serialport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Build a serial cable for your Zeo and interface with it with this library.
+email: ruby@tpope.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/zerbo.rb
+- lib/zerbo/version.rb
+- zerbo.gemspec
+has_rdoc: true
+homepage: http://github.com/tpope/zerbo
+licenses: []
+
+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: zerbo
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Zeo Personal Sleep Coach Ruby Interface
+test_files: []
+