gom-sensor-ports 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b33f183a094f50f689b5e0f928e85f777cc35464
-  data.tar.gz: c68ddf9f61a70e16d275033d48b3e57e80736215
+  metadata.gz: ee1db02028b2f3a6680c5506734a422474819222
+  data.tar.gz: 7c9de8f1cb14e2203c94d9734148fd5373df7094
 SHA512:
-  metadata.gz: 8ce8b07eba98e6ce221a9f0a909b443c0481ca4db7b6b90699d1358938d7adeb638af1238f9f78af4901a37ca2a785eaebe98e9721032a5a5bcec93ae2791d86
-  data.tar.gz: 494c09640086cd7fbbf35a02bcee854f75f96be502ecb952f1663a873f37ee618e0991fed2b84aa70449b91890b2bf158393e37198eb38c9f120eff2444424f1
+  metadata.gz: 6d74a600dfb0c35754bd4b78fce13568f5636e9fced0badf0c905495737a864f21802f31dcb76d244455ba4f082fbac7853981771a668b1696ebb5c60c062941
+  data.tar.gz: f9a2fcc28852b43cb5c28803521fcdce34df9119e3b192a1ef079139aceca3b6c1c929e86612968328ad8efc8be38d1110ecf8e5ec591181d658a4e5150a7676

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gom-sensor-ports (0.2.2)
+    gom-sensor-ports (0.2.4)
       daemons
       gom-core (~> 0.2.2)
       gom-script (~> 0.2.2)
@@ -36,7 +36,7 @@ GEM
       thor (>= 0.14.6)
     guard-rspec (1.2.0)
       guard (>= 1.1)
-    json (1.7.3)
+    json (1.7.7)
     listen (0.4.7)
       rb-fchange (~> 0.0.5)
       rb-fsevent (~> 0.9.1)
@@ -44,7 +44,7 @@ GEM
     mongrel (1.2.0.pre2)
       daemons (~> 1.0.10)
       gem_plugin (~> 0.2.3)
-    rack (1.4.1)
+    rack (1.5.2)
     rb-fchange (0.0.5)
       ffi
     rb-fsevent (0.9.1)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009/10/11/12 art+com AG/dirk luesebrink
+Copyright (c) 2009/10/11/12/13 art+com AG/dirk luesebrink
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.mkd

@@ -1,9 +1,44 @@
 # gom-sensor-ports
+
 Easy UDP/TCP sensor data sending to a remote GOM node. This gem includes a GNP
 callback server, support for automatic observer refreshments and command line
 tools for reading, writing and observing GOM entries.
 
+## Usage
+
+The gem provides a daemon which connects your sensor to the GOM HTTP update
+protocol. You can start the daemon from the command line with its GOM URL:
+
+  $ gom-sensor-port http://gom.dev.artcom.de/sensor
+
+The sensor will load its configuration from that GOM node. The configuration
+values and their defauls are: 
+
+      interface: '0.0.0.0'
+      port:       44470
+      verbose:    false
+      mode:       :udp
+
+(Note: only udp mode is currently implemented)
+Any of these defaults can be change from the command line:
+
+  $ gom-sensor-port --interface=1.1.1.23 http://gom.dev.artcom.de/sensor
+
+gom-sensor-port will than listen to incoming sensor packages and interpret the
+incoming messages as simple key value pair which it writes to the GOM:
+
+received from sensor: 
+    
+    foo:123
+
+written to GOM:
+
+    /sensor:raw = 'foo:123'
+    /sensor/values:foo = '123'
+
+
 ## Install
+
 use the bundler tasks:
 
     $ rake build install 
@@ -23,9 +58,10 @@ see Gemfile
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 ## Copyright
 
-Copyright (c) 2010 art+com AG/dirk luesebrink. See LICENSE for details.
+Copyright (c) 2010/13 art+com AG/dirk luesebrink. See LICENSE for details.

data/Rakefile

