p1_meter_reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 693ff520b5a8edca746d8d30de28e9356211de5a
+  data.tar.gz: da0761bba90fe81a78ee0d570d8832308d87b8e5
+SHA512:
+  metadata.gz: b4c8fd08dba517c272ca43ac81cd62c8b07e534400a9981567dc9a4af2a9d43c2ba6a8c130018d27bfa23b75a218bcbe7989110a61fff12236703e3eb1229583
+  data.tar.gz: 29f2cdf026f6f0db23d6493ace1f259b5c0a6e27bc00298d7bc0fd0e7ed58e0f2dc8b65511c6a69492e404d116d62c631997c118c73c3cb98ae9b043df810c6d

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,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in p1_meter_reader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lennaert Meijvogel
+
+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,39 @@
+# P1MeterReader
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/p1_meter_reader`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'p1_meter_reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install p1_meter_reader
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/p1_meter_reader/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "p1_meter_reader"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/p1_meter_reader/data_parsing/fake_stream_splitter.rb

@@ -0,0 +1,35 @@
+module P1MeterReader
+  module DataParsing
+    class FakeStreamSplitter
+      def record
+        <<-RECORD
+/XMX5XMXABCE100129872
+
+0-0:96.1.1(4B414145303031343535343236383133)
+1-0:1.8.1(02018.957*kWh)
+1-0:1.8.2(02293.712*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(0000.50*kW)
+1-0:2.7.0(0000.00*kW)
+0-0:17.0.0(999*A)
+0-0:96.3.10(1)
+0-0:96.13.1()
+0-0:96.13.0()
+0-1:96.1.0(3238303131303038333338303831393133)
+0-1:24.1.0(03)
+0-1:24.3.0(150327210000)(00)(60)(1)(0-1:24.2.0)(m3)
+(02246.014)
+0-1:24.4.0(1)
+!
+        RECORD
+      end
+
+      def read
+        sleep 1
+        return record
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/data_parsing/kwh_reader.rb

@@ -0,0 +1,13 @@
+module P1MeterReader
+  module DataParsing
+    module KwhReader
+      def read(line)
+        match = line.match(/\((.*)\*kWh\)/)
+
+        kWh(match[1]) if match
+      end
+
+      module_function :read
+    end
+  end
+end

data/lib/p1_meter_reader/data_parsing/parse_chain/chainable.rb

@@ -0,0 +1,25 @@
+module P1MeterReader
+  module DataParsing
+    module ParseChain
+      class Chainable
+        def initialize(next_chain = nil)
+          @next = next_chain
+        end
+
+        def next=(chainable)
+          @next=chainable
+        end
+
+        def try(lines_enumerator, output)
+          if can_handle?(lines_enumerator.peek)
+            handle(lines_enumerator, output)
+          else
+            next_chain = @next || :no_next_chain
+
+            next_chain.try(lines_enumerator, output)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/data_parsing/parse_chain/gas_chain.rb

@@ -0,0 +1,21 @@
+require 'p1_meter_reader/data_parsing/parse_chain/chainable'
+
+module P1MeterReader
+  module DataParsing
+    module ParseChain
+      class GasChain < Chainable
+        def can_handle?(line)
+          line.start_with? '0-1:24.3.0'
+        end
+
+        def handle(lines_enumerator, output)
+          lines_enumerator.next # Skip the intro line
+          line = lines_enumerator.next
+
+          match = line.match(/\((\d*\.\d*)\)/)
+          output.gas = match[1].to_f if match
+        end
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/data_parsing/parse_chain/skip_line_chain.rb

@@ -0,0 +1,17 @@
+require 'p1_meter_reader/data_parsing/parse_chain/chainable'
+
+module P1MeterReader
+  module DataParsing
+    module ParseChain
+      class SkipLineChain < Chainable
+        def can_handle?(_)
+          true
+        end
+
+        def handle(lines_enumerator, _)
+          lines_enumerator.next
+        end
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/data_parsing/parse_chain/stroom_current_chain.rb

@@ -0,0 +1,21 @@
+require 'p1_meter_reader/data_parsing/parse_chain/chainable'
+require 'p1_meter_reader/data_parsing/kwh_reader'
+
+module P1MeterReader
+  module DataParsing
+    module ParseChain
+      class StroomCurrentChain < Chainable
+        def can_handle?(line)
+          line.start_with? ("1-0:1.7.0")
+        end
+
+        def handle(lines_enumerator, output)
+          line = lines_enumerator.next
+
+          match = line.match(/\((.*)\*kW\)/)
+          output.stroom_current = match[1].to_f if match
+        end
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/data_parsing/parse_chain/stroom_dal_chain.rb

@@ -0,0 +1,35 @@
+require 'p1_meter_reader/data_parsing/parse_chain/chainable'
+require 'p1_meter_reader/data_parsing/kwh_reader'
+
+module P1MeterReader
+  module DataParsing
+    module ParseChain
+      class StroomDalChain < Chainable
+        # This is primarily for testing
+        attr_accessor :last_value
+
+        def initialize(next_chain = nil)
+          super
+          self.last_value = kWh(0.0)
+        end
+
+        def can_handle?(line)
+          line.start_with? ("1-0:1.8.1")
+        end
+
+        def handle(lines_enumerator, output)
+          line = lines_enumerator.next
+
+          value = KwhReader.read(line)
+
+          if value
+            output.stroom_dal = value
+            output.diff_stroom_dal = value - last_value
+
+            self.last_value = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/data_parsing/parse_chain/stroom_piek_chain.rb

@@ -0,0 +1,31 @@
+require 'p1_meter_reader/data_parsing/parse_chain/chainable'
+require 'p1_meter_reader/data_parsing/kwh_reader'
+
+module P1MeterReader
+  module DataParsing
+    module ParseChain
+      class StroomPiekChain < Chainable
+        attr_accessor :last_value
+
+        def initialize(next_chain = nil)
+          super
+          self.last_value = kWh(0.0)
+        end
+
+        def can_handle?(line)
+          line.start_with?("1-0:1.8.2")
+        end
+
+        def handle(lines_enumerator, output)
+          line = lines_enumerator.next
+
+          value = KwhReader.read(line)
+          output.stroom_piek = value
+          output.diff_stroom_piek = value - last_value
+
+          self.last_value = value
+        end
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/data_parsing/parse_chain.rb

@@ -0,0 +1,6 @@
+require 'p1_meter_reader/data_parsing/parse_chain/chainable'
+require 'p1_meter_reader/data_parsing/parse_chain/gas_chain'
+require 'p1_meter_reader/data_parsing/parse_chain/skip_line_chain'
+require 'p1_meter_reader/data_parsing/parse_chain/stroom_current_chain'
+require 'p1_meter_reader/data_parsing/parse_chain/stroom_dal_chain'
+require 'p1_meter_reader/data_parsing/parse_chain/stroom_piek_chain'

data/lib/p1_meter_reader/data_parsing/stream_splitter.rb

@@ -0,0 +1,25 @@
+module P1MeterReader
+  module DataParsing
+    class StreamSplitter
+      def initialize(stream, message_start)
+        @message_start = message_start
+        @stream = stream.each_line
+      end
+
+      def read
+        while (@stream.peek).strip != @message_start
+          @stream.next
+        end
+
+        result = ""
+
+        loop do
+          line = @stream.next
+          result << line
+
+          return result if line.strip == "!"
+        end
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/data_parsing.rb

@@ -0,0 +1,5 @@
+require 'p1_meter_reader/data_parsing/fake_stream_splitter'
+require 'p1_meter_reader/data_parsing/kwh_reader'
+require 'p1_meter_reader/data_parsing/parse_chain'
+require 'p1_meter_reader/data_parsing/stream_splitter'
+

data/lib/p1_meter_reader/kwh.rb

@@ -0,0 +1,40 @@
+def kWh(value)
+  if value.is_a? Kwh
+    value
+  else
+    Kwh.new(Float(value))
+  end
+end
+
+class Kwh
+  def initialize(value)
+    self.value = value
+  end
+
+  def ==(other)
+    if other.is_a?(Kwh)
+      return (self - other).value.abs < 0.001
+    end
+
+    false
+  end
+
+  def -(other)
+    kWh(self.value - other.value)
+  end
+
+  def inspect
+    "#{value}kWh"
+  end
+
+  def to_s
+    inspect
+  end
+
+  def to_f
+    value
+  end
+
+  protected
+  attr_accessor :value
+end

data/lib/p1_meter_reader/models/measurement.rb

@@ -0,0 +1,23 @@
+module P1MeterReader
+  module Models
+    class Measurement
+      attr_accessor :time_stamp, :time_stamp_utc, :stroom_dal, :stroom_piek, :stroom_current, :gas
+      attr_accessor :diff_stroom_dal, :diff_stroom_piek, :diff_gas
+
+      def time_stamp_current_minute
+        self.time_stamp.strftime("%d-%m-%y %H:%M")
+      end
+
+      def time_stamp_next_minute
+        next_minute = self.time_stamp + 1.0/(24*60)
+        next_minute.strftime("%d-%m-%y %H:%M")
+      end
+
+      def to_s
+        date = self.time_stamp.strftime("%d-%m-%y %H:%M:%S")
+
+        "#{date}: #{stroom_dal} - #{stroom_piek} - #{stroom_current} - #{gas}"
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/models/measurement_parser.rb

@@ -0,0 +1,42 @@
+require 'date'
+
+require "p1_meter_reader/data_parsing/parse_chain/gas_chain"
+require "p1_meter_reader/data_parsing/parse_chain/stroom_dal_chain"
+require "p1_meter_reader/data_parsing/parse_chain/stroom_current_chain"
+require "p1_meter_reader/data_parsing/parse_chain/stroom_piek_chain"
+require "p1_meter_reader/data_parsing/parse_chain/skip_line_chain"
+
+require "p1_meter_reader/models/measurement"
+
+module P1MeterReader
+  module Models
+    class MeasurementParser
+      def initialize
+        super
+
+        @chain = P1MeterReader::DataParsing::ParseChain::StroomDalChain.new(
+          P1MeterReader::DataParsing::ParseChain::StroomPiekChain.new(
+            P1MeterReader::DataParsing::ParseChain::StroomCurrentChain.new(
+              P1MeterReader::DataParsing::ParseChain::GasChain.new(
+                P1MeterReader::DataParsing::ParseChain::SkipLineChain.new))))
+      end
+
+      def parse(input)
+        output = Models::Measurement.new
+
+        input = input.lines.to_enum
+
+        output.time_stamp = DateTime.now
+
+        # Convert to UTC before storing
+        output.time_stamp_utc = DateTime.now.new_offset(0)
+
+        while (true)
+          @chain.try(input, output)
+        end
+      rescue StopIteration
+        return output
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/models/usage.rb

@@ -0,0 +1,15 @@
+require 'ostruct'
+
+module P1MeterReader
+  module Models
+    class Usage < OpenStruct
+      def to_json(j)
+        {
+          time_stamp: time_stamp,
+          stroom_totaal: stroom_totaal,
+          gas: gas
+        }.to_json(j)
+      end
+    end
+  end
+end

data/lib/p1_meter_reader/models.rb

@@ -0,0 +1,3 @@
+require 'p1_meter_reader/models/measurement'
+require 'p1_meter_reader/models/measurement_parser'
+require 'p1_meter_reader/models/usage'

data/lib/p1_meter_reader/recorder.rb

@@ -0,0 +1,33 @@
+require "p1_meter_reader/models/measurement_parser"
+
+module P1MeterReader
+  class Recorder
+    def initialize(measurement_source:)
+      self.measurement_parser = Models::MeasurementParser.new
+      self.measurement_source = measurement_source
+    end
+
+    def collect_data(&block)
+      loop do
+        message = measurement_source.read
+
+        measurement = measurement_parser.parse(message)
+
+        yield measurement
+      end
+    end
+
+    protected
+    attr_accessor :measurement_parser, :measurement_source
+
+    private
+    def serial_port
+      serial_port = SerialPort.new("/dev/ttyUSB0", 9600)
+      serial_port.data_bits = 7
+      serial_port.stop_bits = 1
+      serial_port.parity = SerialPort::EVEN
+
+      serial_port
+    end
+  end
+end

data/lib/p1_meter_reader/version.rb

@@ -0,0 +1,3 @@
+module P1MeterReader
+  VERSION = "0.1.0"
+end

data/lib/p1_meter_reader.rb

@@ -0,0 +1,10 @@
+require "p1_meter_reader/version"
+
+require "p1_meter_reader/data_parsing"
+require "p1_meter_reader/kwh"
+require "p1_meter_reader/models"
+require "p1_meter_reader/recorder"
+
+module P1MeterReader
+  # Your code goes here...
+end

data/p1_meter_reader.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'p1_meter_reader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "p1_meter_reader"
+  spec.version       = P1MeterReader::VERSION
+  spec.authors       = ["Lennaert Meijvogel"]
+  spec.email         = ["l.meijvogel@yahoo.co.uk"]
+
+  #if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  #end
+
+  spec.summary       = %q{Read data from a compatible P1 smart meter}
+  spec.description   = %q{This is a library that reads and returns all (known) measurements that are returned by the P1 smart meter as used in the Netherlands.}
+  spec.homepage      = "https://github.com/lmeijvogel/p1_meter_reader_gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "serialport"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: p1_meter_reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lennaert Meijvogel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: This is a library that reads and returns all (known) measurements that
+  are returned by the P1 smart meter as used in the Netherlands.
+email:
+- l.meijvogel@yahoo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/p1_meter_reader.rb
+- lib/p1_meter_reader/data_parsing.rb
+- lib/p1_meter_reader/data_parsing/fake_stream_splitter.rb
+- lib/p1_meter_reader/data_parsing/kwh_reader.rb
+- lib/p1_meter_reader/data_parsing/parse_chain.rb
+- lib/p1_meter_reader/data_parsing/parse_chain/chainable.rb
+- lib/p1_meter_reader/data_parsing/parse_chain/gas_chain.rb
+- lib/p1_meter_reader/data_parsing/parse_chain/skip_line_chain.rb
+- lib/p1_meter_reader/data_parsing/parse_chain/stroom_current_chain.rb
+- lib/p1_meter_reader/data_parsing/parse_chain/stroom_dal_chain.rb
+- lib/p1_meter_reader/data_parsing/parse_chain/stroom_piek_chain.rb
+- lib/p1_meter_reader/data_parsing/stream_splitter.rb
+- lib/p1_meter_reader/kwh.rb
+- lib/p1_meter_reader/models.rb
+- lib/p1_meter_reader/models/measurement.rb
+- lib/p1_meter_reader/models/measurement_parser.rb
+- lib/p1_meter_reader/models/usage.rb
+- lib/p1_meter_reader/recorder.rb
+- lib/p1_meter_reader/version.rb
+- p1_meter_reader.gemspec
+homepage: https://github.com/lmeijvogel/p1_meter_reader_gem
+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.6
+signing_key: 
+specification_version: 4
+summary: Read data from a compatible P1 smart meter
+test_files: []