emu_power 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d6c6e6d6a64f468e6444fadddc097273e53c3d9ac39137e5aa98b9572f880fe
-  data.tar.gz: 975a4a0af9508b812694a3cfcb79feba1cf342f4751042d3d64b9bf34a87d423
+  metadata.gz: 1a735ca710b544606634af881808df7df97cac003dcd9425d0e6ad1800d94f5a
+  data.tar.gz: 407c3060e5fbe93825f4ddc86675a5bbf8c377d6758561345690ca7c8919114b
 SHA512:
-  metadata.gz: 98bd516022ccc746b236943c64e6dacb2cde05e96936a21f9e45b762d35bb0833df82542c260586f3bdf20dc74506abc7dce7842656820484a1c8be03fe5f418
-  data.tar.gz: d2175b774449b338d3ce38317551ab70ae2a6ca969ba2e43f8a26f9adc5eb05818dfc4785f6517b38c60137f33cbe25cc51dfee7b6453442467989e2e5cefdd1
+  metadata.gz: c37948b89801d604e9e92309c2c15c1c657c3d452be30d6243cabc9e05d5212a33b6e1b766c73cbe0b5850956b589fc6428ef69d1e0b11942648258a2338297b
+  data.tar.gz: 7e241b00ec429803aa74f12b81edde4cd5a30c968fcbc29f3ce618632fbad7d0d15bd862be58d89b7197c05bc9edf28c585eb6083dfe02fd737241ef745aefb0

data/lib/emu_power.rb

@@ -1,7 +1,6 @@
 class EmuPower
 end
 
-require 'emu_power/api'
-require 'emu_power/stream_parser'
-require 'emu_power/types'
-require 'emu_power/commands'
+require_relative 'emu_power/api'
+require_relative 'emu_power/notifications'
+require_relative 'emu_power/commands'

data/lib/emu_power/api.rb

@@ -2,133 +2,174 @@
 # unit. This API is asynchronous, and allows event handlers
 # to be registered for the various message types.
 
-require 'emu_power/stream_parser'
-require 'emu_power/types'
-
+require_relative 'notifications'
 require 'serialport'
-require 'nokogiri'
 
 class EmuPower::Api
 
 	LINE_TERMINATOR = "\r\n"
 
-	# Initialize the serial connection and build notification histories
-	def initialize(tty, history_length = 10)
+	attr_accessor :debug_mode
 
-		@port = SerialPort.new(tty, baud: 115200)
+	# Initialize the serial connection and set up internal structures.
+	def initialize(tty, debug: false)
 
-		@histories = {}
-		@callbacks = {}
-		EmuPower::Types::Notification.subclasses.each do |n|
-			@histories[n] = Array.new(history_length)
-			@callbacks[n] = nil
-		end
+		@port = SerialPort.new(tty, 115200, 8, 1, SerialPort::NONE)
+
+		# Get rid of any existing buffered data - we only want to operate on
+		# fresh notifications.
+		@port.flush_input
+		@port.flush_output
+
+		@debug_mode = debug
+
+		reset_callbacks!
 
 	end
 
-	# Register the callback for specific notification events. Expects
-	# a subclass of Types::Notification. If :global is passed for klass,
-	# the callback will be triggered for every event in addition to the
-	# normal callback. Note that only one callback may be registered
-	# per event - setting another will replace the existing one.
+	# Register the callback for specific notification events. Expects either an
+	# EmuPower::Notifications::Notification subclass, or :global, or :fallback. If :global
+	# is passed, the callback will be fired on every notification. If :fallback is
+	# passed, the callback will be fired for every notification that does not have
+	# a specific callback registered already.
 	def callback(klass, &block)
-		@callbacks[klass] = block
+
+		if klass == :global || klass == 'global'
+			@global_callback = block
+		elsif klass == :fallback || klass == 'fallback'
+			@fallback_callback = block
+		elsif EmuPower::Notifications::Notification.subclasses.include?(klass)
+			@callbacks[klass] = block
+		else
+			klass_list = EmuPower::Notifications::Notification.subclasses.map(&:name).join(', ')
+			raise ArgumentError.new("Class must be :global, :fallback, or one of #{klass_list}")
+		end
+
 		return true
