nabaztag_hack_kit 0.1.0.beta3 → 0.1.0.beta8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd395348ad5c455b3587202f9fbf9782259cf829
+  data.tar.gz: e23d930933234912c081a5425003577a0db51fd2
+SHA512:
+  metadata.gz: 896a8d1f950033dfa49494747a982a3c58fa4ac92565e44725effbaecdce2c39ac46b73a12a8975eeab9f0c7f34df1550577e69705cdcbdc8c43eb953e6643be
+  data.tar.gz: 14abe18bd4b1502a7682aa5b5c24c579dfc51b36bcdc3d3bd290bd500407fb80fa686bfc47d4ee8d2beb2631b725d7b6af039c7b75e9bcf47a970721eb023c19

data/.gitignore

@@ -5,5 +5,10 @@ pkg/*
 .rvmrc
 *.bin
 *.o
-examples/record/config.ru
-.mtlrc
+.mtlrc
+examples/*/vendor/
+compiler/osx/mtl_comp
+compiler/osx/mtl_simu
+vendor/bundle
+compiler/osx/vcomp
+dumpbc.c

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ext/mtl_linux"]
+	path = ext/mtl_linux
+	url = https://github.com/rngtng/mtl_linux.git

data/.travis.yml

@@ -1,3 +1,3 @@
 rvm:
-  - 1.9.2
-script: "bundle exec rake spec"
+  - 2.2.2
+script: "bundle exec rspec"

data/CHANGELOG.md

@@ -1,10 +1,25 @@
 # Changes
 
+## v0.2.1 - 18-09-2016
+
+  * pulled in mac os x support by @ztalbot2000 28-06-2014
+    * fixed all compile warnings
+    * Added -m32 compile option
+    * fixed segfault when running mtl_comp with invalid args
+    * Changed output so size is CAPITAL hex value to make absolutely no
+      differences when comparing compiled .mtl file and original bc.jsp file
+
+## v0.1.1 - 17-09-2016
+
+  * file cleanup fix spelling
+  * update readme on how to use/run examples
+  * proper usage of bundler
+
 ## v0.1.0 - xx-09-2012
 
-  * files restructured, speration byte & ruby code
+  * files restructured, separation byte & ruby code
   * update server for generic structure, added callback
-  * mtl binaires respect defaults from local `.mtlrc` file
+  * mtl binaries respect defaults from local `.mtlrc` file
 
 ## v0.0.2 - 29-01-2012
 

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tobias Bielohlawek
+
+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.md

@@ -1,53 +1,112 @@
 # Nabaztag Hack Kit
 
-Everything you need to hack the Rabbit: a sinatra server including simple api framework to run custom bytecode on Nabaztag v1/v2. Includes original compiler sources for linux.
+Everything you need to hack the Rabbit: a sinatra server including simple api framework to run custom bytecode on Nabaztag v1/v2. Includes original compiler sources for linux and a modified mac os x version.
 
