fluent-plugin-osmocom-spectrum-sense 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b2b963f9c62555f6159bf31bd5474ba3eaa3ee7
+  data.tar.gz: 3e6210ccfaf0b42e2885abe4829e4b48ad42c639
+SHA512:
+  metadata.gz: 37f935311f19ed99cc2e3567e0d85887169994d6e1fbcdbd97bef5f4ccfe7e6c13232e0f820db55de7b0e01038706323e281f5878dc2b8b9f78d730b5ea5a899
+  data.tar.gz: ef639a49cb96a8ce1b3378eb98d12c80add16cecb65147c849adc68c2eaaa1bc1f4db1be736d7eed09598a3cd80a4056e9c4229fb69fd25302084bf537ccb296

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-osmocom-spectrum-sense.gemspec
+gemspec

data/LICENSE.txt

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

@@ -0,0 +1,52 @@
+# Fluent::Plugin::OsmocomSpectrumSense
+
+fluent-plugin-osmocom-spectrum-sense is an input plugin for Fluentd. It runs osmocom_spectrum_sense with specified arguments and extract frequencies, powers, noise floor (dBm) from its output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-osmocom-spectrum-sense'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-osmocom-spectrum-sense
+
+## Usage
+
+See samples/text.conf
+
+```
+<source>
+  @type osmocom_spectrum_sense
+
+ tag osmocom
+  minfreq 79000000
+  maxfreq 83000000
+  sample_rate 3200000
+  dwell_delay 1
+  tune_delay 1
+</source>
+```
+
+## Configuration
+
+|name|type|required?|corresponds to...|default|description|
+|:---|:---|:--------|:----------------|:------|:----------|
+|minfreq|int|required|min_freq|none|Minimum Frequency|
+|maxfreq|int|required|max_freq|none|Maximum Frequency|
+|sample_rate|int|optional|-s, --sample-rate|3200000 (3.2Msps)|Sample rate|
+|dwell_delay|float|optional|--dwell-delay|0.25 (0.25s)|Seconds to dwell at a given frequency|
+|tune_delay|float|optional|--tune-delay|0.25 (0.25s)|Seconds to delay after changing frequency|
+|channel_bandwidth|float|optional|-b, --channel-bandwidth|6250.0 (6.25KHz)|Channel bandwidth of fft bins in Hz|
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fluent/plugin/in_osmocom_spectrum_sense"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fluent-plugin-osmocom-spectrum-sense.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-osmocom-spectrum-sense"
+  spec.version       = "0.0.1"
+  spec.authors       = ["enukane"]
+  spec.email         = ["enukane@glenda9.org"]
+
+  spec.summary       = %q{nop}
+  spec.description   = %q{nop}
+  spec.homepage      = "https://github.com/enukane/fluent-plugin-osmocom-spectrum-sense"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  #spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/in_osmocom_spectrum_sense.rb