+
+	end
+
+	# Reset all callbacks to the default no-op state.
+	def reset_callbacks!
+		@global_callback = nil
+		@fallback_callback = nil
+		@callbacks = {}
 	end
 
 	# Send a command to the device. Expects an instance of one of the
 	# command classes defined in commands.rb. The serial connection
 	# must be started before this can be used.
 	def issue_command(obj)
-		return false if @thread.nil?
-		return false unless obj.respond_to?(:to_command)
+
+		return false if @thread.nil? || !obj.respond_to?(:to_command)
+
 		xml = obj.to_command
 		@port.write(xml)
+
 		return true
+
 	end
 
-	# Begin polling for serial data. We spawn a new thread to
-	# handle this so we don't block input. If blocking is set
-	# to true, this method blocks indefinitely. If false, it
-	# returns true and expects the caller to handle things.
-	def start_serial(interval: 1, blocking: true)
+	# Begin polling for serial data. We spawn a new thread to handle this so we don't
+	# block input. This method blocks until the reader thread terminates, which in most
+	# cases is never. This should usually be called at the end of a program after all
+	# callbacks are registered. If blocking is set to false, returns immediately and
+	# lets the caller handle the spawned thread. Non-blocking mode should mostly be
+	# used for development purposes; most production scripts should use blocking mode
+	# and callbacks.
+	def start_serial(blocking = true)
 
 		return false unless @thread.nil?
 
-		parser = construct_parser
-
 		@thread = Thread.new do
+
+			# Define boundary tags
+			root_elements = EmuPower::Notifications.notify_roots
+			start_tags = root_elements.map { |v| "<#{v}>" }
+			stop_tags = root_elements.map { |v| "</#{v}>" }
+
+			current_notify = ''
+
+			# Build up complete XML fragments line-by-line and dispatch callbacks
 			loop do
-				begin
-					parser.parse
-					sleep(interval)
-				rescue Nokogiri::XML::SyntaxError
-					# This means that we probably connected in the middle
-					# of a message, so just reset the parser.
-					parser = construct_parser
+
+			  line = @port.readline(LINE_TERMINATOR).strip
+
+				if start_tags.include?(line)
+					current_notify = line
+
+				elsif stop_tags.include?(line)
+
+					xml = current_notify + line
+					current_notify = ''
+
+					begin
+						obj = EmuPower::Notifications.construct(xml)
+					rescue StandardError
+						puts "Failed to construct object for XML fragment: #{xml}" if @debug_mode
+						next
+					end
+
+					if obj
+						puts obj if @debug_mode
+						perform_callbacks(obj)
+					else
+						puts "Incomplete XML stream: #{xml}" if @debug_mode
+					end
+
+				else
+					current_notify += line
 				end
+
 			end
 		end
 
 		if blocking
-			@thread.join
+
+			# Block until thread is terminated, and ensure we clean up after ourselves.
+			begin
+				@thread.join
+			ensure
+				stop_serial if @thread
+			end
+
 		else
-			return true
+			return @thread
 		end
 
 	end
 
-	# Stop polling for data. Already-received objects will
-	# remain available.
+	# Terminate the reader thread. The start_serial method will return
+	# once this is called. This will usually be called from a signal
+	# trap or similar, since the main program will usually be blocked
+	# by start_serial.
 	def stop_serial
+
 		return false if @thread.nil?
+
 		@thread.terminate
 		@thread = nil
-		return true
-	end
 
-	# Get the full history buffer for a given notify type
-	def history_for(klass)
-		return @histories[klass].compact
-	end
+		return true
 
-	# Get the most recent object for the given type
-	def current(klass)
-		return history_for(klass)[0]
 	end
 
 	private
 
-	# Handle the completed hash objects when notified by the parser
-	def handle_response(obj)
-
-		container = EmuPower::Types.construct(obj)
+	# Dispatch the appropriate callback
+	def perform_callbacks(obj)
 
-		if container == nil
-			puts "BAD OBJECT #{obj}"
-		else
-			push_history(container)
-			@callbacks[container.class]&.call(container)
-			@callbacks[:global]&.call(container)
-		end
+		klass = obj.class
 
-	end
+		# Fire global callback
+		@global_callback&.call(obj)
 
-	# Helper for initializing underlying parser
-	def construct_parser
-		return EmuPower::StreamParser.new(@port, LINE_TERMINATOR, EmuPower::Types.notify_roots) do |obj|
-			handle_response(obj)
+		klass_specific = @callbacks[klass]
+		if klass_specific
+			klass_specific.call(obj)
+		else
+			@fallback_callback&.call(obj)
 		end
