ow 0.0.1 → 0.1.0

data/README.md

@@ -18,7 +18,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    require 'ow'
+
+    # Parse XML from file
+    server = Ow.parse_file('file.xml')
+
+    # Parse XML from string
+    server = Ow.parse("<?xml (...)")
+
+    server
+    => #<Ow::Server:0x007fa1141c1648>
+
+    server.devices
+    => [#<Ow::Devices::DS18B20:0x007fa1141b4c90,
+      #<Ow::Devices::DS2423:0x007fa1141a5ee8]
+
+    server.devices.first.temperature
+    => "6.1875"
+
+## To do
+
+### Device definions
+
+* Default conversion for element names (automatically convert to
+  snake-case).
+* Type coercion for elements (temperatures should be float, not string,
+  etc.)
+* Move common fields (Name, ROMId, etc.) to the Device module to avoid
+  duplication.
 
 ## Contributing
 

data/lib/ow.rb

@@ -1,5 +1,24 @@
-require "ow/version"
+Dir[File.join(File.dirname(__FILE__), 'ow', 'devices', '*.rb')].each { |file| require file }
+
+require 'ow/device'
+require 'ow/parser'
+require 'ow/server'
+require 'ow/version'
+
+require 'ox'
 
 module Ow
-  # Your code goes here...
+  def self.parse_document(document)
+    Ow::Server.from_document(document.root)
+  end
+
+  def self.parse_file(filename)
+    document = Ox.load_file(filename)
+    parse_document(document)
+  end
+
+  def self.parse(string)
+    document = Ox.parse(string)
+    parse_document(document)
+  end
 end

data/lib/ow/device.rb

@@ -0,0 +1,13 @@
+require 'ow/parser'
+
+module Ow
+  module Device
+    def self.included(base)
+      types[base.name.split("::").last] = base
+    end
+
+    def self.types
+      @types ||= {}
+    end
+  end
+end

data/lib/ow/devices/ds18b20.rb

@@ -0,0 +1,24 @@
+require "ow/device"
+require "ow/parser"
+
+module Ow
+  module Devices
+    class DS18B20
+      include Ow::Device
+      include Ow::Parser
+
+      element :Name,          as: :name
+      element :Family,        as: :family
+      element :ROMId,         as: :rom_id
+      element :Health,        as: :health
+      element :Channel,       as: :channel
+      element :RawData,       as: :raw_data
+      element :PrimaryValue,  as: :primary_value
+      element :Temperature,   as: :temperature
+      element :UserByte1,     as: :user_byte_1
+      element :UserByte2,     as: :user_byte_2
+      element :Resolution,    as: :resolution
+      element :PowerSource,   as: :power_source
+    end
+  end
+end

data/lib/ow/devices/ds2423.rb

@@ -0,0 +1,21 @@
+require "ow/device"
+require "ow/parser"
+
+module Ow
+  module Devices
+    class DS2423
+      include Ow::Device
+      include Ow::Parser
+
+      element :Name,          as: :name
+      element :Family,        as: :family
+      element :ROMId,         as: :rom_id
+      element :Health,        as: :health
+      element :Channel,       as: :channel
+      element :RawData,       as: :raw_data
+      element :PrimaryValue,  as: :primary_value
+      element :Counter_A,     as: :counter_a
+      element :Counter_B,     as: :counter_b
+    end
+  end
+end

data/lib/ow/devices/ds2450.rb

@@ -0,0 +1,41 @@
+require "ow/device"
+require "ow/parser"
+
+module Ow
+  module Devices
+    class DS2450
+      include Ow::Device
+      include Ow::Parser
+
+      element :Name,                          as: :name
+      element :Family,                        as: :family
+      element :ROMId,                         as: :rom_id
+      element :Health,                        as: :health
+      element :Channel,                       as: :channel
+      element :RawData,                       as: :raw_data
+      element :PrimaryValue,                  as: :primary_value
+      element :ChannelAConversionValue,       as: :channel_a_conversion_value
+      element :ChannelAConversionResolution,  as: :channel_a_conversion_resolution
+      element :ChannelAConversionRange,       as: :channel_a_conversion_range
+      element :ChannelAOutputEnable,          as: :channel_a_output_enable
+      element :ChannelAOutputControl,         as: :channel_a_output_control
+      element :ChannelBConversionValue,       as: :channel_b_conversion_value
+      element :ChannelBConversionResolution,  as: :channel_b_conversion_resolution
+      element :ChannelBConversionRange,       as: :channel_b_conversion_range
+      element :ChannelBOutputEnable,          as: :channel_b_output_enable
+      element :ChannelBOutputControl,         as: :channel_b_output_control
+      element :ChannelCConversionValue,       as: :channel_c_conversion_value
+      element :ChannelCConversionResolution,  as: :channel_c_conversion_resolution
+      element :ChannelCConversionRange,       as: :channel_c_conversion_range
+      element :ChannelCOutputEnable,          as: :channel_c_output_enable
+      element :ChannelCOutputControl,         as: :channel_c_output_control
+      element :ChannelDConversionValue,       as: :channel_d_conversion_value
+      element :ChannelDConversionResolution,  as: :channel_d_conversion_resolution
+      element :ChannelDConversionRange,       as: :channel_d_conversion_range
+      element :ChannelDOutputEnable,          as: :channel_d_output_enable
+      element :ChannelDOutputControl,         as: :channel_d_output_control
+      element :PowerOnReset,                  as: :power_on_reset
+      element :VCCControl,                    as: :vcc_control
+    end
+  end
+end

data/lib/ow/devices/eds0068.rb

@@ -0,0 +1,27 @@
+require "ow/device"
+require "ow/parser"
+
+module Ow
+  module Devices
+    class EDS0068
+      include Ow::Device
+      include Ow::Parser
+
+      element :Name,                  as: :name
+      element :Family,                as: :family
+      element :ROMId,                 as: :rom_id
+      element :Health,                as: :health
+      element :Channel,               as: :channel
+      element :RawData,               as: :raw_data
+      element :PrimaryValue,          as: :primary_value
+      element :Temperature,           as: :temperature
+      element :Humidity,              as: :humidity
+      element :DewPoint,              as: :dew_point
+      element :Humidex,               as: :humidex
+      element :HeatIndex,             as: :heat_index
+      element :BarometricPressureMb,  as: :barometric_pressure_mb
+      element :BarometricPressureHg,  as: :barometric_pressure_hg
+      element :Light,                 as: :light
+    end
+  end
+end

data/lib/ow/parser.rb

@@ -0,0 +1,39 @@
+module Ow
+  module Parser
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def element(name, options = {})
+        accessor_name = options.fetch(:as) { name }
+
+        @element_mapping ||= Hash.new
+        @element_mapping[name.to_s] = accessor_name
+
+        define_method(accessor_name.to_sym) do
+          instance_variable_get("@#{accessor_name}")
+        end
+
+        define_method("#{accessor_name}=".to_sym) do |value|
+          instance_variable_set("@#{accessor_name}", value)
+        end
+      end
+
+      def element_mapping
+        @element_mapping
+      end
+
+      def from_document(document)
+        obj = new
+
+        element_mapping.each do |element_name, accessor|
+          value = document.locate(element_name)[0].nodes[0]
+          obj.send("#{accessor}=", value)
+        end
+
+        obj
+      end
+    end
+  end
+end

data/lib/ow/server.rb

@@ -0,0 +1,42 @@
+require 'ow/parser'
+
+module Ow
+  class Server
+    include Ow::Parser
+
+    element :PollCount,                 as: :poll_count
+    element :DevicesConnected,          as: :devices_connected
+    element :LoopTime,                  as: :loop_time
+    element :DevicesConnectedChannel1,  as: :devices_connected_channel_1
+    element :DevicesConnectedChannel2,  as: :devices_connected_channel_2
+    element :DevicesConnectedChannel3,  as: :devices_connected_channel_3
+    element :DataErrorsChannel1,        as: :data_errors_channel_1
+    element :DataErrorsChannel2,        as: :data_errors_channel_2
+    element :DataErrorsChannel3,        as: :data_errors_channel_3
+    element :VoltageChannel1,           as: :voltage_channel_1
+    element :VoltageChannel2,           as: :voltage_channel_2
+    element :VoltageChannel3,           as: :voltage_channel_3
+    element :VoltagePower,              as: :voltage_power
+    element :DeviceName,                as: :device_name
+    element :HostName,                  as: :host_name
+    element :MACAddress,                as: :mac_address
+
+    attr_accessor :devices
+
+    def initialize
+      @devices = Array.new
+    end
+
+    def self.from_document(document)
+      server = super
+
+      Ow::Device.types.each do |name, device_class|
+        document.locate("owd_#{name}").map do |device_node|
+          server.devices << device_class.from_document(device_node)
+        end
+      end
+
+      server
+    end
+  end
+end

data/lib/ow/version.rb

@@ -1,3 +1,3 @@
 module Ow
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/ow.gemspec

@@ -10,12 +10,14 @@ Gem::Specification.new do |gem|
   gem.email         = ["martin@masv.net"]
   gem.description   = %q{A Ruby parser for OW-SERVER XML files.}
   gem.summary       = %q{A Ruby parser for OW-SERVER XML files.}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/masv/ow"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency("minitest", "> 0")
+  gem.add_development_dependency("minitest", "~> 4.7.2")
+
+  gem.add_dependency("ox", "~> 1.9.4")
 end

data/spec/fixtures/full.xml

@@ -0,0 +1,212 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Devices-Detail-Response xmlns="http://www.embeddeddatasystems.com/schema/owserver" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <PollCount>1004011</PollCount>
+  <DevicesConnected>6</DevicesConnected>
+  <LoopTime>1.716</LoopTime>
+  <DevicesConnectedChannel1>3</DevicesConnectedChannel1>
+  <DevicesConnectedChannel2>0</DevicesConnectedChannel2>
+  <DevicesConnectedChannel3>3</DevicesConnectedChannel3>
+  <DataErrorsChannel1>15962</DataErrorsChannel1>
+  <DataErrorsChannel2>0</DataErrorsChannel2>
+  <DataErrorsChannel3>222</DataErrorsChannel3>
+  <VoltageChannel1>4.65</VoltageChannel1>
+  <VoltageChannel2>4.66</VoltageChannel2>
+  <VoltageChannel3>4.66</VoltageChannel3>
+  <VoltagePower>4.90</VoltagePower>
+  <DeviceName>OWServer_v2-Enet</DeviceName>
+  <HostName>OWSERVER1</HostName>
+  <MACAddress>01:23:45:67:89:0F</MACAddress>
+  <owd_DS18B20 Description="Programmable resolution thermometer">
+    <Name>DS18B20</Name>
+    <Family>28</Family>
+    <ROMId>030000042FE6D528</ROMId>
+    <Health>7</Health>
+    <Channel>3</Channel>
+    <RawData>63004B467FFF0D1028FF000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000</RawData>
+    <PrimaryValue>6.1875 Deg C</PrimaryValue>
+    <Temperature Units="Centigrade">6.1875</Temperature>
+    <UserByte1 Writable="True">75</UserByte1>
+    <UserByte2 Writable="True">70</UserByte2>
+    <Resolution>12</Resolution>
+    <PowerSource>255</PowerSource>
+  </owd_DS18B20>
+  <owd_DS2423 Description="RAM with counters">
+    <Name>DS2423</Name>
+    <Family>1D</Family>
+    <ROMId>C600000009EC941D</ROMId>
+    <Health>7</Health>
+    <Channel>3</Channel>
+    <RawData>FB2665000000000069FD0000000000000000E8820000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000</RawData>
+    <PrimaryValue>6629115, 0</PrimaryValue>
+    <Counter_A>6629115</Counter_A>
+    <Counter_B>0</Counter_B>
+  </owd_DS2423>
+  <owd_EDS0068 Description="Temperature, Humidity, Barometric Pressure and Light Sensor">
+    <Name>EDS0068</Name>
+    <Family>7E</Family>
+    <ROMId>6400100000211D7E</ROMId>
+    <Health>7</Health>
+    <Channel>1</Channel>
+    <RawData>6800700176010F0051017001CC8E1F91EE000900000300405E6B170099C9160000402D0050007DD87DD87DD800803E0000000020030000000A00000000000A03000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000201000000000000000000000000000000000000000000000000000000000000</RawData>
+    <PrimaryValue>23.3750 %RH</PrimaryValue>
+    <Temperature Units="Centigrade">23.0000</Temperature>
+    <Humidity Units="PercentRelativeHumidity">23.3750</Humidity>
+    <DewPoint Units="Centigrade">0.9375</DewPoint>
+    <Humidex>21.0625</Humidex>
+    <HeatIndex Units="Centigrade">23.0000</HeatIndex>
+    <BarometricPressureMb Units="Millibars">1009.850</BarometricPressureMb>
+    <BarometricPressureHg Units="InchesOfMercury">29.821</BarometricPressureHg>
+    <Light Units="Lux">9</Light>
+    <LED>1</LED>
+    <Relay>1</Relay>
+    <Counter1>1493401</Counter1>
+    <Counter2>1534814</Counter2>
+    <TemperatureHighAlarmState>0</TemperatureHighAlarmState>
+    <TemperatureLowAlarmState>0</TemperatureLowAlarmState>
+    <HumidityHighAlarmState>0</HumidityHighAlarmState>
+    <HumidityLowAlarmState>0</HumidityLowAlarmState>
+    <DewPointHighAlarmState>0</DewPointHighAlarmState>
+    <DewPointLowAlarmState>0</DewPointLowAlarmState>
+    <HumidexHighAlarmState>0</HumidexHighAlarmState>
+    <HumidexLowAlarmState>0</HumidexLowAlarmState>
+    <HeatIndexHighAlarmState>0</HeatIndexHighAlarmState>
+    <HeatIndexLowAlarmState>0</HeatIndexLowAlarmState>
+    <BarometricPressureMbHighAlarmState>0</BarometricPressureMbHighAlarmState>
+    <BarometricPressureMbLowAlarmState>0</BarometricPressureMbLowAlarmState>
+    <BarometricPressureHgHighAlarmState>0</BarometricPressureHgHighAlarmState>
+    <BarometricPressureHgLowAlarmState>0</BarometricPressureHgLowAlarmState>
+    <LightHighAlarmState>1</LightHighAlarmState>
+    <LightLowAlarmState>0</LightLowAlarmState>
+    <ClearAlarms Writable="True">-</ClearAlarms>
+    <TemperatureHighConditionalSearchState Writable="True">0</TemperatureHighConditionalSearchState>
+    <TemperatureLowConditionalSearchState Writable="True">0</TemperatureLowConditionalSearchState>
+    <HumidityHighConditionalSearchState Writable="True">0</HumidityHighConditionalSearchState>
+    <HumidityLowConditionalSearchState Writable="True">0</HumidityLowConditionalSearchState>
+    <DewPointHighConditionalSearchState Writable="True">0</DewPointHighConditionalSearchState>
+    <DewPointLowConditionalSearchState Writable="True">0</DewPointLowConditionalSearchState>
+    <HumidexHighConditionalSearchState Writable="True">0</HumidexHighConditionalSearchState>
+    <HumidexLowConditionalSearchState Writable="True">0</HumidexLowConditionalSearchState>
+    <HeatIndexHighConditionalSearchState Writable="True">0</HeatIndexHighConditionalSearchState>
+    <HeatIndexLowConditionalSearchState Writable="True">0</HeatIndexLowConditionalSearchState>
+    <BarometricPressureMbHighConditionalSearchState Writable="True">0</BarometricPressureMbHighConditionalSearchState>
+    <BarometricPressureMbLowConditionalSearchState Writable="True">0</BarometricPressureMbLowConditionalSearchState>
+    <BarometricPressureHgHighConditionalSearchState Writable="True">0</BarometricPressureHgHighConditionalSearchState>
+    <BarometricPressureHgLowConditionalSearchState Writable="True">0</BarometricPressureHgLowConditionalSearchState>
+    <LightHighConditionalSearchState Writable="True">1</LightHighConditionalSearchState>
+    <LightLowConditionalSearchState Writable="True">0</LightLowConditionalSearchState>
+    <TemperatureHighAlarmValue Units="Centigrade" Writable="True">45</TemperatureHighAlarmValue>
+    <TemperatureLowAlarmValue Units="Centigrade" Writable="True">0</TemperatureLowAlarmValue>
+    <HumidityHighAlarmValue Units="PercentRelativeHumidity" Writable="True">80</HumidityHighAlarmValue>
+    <HumidityLowAlarmValue Units="PercentRelativeHumidity" Writable="True">0</HumidityLowAlarmValue>
+    <DewPointHighAlarmValue Units="Centigrade" Writable="True">125</DewPointHighAlarmValue>
+    <DewPointLowAlarmValue Units="Centigrade" Writable="True">-40</DewPointLowAlarmValue>
+    <HumidexHighAlarmValue Writable="True">125</HumidexHighAlarmValue>
+    <HumidexLowAlarmValue Writable="True">-40</HumidexLowAlarmValue>
+    <HeatIndexHighAlarmValue Units="Centigrade" Writable="True">125</HeatIndexHighAlarmValue>
+    <HeatIndexLowAlarmValue Units="Centigrade" Writable="True">-40</HeatIndexLowAlarmValue>
+    <BarometricPressureMbHighAlarmValue Units="Millibars" Writable="True">2000.000</BarometricPressureMbHighAlarmValue>
+    <BarometricPressureMbLowAlarmValue Units="Millibars" Writable="True">0.000</BarometricPressureMbLowAlarmValue>
+    <BarometricPressureHgHighAlarmValue Units="InchesOfMercury" Writable="True">100.000</BarometricPressureHgHighAlarmValue>
+    <BarometricPressureHgLowAlarmValue Units="InchesOfMercury" Writable="True">0.000</BarometricPressureHgLowAlarmValue>
+    <LightHighAlarmValue Units="Lux" Writable="True">10</LightHighAlarmValue>
+    <LightLowAlarmValue Units="Lux" Writable="True">0</LightLowAlarmValue>
+    <LEDFunction Writable="True">2</LEDFunction>
+    <RelayFunction Writable="True">2</RelayFunction>
+    <LEDState Writable="True">1</LEDState>
+    <RelayState Writable="True">1</RelayState>
+    <Version>1.02</Version>
+  </owd_EDS0068>
+  <owd_DS2450 Description="Quad A/D Converter">
+    <Name>DS2450</Name>
+    <Family>20</Family>
+    <ROMId>7A0000000E038F20</ROMId>
+    <Health>7</Health>
+    <Channel>3</Channel>
+    <RawData>00BA00F400BE000C161A088D088D088D088D79D800FF00FF00FF00FFB6DB00000000000000005C5A000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000</RawData>
+    <PrimaryValue>3.705469V Chnl A</PrimaryValue>
+    <ChannelAConversionValue Units="Volts">3.705469</ChannelAConversionValue>
+    <ChannelAConversionResolution Units="Bits" Writable="True">8</ChannelAConversionResolution>
+    <ChannelAConversionRange Writable="True">1</ChannelAConversionRange>
+    <ChannelAOutputEnable Writable="True">0</ChannelAOutputEnable>
+    <ChannelAOutputControl Writable="True">0</ChannelAOutputControl>
+    <ChannelBConversionValue Units="Volts">4.860938</ChannelBConversionValue>
+    <ChannelBConversionResolution Units="Bits" Writable="True">8</ChannelBConversionResolution>
+    <ChannelBConversionRange Writable="True">1</ChannelBConversionRange>
+    <ChannelBOutputEnable Writable="True">0</ChannelBOutputEnable>
+    <ChannelBOutputControl Writable="True">0</ChannelBOutputControl>
+    <ChannelCConversionValue Units="Volts">3.785156</ChannelCConversionValue>
+    <ChannelCConversionResolution Units="Bits" Writable="True">8</ChannelCConversionResolution>
+    <ChannelCConversionRange Writable="True">1</ChannelCConversionRange>
+    <ChannelCOutputEnable Writable="True">0</ChannelCOutputEnable>
+    <ChannelCOutputControl Writable="True">0</ChannelCOutputControl>
+    <ChannelDConversionValue Units="Volts">0.239062</ChannelDConversionValue>
+    <ChannelDConversionResolution Units="Bits" Writable="True">8</ChannelDConversionResolution>
+    <ChannelDConversionRange Writable="True">1</ChannelDConversionRange>
+    <ChannelDOutputEnable Writable="True">0</ChannelDOutputEnable>
+    <ChannelDOutputControl Writable="True">0</ChannelDOutputControl>
+    <PowerOnReset Writable="True">1</PowerOnReset>
+    <VCCControl Writable="True">0</VCCControl>
+  </owd_DS2450>
+  <owd_DS2450 Description="Quad A/D Converter">
+    <Name>DS2450</Name>
+    <Family>20</Family>
+    <ROMId>6A0000000D81E120</ROMId>
+    <Health>7</Health>
+    <Channel>1</Channel>
+    <RawData>00A4000A0005004A301808BDCF9D088D088D98AF00FEFFFF00FF00FFB21400000000000000005C5A000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000</RawData>
+    <PrimaryValue>3.267187V Chnl A</PrimaryValue>
+    <ChannelAConversionValue Units="Volts">3.267187</ChannelAConversionValue>
+    <ChannelAConversionResolution Units="Bits" Writable="True">8</ChannelAConversionResolution>
+    <ChannelAConversionRange Writable="True">1</ChannelAConversionRange>
+    <ChannelAOutputEnable Writable="True">0</ChannelAOutputEnable>
+    <ChannelAOutputControl Writable="True">0</ChannelAOutputControl>
+    <ChannelBConversionValue Units="Volts">0.199219</ChannelBConversionValue>
+    <ChannelBConversionResolution Units="Bits" Writable="True">15</ChannelBConversionResolution>
+    <ChannelBConversionRange Writable="True">1</ChannelBConversionRange>
+    <ChannelBOutputEnable Writable="True">1</ChannelBOutputEnable>
+    <ChannelBOutputControl Writable="True">1</ChannelBOutputControl>
+    <ChannelCConversionValue Units="Volts">0.099609</ChannelCConversionValue>
+    <ChannelCConversionResolution Units="Bits" Writable="True">8</ChannelCConversionResolution>
+    <ChannelCConversionRange Writable="True">1</ChannelCConversionRange>
+    <ChannelCOutputEnable Writable="True">0</ChannelCOutputEnable>
+    <ChannelCOutputControl Writable="True">0</ChannelCOutputControl>
+    <ChannelDConversionValue Units="Volts">1.474219</ChannelDConversionValue>
+    <ChannelDConversionResolution Units="Bits" Writable="True">8</ChannelDConversionResolution>
+    <ChannelDConversionRange Writable="True">1</ChannelDConversionRange>
+    <ChannelDOutputEnable Writable="True">0</ChannelDOutputEnable>
+    <ChannelDOutputControl Writable="True">0</ChannelDOutputControl>
+    <PowerOnReset Writable="True">1</PowerOnReset>
+    <VCCControl Writable="True">0</VCCControl>
+  </owd_DS2450>
+  <owd_DS2450 Description="Quad A/D Converter">
+    <Name>DS2450</Name>
+    <Family>20</Family>
+    <ROMId>2900000014042320</ROMId>
+    <Health>7</Health>
+    <Channel>1</Channel>
+    <RawData>00A6C8AB00CC00FA6FC308BDCF9D088D088D98AF00FEFFFF00FF00FFB21400000000000000005C5A000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000</RawData>
+    <PrimaryValue>3.307031V Chnl A</PrimaryValue>
+    <ChannelAConversionValue Units="Volts">3.307031</ChannelAConversionValue>
+    <ChannelAConversionResolution Units="Bits" Writable="True">8</ChannelAConversionResolution>
+    <ChannelAConversionRange Writable="True">1</ChannelAConversionRange>
+    <ChannelAOutputEnable Writable="True">0</ChannelAOutputEnable>
+    <ChannelAOutputControl Writable="True">0</ChannelAOutputControl>
+    <ChannelBConversionValue Units="Volts">3.422204</ChannelBConversionValue>
+    <ChannelBConversionResolution Units="Bits" Writable="True">15</ChannelBConversionResolution>
+    <ChannelBConversionRange Writable="True">1</ChannelBConversionRange>
+    <ChannelBOutputEnable Writable="True">1</ChannelBOutputEnable>
+    <ChannelBOutputControl Writable="True">1</ChannelBOutputControl>
+    <ChannelCConversionValue Units="Volts">4.064063</ChannelCConversionValue>
+    <ChannelCConversionResolution Units="Bits" Writable="True">8</ChannelCConversionResolution>
+    <ChannelCConversionRange Writable="True">1</ChannelCConversionRange>
+    <ChannelCOutputEnable Writable="True">0</ChannelCOutputEnable>
+    <ChannelCOutputControl Writable="True">0</ChannelCOutputControl>
+    <ChannelDConversionValue Units="Volts">4.980469</ChannelDConversionValue>
+    <ChannelDConversionResolution Units="Bits" Writable="True">8</ChannelDConversionResolution>
+    <ChannelDConversionRange Writable="True">1</ChannelDConversionRange>
+    <ChannelDOutputEnable Writable="True">0</ChannelDOutputEnable>
+    <ChannelDOutputControl Writable="True">0</ChannelDOutputControl>
+    <PowerOnReset Writable="True">1</PowerOnReset>
+    <VCCControl Writable="True">0</VCCControl>
+  </owd_DS2450>
+</Devices-Detail-Response>

data/spec/fixtures/parser_test.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ParserTest>
+  <AnElement>Cookies!</AnElement>
+  <AnotherElement>Unicorns!</AnotherElement>
+</ParserTest>

data/spec/fixtures/server.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Devices-Detail-Response xmlns="http://www.embeddeddatasystems.com/schema/owserver" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <PollCount>1004011</PollCount>
+  <DevicesConnected>6</DevicesConnected>
+  <LoopTime>1.716</LoopTime>
+  <DevicesConnectedChannel1>3</DevicesConnectedChannel1>
+  <DevicesConnectedChannel2>0</DevicesConnectedChannel2>
+  <DevicesConnectedChannel3>3</DevicesConnectedChannel3>
+  <DataErrorsChannel1>15962</DataErrorsChannel1>
+  <DataErrorsChannel2>0</DataErrorsChannel2>
+  <DataErrorsChannel3>222</DataErrorsChannel3>
+  <VoltageChannel1>4.65</VoltageChannel1>
+  <VoltageChannel2>4.66</VoltageChannel2>
+  <VoltageChannel3>4.66</VoltageChannel3>
+  <VoltagePower>4.90</VoltagePower>
+  <DeviceName>OWServer_v2-Enet</DeviceName>
+  <HostName>OWSERVER1</HostName>
+  <MACAddress>01:23:45:67:89:0F</MACAddress>
+</Devices-Detail-Response>

data/spec/ow/device_spec.rb

@@ -0,0 +1,21 @@
+require_relative "../spec_helper"
+require "ow/device"
+
+class DSTEST1
+  include Ow::Device
+end
+
+module TestDevices
+  class DSTEST2
+    include Ow::Device
+  end
+end
+
+describe Ow::Device do
+  describe ".types" do
+    it "returns known device types" do
+      Ow::Device.types["DSTEST1"].must_equal DSTEST1
+      Ow::Device.types["DSTEST2"].must_equal TestDevices::DSTEST2
+    end
+  end
+end

data/spec/ow/parser_spec.rb

@@ -0,0 +1,47 @@
+require_relative "../spec_helper"
+require "ow/parser"
+
+class ParserTest
+  include Ow::Parser
+
+  element :AnElement
+  element :AnotherElement, as: :another_element
+end
+
+describe Ow::Parser do
+  describe ".element" do
+    it "defines reader for element value" do
+      ParserTest.new.must_respond_to :AnElement
+    end
+
+    it "defines reader for element value with custom name" do
+      ParserTest.new.must_respond_to :another_element
+    end
+
+    it "defines writer for element value" do
+      ParserTest.new.must_respond_to :AnElement=
+    end
+
+    it "defines writer for element value with custom name" do
+      ParserTest.new.must_respond_to :another_element=
+    end
+  end
+
+  describe ".element_mapping" do
+    it "returns a hash map of defined elements and accessors" do
+      ParserTest.element_mapping.must_equal({
+        "AnElement" => :AnElement,
+        "AnotherElement" => :another_element
+      })
+    end
+  end
+
+  describe ".from_document" do
+    let(:document) { fixture("parser_test.xml").root }
+
+    it "returns an object with values set" do
+      parsed = ParserTest.from_document(document)
+      parsed.AnElement.must_equal "Cookies!"
+    end
+  end
+end

data/spec/ow/server_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../spec_helper'
+require 'ow/server'
+
+describe Ow::Server do
+  describe ".from_document" do
+    let(:document) { fixture("server.xml").root }
+
+    it "returns a new server with parsed elements" do
+      server = Ow::Server.from_document(document)
+      server.host_name.must_equal "OWSERVER1"
+    end
+  end
+end

data/spec/ow_spec.rb

@@ -0,0 +1,28 @@
+require_relative './spec_helper'
+require 'ow'
+
+describe Ow do
+  describe ".parse_document" do
+    it "returns a new server" do
+      document = fixture('full.xml')
+      server = Ow.parse_document(document)
+      server.must_be_instance_of Ow::Server
+    end
+  end
+
+  describe ".parse_file" do
+    it "returns a new server" do
+      filename = fixture_path + '/full.xml'
+      server = Ow.parse_file(filename)
+      server.must_be_instance_of Ow::Server
+    end
+  end
+
+  describe ".parse" do
+    it "returns a new server" do
+      string = File.read(fixture_path + '/full.xml')
+      server = Ow.parse(string)
+      server.must_be_instance_of Ow::Server
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "minitest/autorun"
+require "ox"
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  Ox.load_file(fixture_path + "/" + file)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ow
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.2
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.4
 description: A Ruby parser for OW-SERVER XML files.
 email:
 - martin@masv.net
@@ -40,9 +56,24 @@ files:
 - README.md
 - Rakefile
 - lib/ow.rb
+- lib/ow/device.rb
+- lib/ow/devices/ds18b20.rb
+- lib/ow/devices/ds2423.rb
+- lib/ow/devices/ds2450.rb
+- lib/ow/devices/eds0068.rb
+- lib/ow/parser.rb
+- lib/ow/server.rb
 - lib/ow/version.rb
 - ow.gemspec
-homepage: ''
+- spec/fixtures/full.xml
+- spec/fixtures/parser_test.xml
+- spec/fixtures/server.xml
+- spec/ow/device_spec.rb
+- spec/ow/parser_spec.rb
+- spec/ow/server_spec.rb
+- spec/ow_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/masv/ow
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -66,4 +97,12 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Ruby parser for OW-SERVER XML files.
-test_files: []
+test_files:
+- spec/fixtures/full.xml
+- spec/fixtures/parser_test.xml
+- spec/fixtures/server.xml
+- spec/ow/device_spec.rb
+- spec/ow/parser_spec.rb
+- spec/ow/server_spec.rb
+- spec/ow_spec.rb
+- spec/spec_helper.rb