@@ -0,0 +1,129 @@
+require "fluent/input"
+require "fluent/parser"
+
+module Fluent
+  class OsmocomSpectrumSenseInput < Input
+    Plugin.register_input('osmocom_spectrum_sense', self)
+    require 'open3'
+    require 'time'
+
+    def initialize
+      super
+    end
+
+    config_param :tag, :string, :default => "osmocom"
+    config_param :minfreq, :integer, :default => nil
+    config_param :maxfreq, :integer, :default => nil
+    config_param :sample_rate, :integer, :default => 3200000
+    config_param :dwell_delay, :float, :default => 0.25
+    config_param :tune_delay, :float, :default => 0.25
+    config_param :channel_bandwidth, :float, :default => 6250.0
+
+    def configure(conf)
+      super
+
+      if !@minfreq.is_a?(Integer) or !@maxfreq.is_a?(Integer)
+        raise ConfigError, "minfreq/maxfreq is required to be Integer"
+      end
+    end
+
+    def start
+      super
+
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      if @th_osmocom and @th_osmocom.alive?
+        Process.kill("INT", @th_osmocom.pid)
+      end
+      @thread.join
+    rescue => e
+      log.error "osmocom_spectrum_sense failed to shutdown", :error => e.to_s,
+        :error_class => e.class.to_s
+      log.error_backtrace e.backtrace
+    end
+
+    def run
+      options = build_options
+      cmdline = "osmocom_spectrum_sense #{options}"
+      print cmdline + "\n"
+      stdin, stdout, stderr, @th_osmocom = *Open3.popen3(cmdline)
+
+      while @th_osmocom.alive?
+        collect_osmocom_output(stdout)
+      end
+    rescue => e
+      log.error "unexpected error", :error => e.to_s
+      log.error_backtrace e.backtrace
+    end
+
+    def build_options
+      options = ""
+      if @sample_rate
+        options += " -s #{@sample_rate}"
+      end
+      if @dwell_delay
+        options += " --dwell-delay=#{@dwell_delay}"
+      end
+      if @tune_delay
+        options += " --tune-delay=#{@tune_delay}"
+      end
+      if @channel_bandwidth
+        options += " -b #{@channel_bandwidth}"
+      end
+
+      options += " #{@minfreq} #{@maxfreq}"
+      return options
+    end
+
+    REG=/^(?<time>.+) center_freq (?<center_freq>\d+\.\d+) freq (?<freq>\d+\.\d+) power_db (?<power_db>-?\d+\.\d+) noise_floor_db (?<noise_floor_db>-?\d+\.\d+)$/
+    def collect_osmocom_output(stdout)
+      collected = []
+      begin
+        readlines_nonblock(stdout).each do |line|
+          # XXX: parse here
+          log.debug "line => '#{line}'"
+          match = line.match(REG)
+          next unless match
+          obj = {
+            :time => Time.parse(match[:time]),
+            :center_freq => match[:center_freq].to_f,
+            :freq => match[:freq].to_f,
+            :power_db => match[:power_db].to_f,
+            :noise_floor_db => match[:noise_floor_db].to_f,
+          }
+          log.debug "new osmocom_spectrum_sense input => #{obj}"
+          collected << obj
+        end
+      rescue => e
+        log.error "failed to read or parse line", :error => e.to_s,
+          :error_class => e.class.to_s
+      end
+
+      collected.each do |obj|
+        time = obj[:time].nil? ? Engine.now : Fluent::EventTime.from_time(obj[:time])
+        obj.delete(:time) # including time could problem in some output plugin
+        router.emit(@tag, time, obj)
+      end
+    rescue => e
+      log.error "failed to collect output from tshark",
+        :error => e.to_s,
+        :error_class => e.class.to_s
+    end
+
+    def readlines_nonblock(io)
+      @nbbuffer = "" if @nbbuffer == nil
+      @nbbuffer += io.read_nonblock(65535)
+      lines = []
+      while idx = @nbbuffer.index("\n")
+        lines << @nbbuffer[0..idx-1]
+        @nbbuffer = @nbbuffer[idx+1..-1]
+      end
+      return lines
+    rescue
+      return []
+    end
+
+  end
+end

data/samples/test.conf

@@ -0,0 +1,18 @@
+<source>
+  @type osmocom_spectrum_sense
+
+ tag osmocom
+  minfreq 79000000
+  maxfreq 83000000
+  sample_rate 3200000
+  dwell_delay 1
+  tune_delay 1
+</source>
+
+#<source>
+#  @type snmp
+#</source>
+
+<match osmocom>
+  @type stdout
+</match>

data/spec/fluent/plugin/osmocom_spectrum_sense_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Fluent::Plugin::OsmocomSpectrumSenseInput do
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'fluent/plugin/in_osmocom_spectrum_sense'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-osmocom-spectrum-sense
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- enukane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  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: nop
+email:
+- enukane@glenda9.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent-plugin-osmocom-spectrum-sense.gemspec
+- lib/fluent/plugin/in_osmocom_spectrum_sense.rb
+- samples/test.conf
+- spec/fluent/plugin/osmocom_spectrum_sense_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/enukane/fluent-plugin-osmocom-spectrum-sense
+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.4.5
+signing_key: 
+specification_version: 4
+summary: nop
+test_files: []