-	end
-
-	# Helper for inserting object into appropriate history queue
-	def push_history(obj)
-		
-		type = obj.class
-
-		old = @histories[type].pop
-		@histories[type].prepend(obj)
-		return old
 
 	end
 

data/lib/emu_power/commands.rb

@@ -1,5 +1,6 @@
-# Collection of command types for controlling various
-# functions on the EMU device.
+# Collection of command types for controlling various functions on the EMU
+# device. These should be constructed and passed as arguments to the API
+# object's issue_command method.
 
 class EmuPower::Commands
 
@@ -32,49 +33,108 @@ class EmuPower::Commands
 
 	end
 
-	class GetNetworkInfo < Command
+	# Helper class for defining basic commands easily. Uses the current class
+	# name to define the Command Name element of the output XML.
+	class BasicCommand < Command
 		def initialize
-			super('get_network_info')
+
+			class_name = self.class.name.split('::').last
+			command_name = class_name
+												 .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+												 .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+												 .tr("-", "_")
+												 .downcase
+			super(command_name)
+
 		end
 	end
 
-	class GetNetworkStatus < Command
-		def initialize
-			super('get_network_status')
-		end
+
+	# Restart the EMU device.
+	class Restart < BasicCommand
 	end
 
-	class GetInstantaneousDemand < Command
-		def initialize
-			super('get_instantaneous_demand')
-		end
+	# Get the current time. Triggers a TimeCluster notification.
+	class GetTime < BasicCommand
 	end
 
-	class GetPrice < Command
-		def initialize
-			super('get_price')
-		end
+	# Get current messages from the device. Triggers a MessageCluster
+	# notification for each message.
+	class GetMessage < BasicCommand
 	end
 
-	class GetMessage < Command
-		def initialize
-			super('get_message')
-		end
+	# Request information about the meter network. Triggers a
+	# NetworkInfo notification.
+	class GetNetworkInfo < BasicCommand
 	end
 
-	# TODO: Confirm Message
+	# Request information about the connection between the EMU-2
+	# and the meter. Triggers a ConnectionStatus notification.
+	class GetConnectionStatus < BasicCommand
+	end
 
-	class GetCurrentSummation < Command
-		def initialize
-			super('get_current_summation')
-		end
+	# Request a list of all connected meters. This triggers one
+	# MeterList notification for each connected meter.
+	class GetMeterList < BasicCommand
 	end
 
-	# TODO: Get History Data
+	# Get detailed info on a specific meter. If more than one
+	# meter is connected, a MAC must be passed to identify
+	# the target. Triggers a MeterInfo notification.
+	# TODO: Allow passing meter MAC argument
+	class GetMeterInfo < BasicCommand
+	end
+
+	# Request information about the EMU-2 device. Triggers a
+	# DeviceInfo notification.
+	class GetDeviceInfo < BasicCommand
+	end
 
-	# Note: This doesn't seem to work. The command is issued successfully, but
-	# the EMU does not update any schedule info. This may be disallowed by the
-	# meter or something.
+	# Get the current fast poll period. Triggers a FastPollStatus
+	# notification.
+	class GetFastPollStatus < BasicCommand
+	end
+
+	# Get the running total since the last CloseCurrentPeriod
+	# command was issued. Triggers a CurrentPeriodUsage notify
+	class GetCurrentPeriodUsage < BasicCommand
+	end
+
+	# Close out the current billing period. Does not trigger
+	# any notifications.
+	class CloseCurrentPeriod < BasicCommand
+	end
+
+	# Get the previous billing period's usage. Triggers a TODO
+	class GetLastPeriodUsage < BasicCommand
+	end
+
+	# Get the current power draw in kilowatts. Triggers an
+	# InstantaneousDemand notification.
+	class GetInstantaneousDemand < BasicCommand
+	end
+
+	# Get the current meter reading. This is independent of the
+	# current period usage.
+	class GetCurrentSummationDelivered < BasicCommand
+	end
+
+	# Get the current electricity rate. This is either provided
+	# by the meter, or set manually on the device during setup.
+	# This triggers a PriceCluster notification.
+	class GetCurrentPrice < BasicCommand
+	end
+
+	# Get the current block prices. This triggers a BlockPriceDetail
+	# notification, and is only applicable to block-based billing
+	# schemes.
+	class GetPriceBlocks < BasicCommand
+	end
+
+	# Set the notification schedule on the EMU. Note: this only seems to be effective shortly after the
+	# unit starts up, while the modes of the schedule are all 'default'. After that, the meter seems to
+	# push a schedule configuration and set the mode to 'rest', which overwrites the existing schedule
+	# and ignores subsequent SetSchedule commands.
 	class SetSchedule < Command
 
 		EVENTS = %w[time message price summation demand scheduled_prices profile_data billing_period block_period]