-![](http://travis-ci.org/rngtng/NabaztagHackKit.png)
+![](http://github.com/rngtng/NabaztagHackKit.png)
 
 ## Getting Started
 
-### Compile & Run
+### Installation
 
-The kit comes with violet sources and binaries to compile custom Nabaztag bytecode. On a linux machine those binaries are compiled on instalation of the gem. Following three binaries are available:
+The Hack Kit is distributed as a ruby gem. It comes with a simple web server (based on sinatra) which runs out-of-the for connecting you rabbit and distributing the nabaztag bytecode. In addition it includes sinatra helpers/modules to communicate with the rabbit easily. Lastly it provides binaries to compile your own Nabaztag bytecode (see **Binaries** below).
 
-#### mtl_merge
+### Simple Server
 
-Merges multiple `*.mtl` files into one. Files are included like in C: `#include "<relative path to file>"`. Output is temporary file `.tmp.mtl`.
+The Server is the communication endpoint for the rabbit. Its two main purposes are:
+
+  1. serving the bytecode on bootup
+  2. receive and respond to HTTP requests in a defined format.
+
+### Setup
+
+1. Install dependencies first:
+
+```
+gem install nabaztag_hack_kit
+```
+
+or if you have a `Gemfile`
+
+```
+bundle install --path=vendor/bundle
+```
+
+2. Then, create a `config.ru` file
+
+```ruby
+require 'nabaztag_hack_kit/server'
+
+run NabaztagHackKit::Server.new
+```
+
+3. Finally, to start and run the server, execute:
+
+```
+bundle exec rackup -p <portnumer>
+```
+
+See `examples/` folder for more sophisticated usage.
+
+### Binaries
+
+The kit comes with violet sources and binaries to compile custom Nabaztag bytecode. See folder `compiler/`. The linux sources are (more or less) the original ones by violet, the mac osx version was created by @ztalbot2000.
+The compiler binaries are compiled on installation of the gem.
+
+Following three binaries are available:
 
 #### mtl_comp
 
-Compiles a `*.mtl` file. It calls `mtl_merge` before, and fallbacks to remote compiler in case binary is not found and `HOST` is given.
+A wrapper around `mtl_comp`. Compiles a `*.mtl` file. It calls `mtl_merge` before
 
 #### mtl_simu
 
-Runs a `*.mtl` file. It calls `mtl_merge` before, and fallbacks to remote simulator in case binary is not found and `HOST` is given.
+A wrapper around `mtl_simu`.  Runs a `*.mtl` file. It calls `mtl_merge` before
+
+#### mtl_merge
 
+Merges multiple `*.mtl` files into one. Files are included like in C: `#include "<relative path to file>"`. Output is temporary file `.tmp.mtl`.
 
-### Understanding the Bytecode
+## Development
 
-The bytecode is written in a custom language by Sylvain Huet. It is referenced as _Metal_ and files end with `.mtl`. Unfortunately documentation is very poor (and in french). Check directory `ext/bytecode/` which contains a basic overview & documentaion as well as a list of (common) commands. A good reference is the original bytecode, included in the directory as well. Major parts got extracted into seperate files, found in `lib/` directory and ready to be included in your code.
+Be sure to checkout `mtl_linux` submodule first:
+
+```
+git submodule update
+```
+
+To update the kit run:
+
+```
+bundle exec rake build && bundle exec gem install -V pkg/nabaztag_hack_kit-0.1.0.beta6.gem
+```
+
+## Understanding the Bytecode
+
+The bytecode is written in a custom language by Sylvain Huet. It is referenced as _Metal_ and files end with `.mtl`. Unfortunately documentation is very poor (and in french). Check directory `bytecode/_original` which contains a basic overview & documentation as well as a list of (common) commands. A good reference is the original bytecode, included in the directory as well. Major parts got extracted into seperate files, found in `bytecode/lib/` directory and ready to be included in your code.
+
+Grammar: https://docs.google.com/document/d/1KMg2wSyMKTmsilCpOByi_59uk5dD8XMfGAu20W63kZE/edit?hl=en_US
 
 ### Testing
 
-The kit includes a simple test framework to test custom bytecode. See `test/bytecode/test.mtl`. A typical test looks like this:
+The kit includes a simple test framework to test custom bytecode. See `bytecode/test/test.mtl`. A typical test looks like this:
 
 ```c
- let test "<test name>" -> t in
+ let test "math operations" -> t in
   (
     //assertions
-    assert_equalI 0   10 - (2* 5);
+    assert_equalI 0 10 - (2 * 5);
   0);
 ```
 
 The framework offers assertions similar to [Ruby Test::Unit](http://ruby-doc.org/stdlib-1.9.3/libdoc/test/unit/rdoc/Test/Unit.html) style. Mind that the variable type has to be given
 explicit. Convention is:
 
-  * I = interger
+  * I = integer
   * S = string
   * L = list
-  * T = tab
+  * T = table
 
-Following assertions are available:
+Following assertions are available (see bytecode/test/helper.mtl)
 
   * assert_equalI I I
   * assert_equalI S S
@@ -56,32 +115,21 @@ Following assertions are available:
   * assert_equalSL
   * assert_equalTL
 
-
-## Server
-
-The Server is the communication endpoint for the rabbit. Its two main purposes are:
-
-  1. serving the bytecode on bootup
-  2. receive and respond to HTTP requests in a defined format.
-
-To start the server, run shortcut `rake run` or, as it's based on rack, `rackup -p <portnumer>`.
-
-
 ## API
-As example and for my own purposes I implemented a simple API to deal with RFID, LEDS, BUTTON and EARS easily.
+As example and for my own purposes I implemented a simple API to deal with RFID, LEDS, BUTTON and EARS easily. (see bytecode/main.mtl)
 
 ### Input Devices
 
 #### RFID
-NabaztagInjector
+see my other project *NabaztagInjector*
 
 
 #### BUTTON
 Current Button has very basic functionality: a short press send HTTP Request of type `Log` to server, a long
-press foreces the bunny to restart.
+press forces the bunny to restart.
 
 ### Output Devices
-Data for all output devices are stored in buffers. Each device has two: one for ontime, imediate playback, another for permanet loops.
+Data for all output devices are stored in buffers. Each device has two: one for onetime, imediate playback, another for permanent loops.
 
 #### LEDS
 Buffers 0 - 9, where 0-4 are used for onetime, and 5-9 for loop playback.
@@ -90,30 +138,53 @@ Buffers 0 - 9, where 0-4 are used for onetime, and 5-9 for loop playback.
 Buffers 10 - 13, where 10 & 11 are used for onetime, and 12 & 13 for loop playback.
 
 
-
 ## Disclamer
 
-The server part was heavily inspired by [Trudy.rb](https://github.com/quimarche/trudy/blob/master/trudy.rb), compiler code copied from OpenJabNab.
-Thanks!
+The server part was heavily inspired by [Trudy.rb](https://github.com/quimarche/trudy/blob/master/trudy.rb), compiler code copied from [OpenJabNab](https://github.com/OpenJabNab/OpenJabNab). Thanks!
+
+
+## Nabaztag Background
+Read following posting for more background on Nabaztag Hacking (uses google translate:)
 
+  * [First class info from the creator himself](http://www.sylvain-huet.com/?lang=en#nabv2)
+  * [A good nabaztag Blog](https://www.journaldulapin.com/tag/nabaztag/)
+  * [A good introduction to understand Nabaztag Protocol](http://www.sis.uta.fi/~spi/jnabserver/documentation/index.html)
+  * [Les source bytecode et compilateur](http://translate.googleusercontent.com/translate_c?hl=en&rurl=translate.google.com&sl=fr&tl=en&twu=1&u=http://nabaztag.forumactif.fr/t13241p30-les-sources-bytecode-et-compilateur&usg=ALkJrhjLTbx1GMfSUgwhdjES1LzlE07HZQ#338060)
+  * [Mindscape donne une seconde vie a nabaztag](http://translate.google.com/translate?hl=en&sl=fr&tl=en&u=http%3A%2F%2Fwww.planete-domotique.com%2Fblog%2F2011%2F08%2F07%2Fmindscape-donne-une-seconde-vie-a-nabaztag%2F)
 
-### Protocol
-A good introduction to understand Nabaztag Protocol:
+## Related Projects
 
-  * http://www.cs.uta.fi/hci/spi/jnabserver/documentation/index.html
+New firmware with WPA2
+1. https://github.com/ccarlo64/firmware_nabaztag
+(see http://nabaztag.forumactif.fr/t15323-firmware-for-wpa-wpa2-test)
 
+2. https://github.com/RedoXyde/nabgcc
+  https://github.com/RedoXyde/mtl_linux
+  (see http://nabaztag.forumactif.fr/t15280p25-nabaztagtag-en-wpa2)
 
-### Nabaztag Background
-Read following posting for more backgorund on Nabaztag Hacking (uses google translate:)
+ServerlessNabaztag
+-> https://github.com/andreax79/ServerlessNabaztag
 
-  * [Les source bytecode et compilateur](http://translate.googleusercontent.com/translate_c?hl=en&rurl=translate.google.com&sl=fr&tl=en&twu=1&u=http://nabaztag.forumactif.fr/t13241p30-les-sources-bytecode-et-compilateur&usg=ALkJrhjLTbx1GMfSUgwhdjES1LzlE07HZQ#338060)
-  * [Mindscape donne une seconde vie a nabaztag](http://translate.google.com/translate?hl=en&sl=fr&tl=en&u=http%3A%2F%2Fwww.planete-domotique.com%2Fblog%2F2011%2F08%2F07%2Fmindscape-donne-une-seconde-vie-a-nabaztag%2F)
+CloudServer replace: http://nabaztaglives.com/
 
+Rebuild Nabaztag:
+- https://www.hackster.io/bastiaan-slee/nabaztag-gets-a-new-life-with-google-aiy-e9f2c8
 
-### Future
+
+## Websocket
+
+Websocket HowTo:
+- https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers
+
+- http://blog.honeybadger.io/building-a-simple-websockets-server-from-scratch-in-ruby/
+- https://github.com/pusher/websockets-from-scratch-tutorial
+
+
+## Future
 I'd like to hack the Violet mir:ror too. Some starting points:
 
   * https://github.com/leh/ruby-mirror
   * http://reflektor.sourceforge.net/
-
-
+  * http://www.instructables.com/id/Kids-check-in-and-check-out-with-hacked-Mirror-an/
+  * http://svay.com/blog/hacking-rfid-with-nodejs/
+  * http://arduino-projects4u.com/violet-mirror/

data/Rakefile

@@ -1,6 +1,2 @@
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require 'bundler/setup'
+require 'bundler/gem_tasks'

data/bytecode/main.mtl

@@ -4,17 +4,17 @@ proto main 0;;
 proto earsInit 0;;
 proto evalTrame 1;;
 
-#include "src/lib/var"
-#include "src/lib/util"
-#include "src/lib/cfg"
-#include "src/lib/arp"
-#include "src/lib/udp"
-#include "src/lib/tcp"
-#include "src/lib/dns"
-#include "src/lib/http"
-#include "src/lib/dhcp"
-#include "src/lib/wav"
-#include "src/lib/wifi"
+#include "_original/lib/var"
+#include "_original/lib/util"
+#include "_original/lib/cfg"
+#include "_original/lib/arp"
+#include "_original/lib/udp"
+#include "_original/lib/tcp"
+#include "_original/lib/dns"
+#include "_original/lib/http"
+#include "_original/lib/dhcp"
+#include "_original/lib/wav"
+#include "_original/lib/wifi"
 
 #include "lib/data_helper"
 

data/bytecode/test/test.mtl

@@ -1,6 +1,6 @@
 proto main 0;;
 
-#include "../src/lib/util"
+#include "../_original/lib/util"
 #include "../lib/data_helper"
 #include "../lib/buffer"
 
@@ -209,13 +209,13 @@ fun main=
     assert_equalI 0xFFFFFF bufferRead 0;
   0);
 
-  let test "log" -> t in
-  (
-    log "test" {1};
-    assert_equalS "test,0,1,|" logs;
-    log "test" {56 67 90};
-    assert_equalS "test,0,1,|test,0,56,67,90,|" logs;
-  0);
+  //let test "log" -> t in
+  //(
+  //  log "test" {1};
+  //  assert_equalS "test,0,1,|" logs;
+  //  log "test" {56 67 90};
+  //  assert_equalS "test,0,1,|test,0,56,67,90,|" logs;
+  //0);
 
   exit;
 0;;

data/examples/basic/Gemfile

@@ -1,6 +1,4 @@
 # A sample Gemfile
 source "http://rubygems.org"
 
-gem "nabaztag_hack_kit", {
-  :path => "../../"
-}
+gem "nabaztag_hack_kit", path:"../../"

data/examples/basic/config.ru

@@ -1,10 +1,20 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift ::File.expand_path(::File.dirname(__FILE__) + '/lib')
-require './server'
-
 $stdout.sync = true
 
-use Rack::Reloader, 0
+require 'bundler/setup'
+require 'nabaztag_hack_kit/server'
+require 'nabaztag_hack_kit/mods/callback'
+# require 'nabaztag_hack_kit/mods/logger'
+require 'nabaztag_hack_kit/mods/playground'
+
+module Basic
+  class Server < NabaztagHackKit::Server
+    register NabaztagHackKit::Mods::Callback
+    # register Mods::Logger
+    register NabaztagHackKit::Mods::Playground
+  end
+end
 
+# use Rack::Reloader, 0
 run Basic::Server.new

data/examples/record/Gemfile

@@ -3,8 +3,3 @@ source "http://rubygems.org"
 
 gem "nabaztag_hack_kit"
 gem "ruby-echonest"
-
-group :development do
-  gem "heroku"
-  gem "foreman"
-end

data/examples/record/{config.ru.example → config.ru}

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift ::File.expand_path(::File.dirname(__FILE__) + '/lib')
+require 'bundler/setup'
 require './server'
 
-use Rack::Reloader, 0
+# use Rack::Reloader, 0
 
 ECHONEST_CFG = {
   :key => "",

data/examples/record/server.rb

@@ -1,4 +1,3 @@
-
 require "nabaztag_hack_kit/server"
 require "soundcloud"
 require "echonest"
@@ -107,4 +106,3 @@ class Server < NabaztagHackKit::Server
     end
   end
 end
-

data/ext/Makefile

@@ -0,0 +1,10 @@
+all:
+	echo "all"
+	cd mtl_linux && make
+
+install:
+	echo "install"
+
+clean:
+	echo "clean"
+	cd mtl_linux && make clean

data/ext/bin/mtl_comp

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+BIN_NAME    = 'mtl_compiler'
+BIN_PATH    = File.dirname(__FILE__)
+BIN         = File.join(File.expand_path("../mtl_linux", BIN_PATH), BIN_NAME)
+FILE        = ARGV.first
+
+FILTER      = ENV['FILTER'] || "| grep -v 'bytes' | grep -e'[a-z]'"
+MERGE       = File.join(BIN_PATH, 'mtl_merge')
+TMP         = ENV['TMP'] || '.tmp.mtl'
+OUT         = ENV['OUT'] || "bytecode.bin"
+
+unless FILE
+  puts "usage: #{File.basename(__FILE__)} [filename]"
+  abort
+end
+
+# merge
+`TMP='#{TMP}' #{MERGE} #{FILE}`
+
+# compile
+out = if File.exists?(BIN)
+  `#{BIN} -s #{TMP} #{OUT} 2>&1 #{FILTER}`
+else
+  "local binary not found: #{BIN}"
+end
+
+puts out
+`rm #{TMP}`

data/ext/bin/mtl_simu

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+BIN_NAME    = File.basename(__FILE__)
+BIN_PATH    = File.dirname(__FILE__)
+BIN         = File.join(File.expand_path("../mtl_linux", BIN_PATH), BIN_NAME)
+FILE        = ARGV.first
+
+FILTER      = ENV['FILTER'] || "| grep -v 'bytes' | grep -e'[a-z]'"
+MERGE       = File.join(BIN_PATH, 'mtl_merge')
+TMP         = ENV['TMP'] || '.tmp.mtl'
+OUT         = ENV['OUT'] || "bytecode.bin"
+
+unless FILE
+  puts "usage: #{File.basename(__FILE__)} [filename]"
+  abort
+end
+
+# merge
+`TMP='#{TMP}' #{MERGE} #{FILE}`
+
+# simu
+out = if File.exists?(BIN)
+  `#{BIN} --source #{TMP}`
+else
+  "local binary not found: #{BIN}"
+end
+
+puts out
+`rm #{TMP}`

data/ext/mtl_linux/.gitignore

@@ -0,0 +1,7 @@
+obj/
+mtl_simu
+mtl_compiler
+libvcomp.a
+*.bin
+*.mtl
+dumpbc.c

data/ext/mtl_linux/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 
+
+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.