@@ -1,64 +1,2 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
-
-__END__
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "gom-sensor-ports"
-    gem.summary = %Q{
-      gateway for barebone TCP/UDP reporting sensors to GOM/HTTP protocoll
-    }
-    gem.description = %Q{
-      This gems implements a gateway server to allow barebone basic sensor
-      components to report state change updates as simple protocol free udates
-      over TCP/UDP ports without the 'overhead' of the HTTP protocoll. For
-      example, a power sensor might just broadcast a four byte floating point
-      binary number once every second to an UCP port
-    }
-    gem.email = "dirk.luesebrink@gmail.com"
-    gem.homepage = "http://github.com/crux/gom-sensor-ports"
-    gem.authors = ["art+com AG/dirk luesebrink"]
-
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "fakeweb"
-
-    gem.add_runtime_dependency "applix"
-    gem.add_runtime_dependency "gom-script"
-    gem.add_runtime_dependency "gom-core"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-#require 'spec/rake/spectask'
-#Spec::Rake::SpecTask.new(:spec) do |spec|
-#  spec.libs << 'lib' << 'spec'
-#  spec.spec_files = FileList['spec/**/*_spec.rb']
-#end
-#Spec::Rake::SpecTask.new(:rcov) do |spec|
-#  spec.libs << 'lib' << 'spec'
-#  spec.pattern = 'spec/**/*_spec.rb'
-#  spec.rcov = true
-#end
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:rcov) do |t|
-  t.rcov_opts =  %q[--exclude "spec"]
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "gom-sensor-ports #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/bin/gom-sensor-port

@@ -9,14 +9,14 @@ require 'gom/sensor_port'
 Defaults = { :verbose => false }
 
 def usage
-  puts "#{__FILE__} serve <gom sensor node URL>"
+  puts "#{__FILE__} serve <GOM URL, e.g: http://gom.dev.artcom.de/sensors/udp>"
 end
 
 Applix.main(ARGV, Defaults) do
 
   any { usage }
 
-  # example: gom-sensor-port serve /gom/sensors/udp
+  # example: gom-sensor-port serve http://gom.dev.artcom.de/sensors/udp
   handle(:serve) do |*args, options|
     puts "args: #{args.inspect}"
     puts "opts: #{options}"

data/gom-sensor-ports.gemspec

@@ -9,14 +9,16 @@ Gem::Specification.new do |s|
   s.email       = ['dirk.luesebrink@artcom.de']
   s.homepage    = 'http://github.com/crux/gom-sensor-ports'
   s.summary     = %q{
-    gateway for barebone TCP/UCP reporting sensors to GOM/HTTP protocoll
+    gateway for barebone TCP/UCP reporting sensors to GOM/HTTP protocol
   }
   s.description = %q{ 
-    This gems implements a gateway server to allow barebone basic sensor
-    components to report state change updates as simple protocol free udates
-    over TCP/UDP ports without the 'overhead' of the HTTP protocoll. For
-    example, a power sensor might just broadcast a four byte floating point
-    binary number once every second to an UCP port
+    Implements a gateway server to allow barebone basic sensor components to
+    report state change updates as simple via TCP/UDP ports without the
+    'overhead' of the HTTP protocol. A power sensor for example might just
+    broadcast a four byte floating point binary number once every second to an
+    UDP port or an arduino board sends a UDP datagram whenever a button is
+    pushed. You get the idea, this is how to bring embedded devices into the
+    world of HTTP and Javascript...
   }
 
   s.add_dependency 'daemons'

data/lib/gom/sensor_ports/version.rb

@@ -1,5 +1,5 @@
 module Gom
   class SensorPorts
-    VERSION = '0.2.3'
+    VERSION = '0.2.4'
   end
 end

data/spec/lib/gom/sensor_port_spec.rb

@@ -4,7 +4,7 @@ describe "Gom::SensorPort" do
   context "given no options" do
 
     let(:path) { '/gom-sensor-port' }
-    let(:station) { Gom::SensorPort.new "#{path}" }
+    let(:station) { Gom::SensorPort.new path }
     let(:json) { <<-JSON
       {
         "node": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gom-sensor-ports
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - art+com/dirk luesebrink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-30 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
@@ -150,11 +150,13 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: " \n    This gems implements a gateway server to allow barebone basic
-  sensor\n    components to report state change updates as simple protocol free udates\n
-  \   over TCP/UDP ports without the 'overhead' of the HTTP protocoll. For\n    example,
-  a power sensor might just broadcast a four byte floating point\n    binary number
-  once every second to an UCP port\n  "
+description: " \n    Implements a gateway server to allow barebone basic sensor components
+  to\n    report state change updates as simple via TCP/UDP ports without the\n    'overhead'
+  of the HTTP protocol. A power sensor for example might just\n    broadcast a four
+  byte floating point binary number once every second to an\n    UDP port or an arduino
+  board sends a UDP datagram whenever a button is\n    pushed. You get the idea, this
+  is how to bring embedded devices into the\n    world of HTTP and Javascript...\n
+  \ "
 email:
 - dirk.luesebrink@artcom.de
 executables:
@@ -207,7 +209,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: gateway for barebone TCP/UCP reporting sensors to GOM/HTTP protocoll
+summary: gateway for barebone TCP/UCP reporting sensors to GOM/HTTP protocol
 test_files:
 - spec/lib/gom/sensor_port_spec.rb
 - spec/lib/gom/sensor_ports_spec.rb