@@ -89,7 +149,8 @@ class EmuPower::Commands
 
 	end
 
-	# TODO: Add event field
+	# Get the current event schedule. This triggers one ScheduleInfo notification for
+	# each of the listed event types.
 	class GetSchedule < Command
 
 		EVENTS = %w[time message price summation demand scheduled_prices profile_data billing_period block_period]
@@ -104,8 +165,7 @@ class EmuPower::Commands
 			end
 
 		end
-	end
 
-	# TODO: Reboot
+	end
 
 end

data/lib/emu_power/notifications.rb

@@ -0,0 +1,392 @@
+# Notification types. Provides convenience calculators and
+# accessors for the notifications sent by the EMU device.
+
+require 'nori'
+
+class EmuPower::Notifications
+
+	# Base class for notifications
+	class Notification
+
+		# Timestamp of Jan 1st 2000. Used to shift epoch to standard timestamp.
+		UNIX_TIME_OFFSET = 946684800
+
+		attr_accessor :raw
+		attr_accessor :device_mac
+		attr_accessor :meter_mac
+		attr_accessor :timestamp
+
+		def initialize(hash)
+
+			@raw = hash
+
+			# All messages may contain this metadata
+			@device_mac = @raw['DeviceMacId']
+			@meter_mac = @raw['MeterMacId']
+
+			# The EMU sets timestamps relative to Jan 1st 2000 UTC. We convert
+			# these into more standard Unix epoch timestamps by adding the
+			# appropriate offset.
+			@timestamp = parse_timestamp('TimeStamp')
+
+			# Build out type-specific fields
+			build(hash)
+
+		end
+
+		def build(hash)
+			# Overridden by subclasses
+		end
+
+		def parse_timestamp(prop)
+			v = @raw[prop]
+			return nil if v == nil
+			return Integer(v) + 946684800
+		end
+
+		def parse_hex(prop)
+			v = @raw[prop]
+			return nil if v.nil?
+			return Integer(v)
+		end
+		
+		def parse_bool(prop)
+			v = @raw[prop]
+			return nil if v.nil?
+			return (@raw[prop] == 'Y') ? true : false
+		end
+
+		# Calculate real total from divisors and multipliers
+		def parse_amount(prop, mul_prop = 'Multiplier', div_prop = 'Divisor')
+
+			multiplier = parse_hex(mul_prop)
+			divisor = parse_hex(div_prop)
+			v = parse_hex(prop)
+
+			return 0.0 if v.nil? || multiplier.nil? || divisor.nil?
+			return multiplier * v / Float(divisor)
+
+		end
+
+		def to_s
+			"#{self.class.root_name} Notification: #{@raw.to_s}"
+		end
+
+		# Name of the XML root object corresponding to this type
+		def self.root_name
+			return self.name.split('::').last
+		end
+
+		def self.subclasses
+			return ObjectSpace.each_object(::Class).select do |k|
+				k < self
+			end
+		end
+
+	end
+
+	# Dispatch to the appropriate container class based
+	# on the type. Expects a data hash. Returns nil on
+	# bad message.
+	def self.construct(xml)
+
+		hash = Nori.new.parse(xml)
+
+		# Extract the root of the hash and dispatch to the appropriate
+		# container class.
+		type, data = hash.first
+
+		return nil unless notify_roots.include?(type)
+
+		klass = self.const_get(type)
+		return klass.new(data)
+
+	end
+
+	# Helper to get the element names of all types
+	def self.notify_roots
+		return Notification.subclasses.map(&:root_name)
+	end
+
+	###
+	# Begin notification objects
+	###
+
+	class TimeCluster < Notification
+
+		attr_accessor :utc_time
+		attr_accessor :local_time
+
+		def build(hash)
+			self.utc_time = parse_timestamp('UTCTime')
+			self.local_time = parse_timestamp('LocalTime')
+		end
+
+	end
+
+	class MessageCluster < Notification
+
+		attr_accessor :id
+		attr_accessor :text
+		attr_accessor :priority
+		attr_accessor :start_time
+		attr_accessor :duration
+		attr_accessor :confirmation_required
+		attr_accessor :confirmed
+		attr_accessor :queue
+
+		def build(hash)
+			self.id = hash['Id']
+			self.text = hash['Text']
+			self.priority = hash['Priority']
+			self.start_time = parse_timestamp('StartTime')
+			self.duration = parse_hex('Duration')
+			self.confirmation_required = parse_bool('ConfirmationRequired')
+			self.confirmed = parse_bool('Confirmed')
+			self.queue = hash['Queue']
+		end
+
+	end
+
+	class NetworkInfo < Notification
+
+		attr_accessor :coordinator_mac
+		attr_accessor :status
+		attr_accessor :description
+		attr_accessor :pan_id
+		attr_accessor :channel
+		attr_accessor :short_address
+		attr_accessor :link_strength
+
+		def build(hash)
+			self.coordinator_mac = parse_hex('CoordMacId')
+			self.status = hash['Status']
+			self.description = hash['Description']
+			self.pan_id = hash['ExtPanId']
+			self.channel = hash['Channel']
+			self.short_address = hash['ShortAddr']
+			self.link_strength = parse_hex('LinkStrength')
+		end
+
+	end
+
+	class ConnectionStatus < Notification
+
+		attr_accessor :status
+		attr_accessor :description
+		attr_accessor :pan_id
+		attr_accessor :channel
+		attr_accessor :short_address
+		attr_accessor :link_strength
+
+		def build(hash)
+			self.status = hash['Status']
+			self.description = hash['Description']
+			self.pan_id = hash['ExtPanId']
+			self.channel = hash['Channel']
+			self.short_address = hash['ShortAddr']
+			self.link_strength = parse_hex('LinkStrength')
+		end
+
+	end
+
+	# Note: This has no fields except DeviceMacId and MeterMacId
+	class MeterList < Notification
+	end
+
+	class MeterInfo < Notification
+
+		attr_accessor :type
+		attr_accessor :nickname
+		attr_accessor :account
+		attr_accessor :auth
+		attr_accessor :host
+		attr_accessor :enabled
+
+		def build(hash)
+			self.type = parse_hex('Type')
+			self.nickname = hash['Nickname']
+			self.account = hash['Account']
+			self.auth = hash['Auth']
+			self.host = hash['Host']
+			self.enabled = parse_bool('Enabled')
+		end
+
+	end
+
+	class DeviceInfo < Notification
+
+		attr_accessor :install_code
+		attr_accessor :link_key
+		attr_accessor :firmware_version
+		attr_accessor :hardware_version
+		attr_accessor :image_type
+		attr_accessor :manufacturer
+		attr_accessor :model
+		attr_accessor :date_code
+
+		def build(hash)
+			self.install_code = hash['InstallCode']
+			self.link_key = hash['LinkKey']
+			self.firmware_version = hash['FWVersion']
+			self.hardware_version = hash['HWVersion']
+			self.image_type = hash['ImageType']
+			self.manufacturer = hash['Manufacturer']
+			self.model = hash['ModelId']
+			self.date_code = hash['DateCode']
+		end
+
+	end
+
+	class FastPollStatus < Notification
+
+		attr_accessor :frequency
+		attr_accessor :end_time
+
+		def build(hash)
+			self.frequency = parse_hex('Frequency')
+			self.end_time = parse_timestamp('EndTime')
+		end
+
+	end
+
+	class CurrentPeriodUsage < Notification
+
+		attr_accessor :usage
+		attr_accessor :digits_right
+		attr_accessor :digits_left
+		attr_accessor :suppress_leading_zeroes
+		attr_accessor :start_date
+
+		def build(hash)
+			self.usage = parse_amount('CurrentUsage')
+			self.digits_right = parse_hex('DigitsRight')
+			self.digits_left = parse_hex('DigitsLeft')
+			self.suppress_leading_zeroes = parse_bool('SuppressLeadingZero')
+			self.start_date = parse_timestamp('StartDate')
+
+		end
+
+	end
+
+	class LastPeriodUsage < Notification
+
+		attr_accessor :usage
+		attr_accessor :digits_right
+		attr_accessor :digits_left
+		attr_accessor :suppress_leading_zeroes
+		attr_accessor :start_date
+		attr_accessor :end_date
+
+		def build(hash)
+			self.usage = parse_amount('LastUsage')
+			self.digits_right = parse_hex('DigitsRight')
+			self.digits_left = parse_hex('DigitsLeft')
+			self.suppress_leading_zeroes = parse_bool('SuppressLeadingZero')
+			self.start_date = parse_timestamp('StartDate')
+			self.end_date = parse_timestamp('EndDate')
+		end
+
+	end
+
+	class InstantaneousDemand < Notification
+
+		attr_accessor :demand
+		attr_accessor :digits_right
+		attr_accessor :digits_left
+		attr_accessor :suppress_leading_zeroes
+
+		def build(hash)
+			self.demand = parse_amount('Demand')
+			self.digits_right = parse_hex('DigitsRight')
+			self.digits_left = parse_hex('DigitsLeft')
+			self.suppress_leading_zeroes = parse_bool('SuppressLeadingZero')
+		end
+
+	end
+
+	class CurrentSummationDelivered < Notification
+
+		attr_accessor :delivered
+		attr_accessor :received
+		attr_accessor :digits_right
+		attr_accessor :digits_left
+		attr_accessor :suppress_leading_zeroes
+
+		def build(hash)
+			self.delivered = parse_amount('SummationDelivered')
+			self.received = parse_amount('SummationReceived')
+			self.digits_right = parse_hex('DigitsRight')
+			self.digits_left = parse_hex('DigitsLeft')
+			self.suppress_leading_zeroes = parse_bool('SuppressLeadingZero')
+		end
+
+	end
+
+	class PriceCluster < Notification
+
+		attr_accessor :price
+		attr_accessor :currency_code		# This is an ISO 3-digit currency code. 840 is USD
+		attr_accessor :trailing_digits
+		attr_accessor :tier
+		attr_accessor :start_time
+		attr_accessor :duration
+		attr_accessor :label
+
+		def build(hash)
+			self.price = parse_hex('Price')
+			self.currency_code = parse_hex('Currency')
+			self.trailing_digits = parse_hex('TrailingDigits')
+			self.tier = parse_hex('Tier')
+			self.start_time = parse_timestamp('StartTime')
+			self.duration = parse_hex('Duration')
+			self.label = hash['RateLabel']
+		end
+
+	end
+
+	class BlockPriceDetail < Notification
+
+		attr_accessor :current_start
+		attr_accessor :current_duration
+		attr_accessor :block_consumption
+		attr_accessor :number_of_blocks
+		attr_accessor :currency_code
+		attr_accessor :trailing_digits
+
+		def build(hash)
+			self.current_start = parse_timestamp('CurrentStart')
+			self.current_duration = parse_hex('CurrentDuration')
+			self.block_consumption = parse_amount(
+					'BlockPeriodConsumption',
+					'BlockPeriodConsumptionMultiplier',
+					'BlockPeriodConsumptionDivisor'
+			)
+
+			# Note: Not sure if multiplier/divisor are supposed to tie in here
+			self.number_of_blocks = parse_amount('NumberOfBlocks')
+
+			self.currency_code = parse_hex('Currency')
+			self.trailing_digits = parse_hex('TrailingDigits')
+
+		end
+
+	end
+
+	class ScheduleInfo < Notification
+
+		attr_accessor :mode
+		attr_accessor :event
+		attr_accessor :frequency
+		attr_accessor :enabled
+
+		def build(hash)
+			self.mode = hash['Mode']
+			self.event = hash['Event']
+			self.frequency = parse_hex('Frequency')
+			self.enabled = parse_bool('Enabled')
+		end
+
+	end
+
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: emu_power
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Steven Bertolucci
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: nori
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: serialport
   requirement: !ruby/object:Gem::Requirement
