nabaztag 0.2.2

data/README.rdoc

@@ -0,0 +1,26 @@
+rake build
+
+gem install pkg/*.gem
+
+MacBook-Air ~/Projects/nabaztag[master*]$ nabaztag ears
+---> check ears...            http://api.nabaztag.com/vl/FR/api.jsp?ears=ok&sn=0C&token=137
+13 (0.1s)
+
+MacBook-Air ~/Projects/nabaztag[master*]$ nabaztag ears 0 10
+---> move ears...             http://api.nabaztag.com/vl/FR/api.jsp?posleft=0&posright=10&sn=0C&token=137
+#<Nabaztag::Response:0x102334598> (0.1s)
+
+cat ~/.nabaztag 
+NABAZTAG_MAC = '0XXXXXXXXXCC'
+NABAZTAG_TOKEN = '1XXXXXXX7'
+
+
+-----------------------------------------------------------------------------------------------------------------------------
+
+Hybrid of
+
+http://github.com/lukeredpath/nabaztag-ruby/tree/master/bin/
+
+and
+
+http://adamblog.heroku.com/past/2009/8/28/sumo_oneoff_ec2_instance_lanching/

data/Rakefile

@@ -0,0 +1,18 @@
+require 'jeweler'
+
+Jeweler::Tasks.new do |s|
+	s.name = "nabaztag"
+	s.description = %q{nabaztag commandline}
+	s.summary = s.description
+	s.author = "ELC"
+	s.email = "info@elctech.com"
+	s.homepage = "http://github.com/elcgit/nabaztag"
+	s.rubyforge_project = "nabaztag"
+	s.files = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]
+	s.executables = %w(nabaztag)
+	s.add_dependency "thor"
+end
+Jeweler::GemcutterTasks.new
+
+task :default => :release
+

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/bin/nabaztag

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/nabaztag'
+
+require 'thor'
+
+require 'nabaztag'
+load ENV['HOME'] + '/.nabaztag'
+
+class CLI < Thor
+	desc "ears [left] [right]", "move ears to position left,right (0-16) or omit to read positions"
+	def ears(left=nil, right=nil)
+		# id = task("Launch instance") { elc.launch }
+		# host = task("Acquire hostname") { elc.wait_for_hostname(id) }
+		if(left)
+      task("move ears") { nabaztag.move_ears!(left, right) }
+    else
+      task("check ears") { nabaztag.ear_positions }
+    end
+	end
+  def say(text)
+    task("say text") {nabaztag.say!(text)}
+  end
+
+=begin
+	desc "list", "list running instances"
+	def list
+		elc.list.each do |inst|
+			printf "%-50s %-12s %s\n", inst[:hostname], inst[:instance_id], inst[:status]
+		end
+	end
+
+	desc "detach [<volume_id>]", "detach volume from instance"
+	def detach(volume=nil)
+		vol_id = (elc.find_volume(volume) || elc.attached_volumes.first || abort("No attached volumes"))[:volume_id]
+		task("Detach #{vol_id}") { elc.detach(vol_id) }
+	end
+=end
+
+	no_tasks do
+		def nabaztag
+			@nabaztag ||= Nabaztag.new(NABAZTAG_MAC, NABAZTAG_TOKEN)
+		end
+
+		def task(msg, &block)
+			# printf "---> %-24s ", "#{msg}..."
+			start = Time.now
+			result = block.call || 'done'
+			finish = Time.now
+			time = sprintf("%0.1f", finish - start)
+			# puts "#{result} (#{time}s)"
+			result
+		end
+	end
+end
+
+CLI.start

data/lib/nabaztag.rb

@@ -0,0 +1,160 @@
+require 'nabaztag/message'
+require 'nabaztag/response'
+require 'nabaztag/choreography'
+
+#
+# Nabaztag allows control of the text-to-speech, ear control, and choreography features of
+# Nabaztag devices.
+#
+# To use this library, you need to know the MAC of the device (written on the base) and its
+# API token. The token must be obtained from http://www.nabaztag.com/vl/FR/api_prefs.jsp .
+#
+# The API allows different commands to be dispatched simultaneously; in order to achieve this,
+# this library queues commands until they are sent.
+#
+# E.g.
+#   nabaztag = Nabaztag.new(mac, token)
+#   nabaztag.say('bonjour')   # Nothing sent yet
+#   nabaztag.move_ears(4, 4)  # Still not sent
+#   nabaztag.send             # Messages sent
+#
+# This also means that if two conflicting commands are issued without an intervening send,
+# only the latter will be carried out.
+#
+# However, beware! The API doesn't seem to respond well if multiple commands are sent in
+# a short period of time: it can become confused and send erroneous commands to the device.
+#
+# In addition, the choreography command does not seem to play well with other commands: if
+# text-to-speech and choreography are sent in one request, only the speech will get through
+# to the rabbit.
+#
+# With version 2 of the API, it is now possible to specify a voice for the message. The
+# default is determined by the rabbit's language (claire22s for French; heather22k for
+# English). The voice's language overrides that of the rabbit: i.e. a French rabbit will
+# speak in English when told to use an English voice.
+#
+# The known voices are grouped by language in the Nabaztag::VOICES constant, but no attempt
+# is made to validate against this list, as Violet may introduce additional voices in future.
+#
+class Nabaztag
+
+  class ServiceError < RuntimeError ; end
+
+  attr_reader :mac, :token, :message
+  attr_accessor :voice
+
+  #
+  # Create a new Nabaztag instance to communicate with the device with the given MAC address and
+  # service token (see class overview for explanation of token).
+  #
+  def initialize(mac, token)
+    @mac, @token = mac, token
+    @message = new_message
+    @ear_positions = [nil, nil]
+  end
+  
+  #
+  # Send all pending messages
+  #
+  def send
+    @message.voice = voice
+    response = @message.send
+    @message = new_message
+    unless response.success?
+      raise ServiceError, response.raw
+    end
+    return response
+  end
+
+  #
+  # Send a message immediately to get the ear positions.
+  #
+  def ear_positions
+    ear_message = new_message
+    ear_message.ears = 'ok'
+    response = ear_message.send
+    return [response.left_ear, response.right_ear]
+  end
+
+  #
+  # Say text.
+  #
+  def say(text)
+    message.tts = text
+    nil
+  end
+
+  #
+  # Say text immediately.
+  #
+  def say!(text)
+    say(text)
+    send
+  end
+
+  #
+  # Make the rabbit bark.
+  #
+  def bark
+    say('ouah ouah')
+    nil
+  end
+
+  #
+  # Bark immediately.
+  #
+  def bark!
+    bark
+    send
+  end
+
+  #
+  # Set the position of the left and right ears between 0 and 16. Use nil to avoid moving an ear.
+  # Note that these positions are not given in degrees, and that it is not possible to specify the
+  # direction of movement. For more precise ear control, use choreography instead.
+  #
+  def move_ears(left, right)
+    message.posleft = left if left
+    message.posright = right if right
+    nil
+  end
+
+  #
+  # Move ears immediately.
+  #
+  def move_ears!(left, right)
+    move_ears(left, right)
+    send
+  end
+
+  #
+  # Creates a new choreography message based on the actions instructed in the block. The commands
+  # are evaluated in the context of a new Choreography instance.
+  #
+  # E.g.
+  #  nabaztag.choreography do
+  #    together { led :middle, :green ; led :left, :red }
+  #    led :right, :yellow
+  #    together { led :left, :off ; led :right, :off}
+  #    ...
+  #  end
+  #
+  def choreography(title=nil, &blk)
+    message.chortitle = title
+    message.chor = Choreography.new(&blk).build
+    nil
+  end
+
+  #
+  # Creates choreography and sends it immediately.
+  #
+  def choreography!(title=nil, &blk)
+    choreography(title, &blk)
+    send
+  end
+
+  def new_message
+    return Message.new(mac, token)
+  end
+
+end

data/lib/nabaztag/choreography.rb

@@ -0,0 +1,119 @@
+class Nabaztag
+
+  #
+  # The Choreography class uses class methods to implement a simple DSL. These build API choreography
+  # messages based on instructions to move the ears and light the LEDs.
+  #
+  class Choreography
+
+    LED_COLORS = {
+      :red          => [255,   0,   0],
+      :orange       => [255, 127,   0],
+      :yellow       => [255, 255,   0],
+      :green        => [  0, 255,   0],
+      :blue         => [  0,   0, 255],
+      :purple       => [255,   0, 255],
+      :dim_red      => [127,   0,   0],
+      :dim_orange   => [127,  63,   0],
+      :dim_yellow   => [127, 127,   0],
+      :dim_green    => [  0, 127,   0],
+      :dim_blue     => [  0,   0, 127],
+      :dim_purple   => [127,   0, 127],
+      :off          => [  0,   0,   0]
+    }
+    EARS = {:left => [1], :right => [0], :both => [0,1]}
+    LEDS = {:bottom => 0, :left => 1, :middle => 2, :right => 3, :top => 4}
+    EAR_DIRECTIONS = {:forward => 0, :backward => 1}
+    
+    def initialize(&blk)
+      @messages = []
+      @tempo = 10
+      @time_stamp = 0
+      instance_eval(&blk) if block_given?
+    end
+
+    def build
+      return (['%d' % @tempo] + @messages).join(',')
+    end
+
+    #
+    # Set the tempo of the choreography in Hz (i.e. events per secod). The default is 10
+    # events per second.
+    #
+    def tempo(t)
+      @tempo = t
+    end
+
+    #
+    # Move :left, :right, or :both ears to angle degrees (0-180) in direction
+    # :forward (default) or :backward.
+    #
+    def ear(which_ear, angle, direction=:forward)
+      direction_number = EAR_DIRECTIONS[direction]
+      EARS[which_ear].each do |ear_number|
+        append_message('motor', ear_number, angle, 0, direction_number)
+      end
+      advance
+    end
+
+    #
+    # Change colour of an led (:top, :right:, middle, :left, :bottom) to a specified colour.
+    # The colour may be specified either as RGB values (0-255) or by using one of the named colours
+    # in LED_COLORS.
+    #
+    # E.g.
+    #  led :middle, :red
+    #  led :top, 0, 0, 255
+    #  led :bottom, :off
+    #
+    def led(which_led, c1, c2=nil, c3=nil)
+      led_number = LEDS[which_led]
+      if (c1 && c2 && c3)
+        red, green, blue = c1, c2, c3
+      else
+        red, green, blue = LED_COLORS[c1]
+      end
+      append_message('led', led_number, red, green, blue)
+      advance
+    end
+
+    #
+    # Group several actions into a single chronological step via a block.
+    #
+    # E.g.
+    #  event { led :top, :yellow ; ear :both, 0 }
+    #
+    def event(duration=1, &blk)
+      length(duration, &blk)
+    end
+    
+    alias_method :together, :event
+
+    #
+    # Perform one or more actions for n chronological steps
+    #
+    # E.g.
+    #  length 3 do
+    #    led :top, :red ; led :middle, :yellow
+    #  end
+    #
+    def length(duration, &blk)
+      old_in_event = @in_event
+      @in_event = true
+      yield
+      @in_event = old_in_event
+      advance duration
+    end
+
+  private
+
+    def append_message(*params)
+      @messages << ("%d,%s,%d,%d,%d,%d" % ([@time_stamp] + params))
+    end
+
+    def advance(duration=1)
+      @time_stamp += duration unless @in_event
+    end
+
+  end
+end

data/lib/nabaztag/message.rb

@@ -0,0 +1,75 @@
+require 'cgi'
+require 'iconv'
+require 'open-uri'
+require 'nabaztag/response'
+
+class Nabaztag
+  class Message
+
+    SERVICE_ENCODING = 'iso-8859-1'
+    API_URI = 'http://api.nabaztag.com/vl/FR/api.jsp?'
+    FIELDS = [
+      :idmessage, :posright, :posleft, :idapp, :tts, :chor, :chortitle, :ears, :nabcast, 
+      :ttlive, :voice, :speed, :pitch, :action
+    ]
+    ACTIONS = {
+      :preview         =>  1,
+      :friend_list     =>  2,
+      :list_messages   =>  3,
+      :get_timezone    =>  4,
+      :get_signature   =>  5,
+      :get_blacklist   =>  6,
+      :get_sleep_state =>  7,
+      :get_version     =>  8,
+      :get_voices      =>  9,
+      :get_name        => 10,
+      :get_languages   => 11,
+      :preview_message => 12,
+      :sleep           => 13,
+      :wake            => 14
+    }
+
+    FIELDS.each do |field|
+      attr_accessor field
+    end
+
+    def initialize(mac, token)
+      @mac, @token = mac, token
+      @expected_identifiers = []
+    end
+    
+    def send
+      puts request_uri
+      Response.new(open(request_uri){ |io| io.read })
+    end
+    
+    def expect(identifier)
+      @expected_identifiers << identifier
+    end
+    
+    def action=(name)
+      @action = ACTIONS[name] or raise "unknown action #{name}"
+    end
+
+  private
+
+    def request_uri
+      API_URI + parameters.sort_by{ |k,v| k.to_s }.map{ |k,v|
+        value = CGI.escape(v.to_s)
+        "#{k}=#{value}"
+      }.join('&')
+    end
+    
+    def parameters
+      FIELDS.inject({
+        :sn => @mac,
+        :token => @token
+      }){ |hash, element|
+        value = __send__(element)
+        hash[element] = value if value
+        hash
+      }
+    end
+
+  end
+end

data/lib/nabaztag/response.rb

@@ -0,0 +1,78 @@
+require 'rexml/document'
+
+class Nabaztag
+  class Response
+    include REXML
+
+    ERROR_MESSAGES = /^NO|^ABUSE|NOTSENT$/
+
+    attr_reader :raw
+
+    def initialize(xml)
+      @raw = xml
+      @doc = Document.new(xml)
+    end
+
+    def messages
+      lookup('/rsp/message')
+    end
+
+    def comments
+      lookup('/rsp/comment')
+    end
+
+    def friends
+      lookup('/rsp/friend@name')
+    end
+
+    def timezone
+      lookup('/rsp/timezone').first
+    end
+
+    def rabbit_version
+      lookup('/rsp/rabbitVersion').first
+    end
+
+    def rabbit_name
+      lookup('/rsp/rabbitName').first
+    end
+
+    def voices
+      XPath.match(@doc, '/rsp/voice').inject({}){ |h, n|
+        lang    = n.attributes['lang']
+        command = n.attributes['command']
+        (h[lang] ||= []) << command
+        h
+      }
+    end
+
+    def languages
+      lookup('/rsp/myLang@lang')
+    end
+
+    def left_ear
+      position = lookup('/rsp/leftposition').first
+      position && position.to_i
+    end
+
+    def right_ear
+      position = lookup('/rsp/rightposition').first
+      position && position.to_i
+    end
+    
+    def signature
+      lookup('/rsp/signature')
+    end
+
+    def success?
+      !messages.any?{ |m| m =~ ERROR_MESSAGES }
+    end
+
+  private
+
+    def lookup(xpath)
+      XPath.match(@doc, xpath).map{ |n| n.text }
+    end
+
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: nabaztag
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- ELC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-12 00:00:00 +00:00
+default_executable: nabaztag
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: nabaztag commandline
+email: info@elctech.com
+executables: 
+- nabaztag
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/nabaztag
+- lib/nabaztag.rb
+- lib/nabaztag/choreography.rb
+- lib/nabaztag/message.rb
+- lib/nabaztag/response.rb
+has_rdoc: true
+homepage: http://github.com/elcgit/nabaztag
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: nabaztag
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: nabaztag commandline
+test_files: []
+