parse_p1 0.0.2

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+
+branches:
+  only:
+    - master
+
+script: "bundle exec rake test"

data/CHANGELOG

@@ -0,0 +1,6 @@
+* 0.0.2
+  Parsing of electricity and gas values
+
+* 0.0.1
+
+  Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'rake', '~>0.9.2.2'
+
+# Specify your gem's dependencies in parse_p1.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :test do
+  watch(%r{^lib/*/(.+)\.rb$}) {'test'}
+  watch(%r{^test/.+_test\.rb$})
+  watch('test/helper.rb')  { "test" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Frank Oxener - Agile Dovadi BV
+
+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,98 @@
+ParseP1
+========
+
+[![Build Status](https://secure.travis-ci.org/dovadi/ParseP1.png?branch=master)](http://travis-ci.org/dovadi/ParseP1)
+
+Basic parser for P1 Companion Standard used by Dutch Smart Meters.
+
+*Library is by no means complete (yet), it is now implemented only on one real example of a so called Dutch smart meter, in this case a Iskra MT382*
+
+Example of P1 data
+==================
+
+<pre>
+/ABc1\\1AB123-4567
+
+0-0:96.1.1(1A123456789012345678901234567890)  
+1-0:1.8.1(00136.787*kWh)  
+1-0:1.8.2(00131.849*kWh)  
+1-0:2.8.1(00000.000*kWh)  
+1-0:2.8.2(00000.000*kWh)  
+0-0:96.14.0(0002)  
+1-0:1.7.0(0003.20*kW)  
+1-0:2.7.0(0000.00*kW)  
+0-0:17.0.0(0999.00*kW)  
+0-0:96.3.10(1)  
+0-0:96.13.1()  
+0-0:96.13.0()  
+0-1:24.1.0(3)  
+0-1:96.1.0(1234567890123456789012345678901234)  
+0-1:24.3.0(120502150000)(00)(60)(1)(0-1:24.2.1)(m3)  
+(00092.112)  
+0-1:24.4.0(1)  
+!
+</pre>
+
+Usage
+=====
+
+<pre>
+p1 = ParseP1::Base.new(p1_string)  
+p1.electra_meter_id                                  #-> 1A123456789012345678901234567890
+p1.electricity(:type => :import, :tariff => :normal) #-> 116.34 (kWH)
+p1.electricity(:type => :import, :actual => :true)   #-> 1245   (watt)
+p1.gas_usage                                         #-> 91.224   (watt)
+</pre>
+
+See tests for futher available methods
+
+
+Running tests
+=============
+First install libraries with:
+<pre>
+bundle
+</pre>
+
+Test with
+<pre>
+bundle exec rake test 
+</pre>
+_or_
+<pre>
+bundle exec guard
+</pre>
+
+Caveats
+=======
+
+* Library is by no means complete (yet), it is now implemented only on one real example of a so called Dutch smart meter. In this case a Iskra MT382 (see docs and ([manuals](http://www.liander.nl/liander/meters/meterhandleidingen.htm))) delivered by [Liander](http://www.liander.nl/).
+* See [ReadP1 Arduino library](https://github.com/dovadi/ReadP1), which is used for posted the P1 data to a Ruby on Rails application.
+* Although P1 should be a standard, it is known there are different implementations in the Netherlands alone.
+* The library is implemented on the base of one long string received by a Ruby on Rails application. Parsing a text file will fail!
+
+Documentation
+=============
+ See [Datalogging van "slimme meters"](http://www.zonstraal.be/wiki/Datalogging_van_%22slimme_meters%22) in Dutch
+
+ See [P1 Companion Standard Version 2.2 April 18th 2008 from Enbin](http://read.pudn.com/downloads145/doc/633047/DSMR%20v2.2%20final/Dutch%20Smart%20Meter%20Requirements%20v2.2%20final%20P1.pdf) (also in docs directory)
+
+ See [Representation of P1 telegram P1 Companion Standard Version 4.0 from Netbeheer Nederland](http://www.google.nl/url?sa=t&rct=j&q=p1%20companion%20standard&source=web&cd=1&sqi=2&ved=0CCkQFjAA&url=http%3A%2F%2Fwww.netbeheernederland.nl%2FDecosDocument%2FDownload%2F%3FfileName%3D1uII4GRHFdk98V78_gP-T4GttCG3SzdH9Vc0YXH328SvwKJJVRaTaKAmCYayrXZC%26name%3DDSMR%2BV4.0%2Bfinal%2BP1&ei=CHyeT5PgGc-VOs20-PsB&usg=AFQjCNE3sIY9JZ_RNEStaaA8YYv7iR0XkQ&sig2=PJXsfhIRCwWitgVgNrx2xQ) (also in docs directory)
+
+
+Contributing to ParseP1
+=====================
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+==========
+
+Copyright (c) 2012 Frank Oxener - Agile Dovadi BV. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# require "bundler/gem_tasks"
+
+require 'rubygems'
+require 'bundler/gem_helper'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+

data/docs/example_p1_output.txt

@@ -0,0 +1,23 @@
+/ABc1\\1AB123-4567
+
+0-0:96.1.1(1A123456789012345678901234567890)
+1-0:1.8.1(00136.787*kWh)
+1-0:1.8.2(00131.849*kWh)
+1-0:2.8.1(00000.000*kWh)
+1-0:2.8.2(00000.000*kWh)
+0-0:96.14.0(0002)
+1-0:1.7.0(0003.20*kW)
+1-0:2.7.0(0000.00*kW)
+0-0:17.0.0(0999.00*kW)
+0-0:96.3.10(1)
+0-0:96.13.1()
+0-0:96.13.0()
+0-1:24.1.0(3)
+0-1:96.1.0(1234567890123456789012345678901234)
+0-1:24.3.0(120502150000)(00)(60)(1)(0-1:24.2.1)(m3)
+(00092.112)
+0-1:24.4.0(1)
+!
+
+
+"\r\n/ABc1\\1AB123-4567\r\n\r\n0-0:96.1.1(1A123456789012345678901234567890)\r\n1-0:1.8.1(00136.787*kWh)\r\n1-0:1.8.2(00131.849*kWh)\r\n1-0:2.8.1(00000.000*kWh)\r\n1-0:2.8.2(00000.000*kWh)\r\n0-0:96.14.0(0002)\r\n1-0:1.7.0(0003.20*kW)\r\n1-0:2.7.0(0000.00*kW)\r\n0-0:17.0.0(0999.00*kW)\r\n0-0:96.3.10(1)\r\n0-0:96.13.1()\r\n0-0:96.13.0()\r\n0-1:24.1.0(3)\r\n0-1:96.1.0(1234567890123456789012345678901234)\r\n0-1:24.3.0(120502150000)(00)(60)(1)(0-1:24.2.1)(m3)\r\n(00092.112)\r\n0-1:24.4.0(1)\r\n!\r\n"

data/lib/parse_p1/base.rb

@@ -0,0 +1,25 @@
+module ParseP1
+
+  class Base
+
+    include ParseP1::Electricity
+    include ParseP1::Gas
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def valid?
+      !data.match(/!\r\n$/).nil? && !device_id.nil?
+    end
+
+    def device_id
+      data.match(/^\/([a-zA-Z]{3}\d{1}.+)\r$/)
+      $1
+    end
+
+  end
+
+end

data/lib/parse_p1/electricity.rb

@@ -0,0 +1,59 @@
+module ParseP1
+
+  module Electricity
+
+    def electra_meter_id
+      data.match(/0:96.1.1\S(\d{1}[A-Z]{1}\d{1,96})\S/)
+      $1
+    end
+
+    def electricity_tariff_indicator
+      data.match(/0-0:96.14.0\S(\d{1,9})\S/)
+      $1.to_i
+    end
+
+    def electricity_actual_threshold
+      electricity('0-0:17.0.0')
+    end
+
+    def electricity(options)
+      if options.is_a?(Hash)
+        if options[:actual] == true
+          get_actual_electricity(options[:type])
+        else
+          get_electricity("1-0:#{first_electricity_code(options[:type])}.8.#{second_electricity_code(options[:tariff])}")
+        end
+      else
+        get_electricity(options)
+      end
+    end
+
+    private
+
+    def get_electricity(obis_code)
+      data.match(/#{obis_code}\S(\d{1,9}\.\d{1,3})\S/)
+      $1.to_f
+    end
+
+    def get_actual_electricity(type)
+      power = get_electricity("1-0:#{first_electricity_code(type)}.7.0")
+      (power * 1000).to_i #Return as watts instead of kW
+    end
+
+    def first_electricity_code(code)
+      case code
+      when :import; '1'
+      when :export; '2'
+      end
+    end
+
+    def second_electricity_code(tariff)
+      case tariff
+      when :normal; 1
+      when :low; 2
+      end
+    end
+
+  end
+
+end

data/lib/parse_p1/gas.rb

@@ -0,0 +1,28 @@
+module ParseP1
+
+  module Gas
+
+    def gas_meter_id
+      data.match(/1:96.1.0\S(\d{1,96})\S/)
+      $1
+    end
+
+    #Only 2 digits for year!
+    def last_hourly_reading_gas
+      data.match(/0-1:24.3.0\S(\d{12})\S/)
+      DateTime.new(('20'+$1[0..1]).to_i, $1[2..3].to_i, $1[4..5].to_i, $1[6..7].to_i, $1[8..9].to_i)
+    end
+
+    def measurement_unit_gas
+      data.match(/\S0-1:24.2.1\S\S(\w+)\S/)
+      $1
+    end
+
+    def gas_usage
+      data.match(/\S0-1:24.2.1\S\S\w+\S\r\n\S(\d+.\d+)\S/)
+      $1.to_f
+    end
+
+  end
+
+end

data/lib/parse_p1/version.rb

@@ -0,0 +1,3 @@
+module ParseP1
+  VERSION = "0.0.2"
+end

data/lib/parse_p1.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'date'
+require 'parse_p1/electricity'
+require 'parse_p1/gas'
+require 'parse_p1/base'

data/parse_p1.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "parse_p1/version"
+
+Gem::Specification.new do |s|
+  s.name        = "parse_p1"
+  s.version     = ParseP1::VERSION
+  s.authors     = ["Frank Oxener"]
+  s.email       = ["frank.oxener@gmail.com"]
+  s.homepage    = %q{http://github.com/dovadi/parse_p1}
+  s.summary     = %q{Parsing P1 Companion Standard used by Dutch Smart Meters}
+  s.description = %q{Parsing P1 Companion Standard used by Dutch Smart Meters. Used in combination with a Nanode posting the P1 data to emonWeb.org}
+  s.licenses    = ['MIT']
+  s.rubyforge_project = "parse_p1"
+
+  s.extra_rdoc_files = [
+     'CHANGELOG',
+     'LICENSE.txt',
+     'README.md'
+   ]
+
+  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_development_dependency 'shoulda'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-test'
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'parse_p1'
+
+class Test::Unit::TestCase
+end

data/test/parse_p1_test.rb

@@ -0,0 +1,106 @@
+require 'helper'
+
+class TestParseP1 < Test::Unit::TestCase
+
+  def setup
+    #Data string as received on a Ruby on Rails application
+    @data = "\r\n/ABc1\\1AB123-4567\r\n\r\n0-0:96.1.1(1A123456789012345678901234567890)\r\n1-0:1.8.1(00136.787*kWh)\r\n1-0:1.8.2(00131.849*kWh)\r\n1-0:2.8.1(00002.345*kWh)\r\n1-0:2.8.2(00054.976*kWh)\r\n0-0:96.14.0(0002)\r\n1-0:1.7.0(0003.20*kW)\r\n1-0:2.7.0(0000.12*kW)\r\n0-0:17.0.0(0999.00*kW)\r\n0-0:96.3.10(1)\r\n0-0:96.13.1()\r\n0-0:96.13.0()\r\n0-1:24.1.0(3)\r\n0-1:96.1.0(1234567890123456789012345678901234)\r\n0-1:24.3.0(120502150000)(00)(60)(1)(0-1:24.2.1)(m3)\r\n(00092.112)\r\n0-1:24.4.0(1)\r\n!\r\n"
+    @p1   = ParseP1::Base.new(@data)
+  end
+
+  should 'return the p1_string' do
+    assert_equal @data, @p1.data
+  end
+
+  should 'tell if string is P1 valid' do
+    assert_equal true, @p1.valid?
+  end
+
+  context 'Device identifiers' do
+
+    should 'return the device_id of the meter' do
+       assert_equal 'ABc1\1AB123-4567', @p1.device_id
+    end
+
+    #Sn (n=0..96), octet string is NOT true
+    should 'return the electra meter identifier of the meter' do
+      assert_equal '1A123456789012345678901234567890', @p1.electra_meter_id
+    end
+
+    #Sn (n=0..96) octet string 
+    should 'return the gas meter identifier of the meter' do
+      assert_equal '1234567890123456789012345678901234', @p1.gas_meter_id
+    end
+
+  end
+
+  context 'Electricity data' do
+
+    #S4 tag 4 bit string is NOT true
+    should 'return the electricity tariff indicator' do
+      assert_equal 2, @p1.electricity_tariff_indicator
+    end
+
+    #F4(1,1)
+    should 'return the electricity actual threshold' do
+      assert_equal 999.0, @p1.electricity_actual_threshold
+    end
+
+    #F9 (3,3)
+    should 'return electricity with a corresponding obis code' do
+      assert_equal 136.787, @p1.electricity('1-0:1.8.1')
+    end
+
+    #F9 (3,3)
+    should 'return imported electricty with normal tarif' do
+      assert_equal 136.787, @p1.electricity(:type => :import, :tariff => :normal)
+    end
+
+    #F9 (3,3)
+    should 'return imported electricty with low tarif' do
+      assert_equal 131.849, @p1.electricity(:type => :import, :tariff => :low)
+    end
+
+    #F9 (3,3)
+    should 'return electricty produced by client normal tarif' do
+      assert_equal 2.345, @p1.electricity(:type => :export, :tariff => :normal)
+    end
+
+    #F9 (3,3)
+    should 'return electricty produced by client low tarif' do
+      assert_equal 54.976, @p1.electricity(:type => :export, :tariff => :low)
+    end
+
+    context 'Actual data' do
+
+      #F5 (3,3)
+      should 'return actual power imported' do
+        assert_equal 3200, @p1.electricity(:type => :import, :actual => true)
+      end
+
+      #F5 (3,3)
+      should 'return actual power in case of a low tarif' do
+        assert_equal 120, @p1.electricity(:type => :export, :actual => true)
+      end
+
+    end
+
+  end
+
+  context 'Gas data' do
+
+    should 'return the last hourly reading of gas usage' do
+      assert_equal DateTime.new(2012,5,2,15,0), @p1.last_hourly_reading_gas
+    end
+
+    should 'return the measurement unit of gas usage' do
+      assert_equal 'm3', @p1.measurement_unit_gas
+    end
+
+    should 'return the total usage of gas' do
+      assert_equal 92.112, @p1.gas_usage
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: parse_p1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Frank Oxener
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2151918740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151918740
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2151918120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151918120
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: &2151917380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151917380
+description: Parsing P1 Companion Standard used by Dutch Smart Meters. Used in combination
+  with a Nanode posting the P1 data to emonWeb.org
+email:
+- frank.oxener@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG
+- LICENSE.txt
+- README.md
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/DSMR V4-2.0 final P1.pdf
+- docs/Dutch Smart Meter Requirements v2.2 final P1.pdf
+- docs/Meterhandleiding ME382-MT382_tcm300-197291.pdf
+- docs/example_p1_output.txt
+- lib/parse_p1.rb
+- lib/parse_p1/base.rb
+- lib/parse_p1/electricity.rb
+- lib/parse_p1/gas.rb
+- lib/parse_p1/version.rb
+- parse_p1.gemspec
+- test/helper.rb
+- test/parse_p1_test.rb
+homepage: http://github.com/dovadi/parse_p1
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: parse_p1
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Parsing P1 Companion Standard used by Dutch Smart Meters
+test_files:
+- test/helper.rb
+- test/parse_p1_test.rb