@@ -47,8 +47,7 @@ files:
 - lib/emu_power.rb
 - lib/emu_power/api.rb
 - lib/emu_power/commands.rb
-- lib/emu_power/stream_parser.rb
-- lib/emu_power/types.rb
+- lib/emu_power/notifications.rb
 - readme.md
 homepage: https://github.com/Steve0320/EmuPower
 licenses:

data/lib/emu_power/stream_parser.rb

@@ -1,118 +0,0 @@
-# SAX parser implementation for processing a stream of
-# XML fragments.
-
-require 'nokogiri'
-
-class EmuPower::StreamParser < Nokogiri::XML::SAX::Document
-
-	FAKEROOT = 'FAKEROOT'
-
-	def initialize(io, line_terminator, roots, &block)
-
-		@line_terminator = line_terminator
-		@io = io
-
-		# Use a push parser so we can fake a single root element
-		@parser = Nokogiri::XML::SAX::PushParser.new(Parser.new(FAKEROOT, roots, &block))
-
-		# This is the "root" of the document. We intentionally never close this
-		# so that the parser doesn't get mad when it encounters multiple real
-		# root elements.
-		@parser << "<#{FAKEROOT}>"
-
-	end
-
-	# Push all new lines from the io into the parser. The parser
-	# will fire the callback given on construction once a whole
-	# object has been processed.
-	def parse
-		lines = @io.readlines(@line_terminator)
-		lines.each { |l| @parser << l }
-	end
-
-	# Nokogiri parser definition. Processes a flat XML
-	# stream with multiple roots.
-	class Parser < Nokogiri::XML::SAX::Document
-
-		# Initialize the set of root tags to consider
-		def initialize(fakeroot, roots, &block)
-
-			@roots = roots
-
-			@current_object = nil
-			@current_property = nil
-			@current_root = nil
-
-			@callback = block
-
-			# All element parsers ignore this tag. This is only
-			# used to persuade Nokogiri to parse multiple roots
-			# in a single stream without getting mad.
-			@fakeroot = fakeroot
-
-		end
-
-		# For each tag, initialize a root element if we don't already have
-		# one. Otherwise, consider it a property of the current element.
-		def start_element(name, attrs = [])
-
-			return if name == @fakeroot
-			return if @current_object == nil && !@roots.include?(name)
-
-			if @current_object == nil
-				@current_root = name
-				@current_object = { "MessageType" => name }
-			else
-				@current_property = name
-			end
-
-		end
-
-		# Populate the content of the current element
-		def characters(str)
-			if @current_object != nil && @current_property != nil
-
-				#cur = @current_object[@current_property]
-				#return if cur == str
-
-				# Wrap into array if we already have a value (XML permits duplicates)
-				#cur = [cur] unless cur == nil
-				
-				#if cur.kind_of?(Array)
-				#	cur << str
-				#else
-				#	cur = str
-				#end
-
-				#@current_object[@current_property] = cur
-
-				@current_object[@current_property] = str
-
-			end
-		end
-
-		# Close out the current tag and clear context
-		def end_element(name, attrs = [])
-
-			return if name == @fakeroot
-			
-			if @current_root == name
-
-				if @callback != nil
-					@callback.call(@current_object)
-				else
-					puts "DEBUG: #{@current_object}"
-				end
-				
-				@current_object = nil
-				@current_root = nil
-
-			elsif @current_object != nil
-				@current_property = nil
-			end
-
-		end
-
-	end
-
-end

data/lib/emu_power/types.rb

@@ -1,212 +0,0 @@
-# Notification types. Provides convenience calculators and
-# accessors for the notifications sent by the EMU device.
-class EmuPower::Types
-
-	# Base class for notifications
-	class Notification
-
-		UNIX_TIME_OFFSET = 946684800
-
-		attr_accessor :raw
-		attr_accessor :device_mac
-		attr_accessor :meter_mac
-		attr_accessor :timestamp
-
-		def initialize(hash)
-			@raw = hash
-			@device_mac = @raw['DeviceMacId']
-			@meter_mac = @raw['MeterMacId']
-			build(hash)
-		end
-
-		def build(hash)
-		end
-
-		# The EMU sets timestamps relative to Jan 1st 2000 UTC. We convert
-		# these into more standard Unix epoch timestamps by adding the
-		# appropriate offset.
-		def timestamp
-			parse_timestamp('TimeStamp')
-		end
-
-		def parse_timestamp(prop)
-			v = @raw[prop]
-			return nil if v == nil
-			return Integer(v) + 946684800
-		end
-
-		def parse_hex(prop)
-			v = @raw[prop]
-			return nil if v.nil?
-			return Integer(v)
-		end
-		
-		def parse_bool(prop)
-			v = @raw[prop]
-			return nil if v.nil?
-			return (@raw[prop] == 'Y') ? true : false
-		end
-
-		# Name of the XML root object corresponding to this type
-		def self.root_name
-			return self.name.split('::').last
-		end
-
-		def self.subclasses
-			return ObjectSpace.each_object(::Class).select do |k|
-				k < self
-			end
-		end
-
-	end
-
-	# TODO
-	class ConnectionStatus < Notification
-	end
-
-	# TODO
-	class DeviceInfo < Notification
-	end
-
-	class ScheduleInfo < Notification
-
-		attr_accessor :mode
-		attr_accessor :event
-		attr_accessor :frequency
-		attr_accessor :enabled
-
-		def build(hash)
-			self.mode = hash['Mode']
-			self.event = hash['Event']
-			self.frequency = parse_hex('Frequency')
-			self.enabled = parse_bool('Enabled')
-		end
-
-	end
-
-	# TODO
-	class MeterList < Notification
-	end
-
-	# TODO
-	class MeterInfo < Notification
-	end
-
-	# TODO
-	class NetworkInfo < Notification
-	end
-
-	class TimeCluster < Notification
-
-		attr_accessor :utc_time
-		attr_accessor :local_time
-
-		def build(hash)
-			self.utc_time = parse_timestamp('UTCTime')
-			self.local_time = parse_timestamp('LocalTime')
-		end
-
-	end
-
-	# TODO
-	class MessageCluster < Notification
-	end
-
-	# TODO
-	class PriceCluster < Notification
-	end
-
-	class InstantaneousDemand < Notification
-
-		attr_accessor :raw_demand
-		attr_accessor :multiplier
-		attr_accessor :divisor
-		attr_accessor :digits_right
-		attr_accessor :digits_left
-		attr_accessor :suppress_leading_zeroes
-
-		def build(hash)
-			self.raw_demand = parse_hex('Demand')
-			self.multiplier = parse_hex('Multiplier')
-			self.divisor = parse_hex('Divisor')
-			self.digits_right = parse_hex('DigitsRight')
-			self.digits_left = parse_hex('DigitsLeft')
-			self.suppress_leading_zeroes = parse_bool('SuppressLeadingZero')
-		end
-
-		# Return computed demand in KW. This may return nil if data is missing.
-		def demand
-			return 0 if self.divisor == 0
-			return nil if self.multiplier.nil? || self.raw_demand.nil? || self.divisor.nil?
-			return self.multiplier * self.raw_demand / Float(self.divisor)
-		end
-
-	end
-
-	class CurrentSummationDelivered < Notification
-
-		attr_accessor :raw_delivered
-		attr_accessor :raw_received
-		attr_accessor :multiplier
-		attr_accessor :divisor
-		attr_accessor :digits_right
-		attr_accessor :digits_left
-		attr_accessor :suppress_leading_zeroes
-
-		def build(hash)
-
-			self.raw_delivered = parse_hex('SummationDelivered')
-			self.raw_received = parse_hex('SummationReceived')
-			self.multiplier = parse_hex('Multiplier')
-			self.divisor = parse_hex('Divisor')
-			self.digits_right = parse_hex('DigitsRight')
-			self.digits_left = parse_hex('DigitsLeft')
-			self.suppress_leading_zeroes = parse_bool('SuppressLeadingZero')
-
-		end
-
-		def delivered
-			return 0 if self.raw_delivered == 0
-			return nil if self.multiplier.nil? || self.raw_delivered.nil? || self.divisor.nil?
-			return self.multiplier * self.raw_delivered / Float(self.divisor)
-		end
-
-		def received
-			return 0 if self.divisor == 0
-			return nil if self.multiplier.nil? || self.raw_received.nil? || self.divisor.nil?
-			return self.multiplier * self.raw_received / Float(self.divisor)
-		end
-		
-	end
-
-	# TODO
-	class CurrentPeriodUsage < Notification
-	end
-
-	# TODO
-	class LastPeriodUsage < Notification
-	end
-
-	# TODO
-	class ProfileData < Notification
-	end
-
-	# Dispatch to the appropriate container class based
-	# on the type. Expects a data hash. Returns nil on
-	# bad message.
-	def self.construct(data)
-
-		type = data['MessageType']
-		return nil if type == nil || !notify_roots.include?(type)
-
-		klass = self.const_get(type)
-		return klass.new(data)
-
-	end
-
-	# Helper to get the element names of all types
-	def self.notify_roots
-		return Notification.subclasses.map(&:root_name)
-	end
-
-end