elemac 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d7f4976b34a33440772fb7e5da0f6e485804ee5
+  data.tar.gz: e961679265faaff5f78fb19910c4a38fb5fa1727
+SHA512:
+  metadata.gz: 7e52b89b7a83b87977e14be5de245d5e92cd3d9eb4254dc2798d2a7cbbbb554815cad6656b21694e67b536a780f96ffc70bc1e165f83391fbb868fba0841ab4e
+  data.tar.gz: 460092142f21f416c52a4d50e92144ab54044da3e9389628c6f2241c08642fcfd66b0bc768cd46630417af4df9c396cf9ce2530721ab862f89100aa797ce34d5

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in elemac.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Michał Prostko
+
+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,28 @@
+# Elemac SA-03 Ruby binding 
+Ruby binding for ELEMAC SA-03 aquarium controller.
+
+Manufacturer: http://www.elemac.pl/
+
+Gem provides a way to read memory of the aquarium controller. Memory addresses, offsets ect. were found from decompiling the original program which was written in C# and available only for MS Windows. Memory writing (currently disabled in code) is also possible although it might damage the controller and make it unusable.
+
+:warning: **Warning:** This script is published for educational purposes only! Author will accept no responsibility for any consequence, damage or loss which might result from use.
+
+## Features:
+You're able to view following details from the controller:
+* Overview info (date, statuses, alarms)
+* Lightning info
+* Sensor info (Temperature and PH) # Redox is unavailable because I am unable to test this
+* Output info (Power / PWM / TTL) # PWM and TTL are 'dumb' because I am unable to test this
+* Timers info (ToDo)
+
+## Installation:
+Clone the repo. Build gem, install and use in your ruby scripts.
+
+## Usage:
+
+```ruby
+el = Elemac::Connection.new
+x = Elemac::Sensors.new(device: el)
+x.temp1.value
+x.ph1.inspect
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elemac"
+
+# 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(__FILE__)

data/bin/setup

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

data/elemac.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "elemac/version"
+
+Gem::Specification.new do |spec|
+  spec.authors       = ["Michał Prostko"]
+  spec.license       = "MIT"
+  spec.summary       = 'Ruby binding for ELEMAC SA-03 aquarium controller'
+  spec.description   = 'Ruby binding for ELEMAC SA-03 aquarium controller'
+  spec.homepage      = "https://github.com/mprostko/elemac"
+
+  spec.name          = 'elemac'
+  spec.version       = Elemac::VERSION
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.0"
+
+  spec.add_dependency             "hidapi", "~> 0.1.9"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/elemac.rb

@@ -0,0 +1,9 @@
+require "elemac/version"
+require "elemac/connection"
+require "elemac/overview"
+require "elemac/light"
+require "elemac/outputs"
+require "elemac/sensors"
+
+module Elemac
+end

data/lib/elemac/connection.rb

@@ -0,0 +1,69 @@
+require "hidapi"
+
+module Elemac
+	class Connection
+	  	def initialize(vendor: 0x4d8, product: 0x3f, debug: false)
+			@debug = debug
+			@dev = HIDAPI::open(vendor, product)
+			throw 'Cannot open ELEMAC HID' unless @dev
+		end
+		
+		def request_data(address)
+			bytes = Array.new(64, 0)
+			length = address.length - 1
+			bytes[0..length] = address.bytes 
+			# Write command to device
+			@dev.write(bytes)
+			# Read result. 
+			response = read_data # this hex form, transform it to number
+			response.hex
+		end
+
+		# Reading data is in form 'rXYYY' where X is bit length, YYY is the address in hex
+		# Read data ends on byte 0
+		def read_data
+			raw = @dev.read
+			response = ""
+			debug_read(raw) if @debug
+
+			raw.each_byte { |x| 
+				break if x == 0 
+				response += x.chr # Get char (for hex)
+			}
+			# Reverse bit order
+			response = response.scan(/../).reverse.join
+			response
+		end
+
+=begin
+		# Writing to controller is in form 'wXYYY=value' where X is bit length, YYY is the address in hex
+		def write_data(address, value=32896)
+			throw 'USE ONLY IN EMERGENCY CASES!'
+			bytes = Array.new(64, 0)
+			address[0] = 'w' # change read to write
+			value = value.to_s(16) # convert to hex
+			# Reverse bit order
+			value = value.scan(/../).reverse.join
+			message = "#{address}=#{value}"
+			data_size = message.length - 1
+			bytes[0..data_size] = message.bytes
+			@dev.write(bytes)
+			raw = @dev.read
+			puts raw
+			puts raw.inspect
+		end
+=end	
+
+		private
+		def debug_read(raw)
+			dbg = []
+			count = 0
+			raw.each_byte { |x| 
+				count += 1
+				dbg << x 
+			}
+			puts "bits: #{count}"
+			puts dbg.inspect
+		end
+	end
+end

data/lib/elemac/converter.rb

@@ -0,0 +1,65 @@
+require 'date'
+
+module Elemac
+	class Converter
+		BIT32_HIGH_MASK = 4278190080
+		BIT32_LOW_MASK = 16711680
+		BIT16_HIGH_MASK = 65280
+		BIT16_LOW_MASK	= 255
+		def self.bit32_high(value)
+			(value & BIT16_HIGH_MASK) >> 24
+		end
+		def self.bit32_low(value)
+			(value & BIT32_LOW_MASK) >> 16
+		end
+		def self.bit16_high(value)
+			(value & BIT16_HIGH_MASK) >> 8
+		end
+		def self.bit16_low(value)
+			(value & BIT16_LOW_MASK)
+		end	
+		def self.int_to_hour(value)
+			hour 	= bit16_low(value).to_s
+			minute 	= bit16_high(value).to_s
+			"#{hour.rjust(2,'0')}:#{minute.rjust(2,'0')}"
+		end
+		def self.seconds_to_hsm(value)
+			value = 14400 if value > 14400
+			Time.at(value).utc.strftime("%H:%M:%S")
+		end
+		def self.long_to_date(value)
+			day 	= bit32_low(value).to_s
+			month 	= bit16_high(value).to_s
+			year	= (2000 + bit16_low(value).to_i).to_s
+			"#{year}-#{month.rjust(2,'0')}-#{day.rjust(2,'0')}"
+		end
+		# calibration date should be in format YYYY-MM-DD
+		# reminder is the amount of months that ph has to be calibrated
+		def self.ph_reminder(value, calibration_date, reminder=0)
+			value = value & 3
+			ph7, ph49, out_of_date = false
+			case(value)
+			when 0
+				ph7, ph49, out_of_date = false, false, false
+			when 1
+				ph7, ph49, out_of_date = true, false, false
+			when 2
+				ph7, ph49, out_of_date = false, true, false
+			when 3
+				ph7, ph49 = true, true
+				next_calibration_date = Date.parse(calibration_date) << -reminder
+				out_of_date = next_calibration_date < Date.today 
+			end
+			"PH7: #{ph7.to_s}, PH49: #{ph49.to_s}, Calibrated: #{out_of_date.to_s}"
+		end
+		def self.format_date(year,month,date)
+			"#{year.to_s.rjust(2,'0')}-#{month.to_s.rjust(2,'0')}-#{date.to_s.rjust(2,'0')}"
+		end
+		def self.format_time(hour,minute,second)
+			"#{hour.to_s.rjust(2,'0')}:#{minute.to_s.rjust(2,'0')}:#{second.to_s.rjust(2,'0')}"
+		end
+		def self.ph_9_enabled(value)
+			value & 4 > 0
+		end
+	end
+end

data/lib/elemac/light.rb

@@ -0,0 +1,74 @@
+require "elemac/property"
+require "elemac/converter"
+
+module Elemac
+	class Light
+		SUNRISE				= 92
+		SUNSET				= 94
+		DAY_BREAK_START		= 160
+		DAY_BREAK_END		= 162	
+		NIGHT_BREAK_START	= 164
+		NIGHT_BREAK_END		= 166
+		DAYLIGHT_SAVE		= 360
+		LAMP_POWER_ON_DELAY	= 91
+		OFFSET   			= 0
+		
+		def initialize(device:)
+			@device = device
+		end
+		
+		def get_offset
+			OFFSET
+		end
+
+		def sunrise
+			prop = Property.new(offset: get_offset, address: SUNRISE, type: :short)
+			Converter.int_to_hour(get_data(prop.to_s))
+		end
+		
+		def sunset
+			prop = Property.new(offset: get_offset, address: SUNSET, type: :short)
+			Converter.int_to_hour(get_data(prop.to_s))
+		end
+		
+		def day_break_start
+			prop = Property.new(offset: get_offset, address: DAY_BREAK_START, type: :short)
+			Converter.int_to_hour(get_data(prop.to_s))
+		end
+		
+		def day_break_end
+			prop = Property.new(offset: get_offset, address: DAY_BREAK_END, type: :short)
+			Converter.int_to_hour(get_data(prop.to_s))
+		end
+		
+		def night_break_start
+			prop = Property.new(offset: get_offset, address: NIGHT_BREAK_START, type: :short)
+			Converter.int_to_hour(get_data(prop.to_s))
+		end
+		
+		def night_break_end
+			prop = Property.new(offset: get_offset, address: NIGHT_BREAK_END, type: :short)
+			Converter.int_to_hour(get_data(prop.to_s))
+		end
+		
+		def light_power_on_delay
+			prop = Property.new(offset: get_offset, address: LAMP_POWER_ON_DELAY, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def inspect
+			puts "SUNRISE:\t#{sunrise}"
+			puts "D-BREAK START:\t#{day_break_start}"
+			puts "D-BREAK END:\t#{day_break_end}"
+			puts "SUNSET:\t\t#{sunset}"
+			puts "N-BREAK START:\t#{night_break_start}"
+			puts "N-BREAK END:\t#{night_break_end}"
+			puts "HQI DELAY:\t#{light_power_on_delay}"
+		end
+		
+		private
+		def get_data(address)
+			@device.request_data(address)
+		end
+	end
+end

data/lib/elemac/output/default.rb

@@ -0,0 +1,104 @@
+require "elemac/property"
+
+module Elemac
+	module Output
+		class Default
+			OFFSET			= 2048
+			DATA_SIZE 		= 1
+			TYPE 			= 0
+			MODE 			= 256
+			DAY_1_START 	= 25
+			DAY_1_STOP 		= 281
+			DAY_2_START 	= 100
+			DAY_2_STOP 		= 356
+			DAY_3_START 	= 175
+			DAY_3_STOP 		= 431
+			WORK 			= 512
+			PAUSE 			= 587
+			TIMER 			= 662
+			POWER_FLAG		= 1
+			VOLTAGE_FLAG	= 14 # bits 1110
+			DIMMABLE_FLAG 	= 16
+			NEGATIVE_FLAG 	= 32
+			TIMER_ON_FLAG 	= 64
+			PRESENT_FLAG 	= 128
+			def initialize(device:, index: 0)
+				@device = device
+				@index = index
+				@voltage = 0
+				@dimmable = false
+				@dim_value = 0
+			end
+			
+			def get_offset
+				throw "Bad offset. Can be only 0..25. #{@index} given." unless (0..25).cover?(@index)
+				OFFSET + (@index * DATA_SIZE)
+			end
+			
+			def name
+				(@index + 'A'.ord).chr
+			end
+			
+			def type
+				prop = Property.new(offset: get_offset, address: TYPE, type: :short)
+				get_data(prop.to_s)
+			end
+			
+			def powered
+				type & POWER_FLAG != 0
+			end
+			
+			def board_dimmable
+				type & DIMMABLE_FLAG != 0
+			end
+			
+			def board_present
+				type & 128 != 0
+			end
+			
+			def board_voltage
+				val = (type & VOLTAGE_FLAG) >> 1
+				case(val)
+				when 0
+					230
+				when 1
+					12
+				when 2
+					5
+				when 3
+					3
+				else
+					0
+				end
+			end
+			
+			def negative
+				type & NEGATIVE_FLAG != 0
+			end
+			
+			def timer_on
+				type & TIMER_ON_FLAG != 0
+			end
+			
+			def dimmable
+				@dimmable
+			end
+			
+			def inspect
+				puts "NAME:\t\t#{name}"
+				puts "TYPE:\t\t#{type}"
+				puts "POWERED:\t#{powered}"
+				puts "TIMER:\t\t#{timer_on}"
+				puts "NEGATIVE:\t#{negative}"
+				puts "BRD_PRESENT:\t#{board_present}"
+				puts "BRD_VOLTAGE:\t#{board_voltage}"
+				puts "BRD_DIMMABLE:\t#{board_dimmable}"		
+			end
+			
+			private
+			def get_data(address)
+				@device.request_data(address)
+			end
+		end
+	end
+end

data/lib/elemac/output/power.rb

@@ -0,0 +1,10 @@
+require "elemac/output/default"
+
+module Elemac
+	class Output::Power < Output::Default
+		def initialize(device:, index: 0)
+			super(device: device, index: index)
+			@voltage = 230
+		end
+	end
+end

data/lib/elemac/output/pwm.rb

@@ -0,0 +1,61 @@
+require "elemac/output/default"
+require "elemac/converter"
+
+	module Elemac
+	class Output::Pwm < Output::Default
+		# Reg -> regulated -> PWM
+		REG_OFFSET = 1792
+		REG_DATA_SIZE = 8
+		REG_LEVEL = 1
+		REG_MIN_LEVEL = 2
+		REG_MAX_LEVEL = 3
+		REG_TRANS_TIME = 4
+		REG_TRANS_COUNT = 6
+		
+		def initialize(device:, index: 0, dim_index: 0)
+			super(device: device, index: index)
+			@dimm_index = dim_index
+			@voltage = 12
+			@dimmable = true
+		end
+		
+		def get_reg_offset
+			throw "Bad offset. Can be only 0..8. #{@index} given." unless (0..8).cover?(@index)
+			REG_OFFSET + (@dimm_index * REG_DATA_SIZE)
+		end
+		
+		def level
+			prop = Property.new(offset: get_reg_offset, address: REG_LEVEL, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def min_level
+			prop = Property.new(offset: get_reg_offset, address: REG_MIN_LEVEL, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def max_level
+			prop = Property.new(offset: get_reg_offset, address: REG_MAX_LEVEL, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def trans_time
+			prop = Property.new(offset: get_reg_offset, address: REG_TRANS_TIME, type: :short)
+			get_data(prop.to_s)
+		end
+		
+		def trans_count
+			prop = Property.new(offset: get_reg_offset, address: REG_TRANS_COUNT, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def inspect
+			super
+			puts "LEVEL:\t\t#{level}"
+			puts "MIN LEVEL:\t#{min_level}"
+			puts "MAX_LEVEL:\t#{max_level}"
+			puts "TRANS TIME:\t#{Converter.seconds_to_hsm(trans_time)}"
+			puts "TRANS COUNT:\t#{trans_count}"
+		end
+	end
+end

data/lib/elemac/output/ttl.rb

@@ -0,0 +1,10 @@
+require "elemac/output/default"
+
+module Elemac
+	class Output::Ttl < Output::Default
+		def initialize(device:, index: 0)
+			super(device: device, index: index)
+			@voltage = 3.3
+		end
+	end
+end

data/lib/elemac/outputs.rb

@@ -0,0 +1,66 @@
+require "elemac/output/power"
+require "elemac/output/pwm"
+require "elemac/output/ttl"
+
+module Elemac
+	class Outputs
+		def initialize(device:)
+			@device = device
+			# TODO: check loaded sensors
+			@out_a = @out_b = @out_c = @out_d = @out_e = true
+			@out_f = true
+			@out_g = true
+			# more unavailable now
+		end
+		
+		def out_a
+			throw 'Output A unavailable' unless @out_a
+			PowerOutput.new(device: @device, index: 0)
+		end
+		def out_b
+			throw 'Output B unavailable' unless @out_b
+			PowerOutput.new(device: @device, index: 1)
+		end
+		def out_c
+			throw 'Output C unavailable' unless @out_c
+			PowerOutput.new(device: @device, index: 2)
+		end
+		def out_d
+			throw 'Output D unavailable' unless @out_d
+			PowerOutput.new(device: @device, index: 3)
+		end
+		def out_e
+			throw 'Output E unavailable' unless @out_e
+			PowerOutput.new(device: @device, index: 4)
+		end
+		def out_f
+			throw 'Output F unavailable' unless @out_f
+			PwmOutput.new(device: @device, index: 5, dim_index: 0)
+		end
+		def out_g
+			throw 'Output G unavailable' unless @out_g
+			TtlOutput.new(device: @device, index: 6)
+		end
+		
+		def outputs_available
+			['a','b','c','d','e','f','g'] # and more...
+		end
+		
+		def power_outputs
+			outputs = []
+			outputs << out_a if @out_a
+			outputs << out_b if @out_b
+			outputs << out_c if @out_c
+			outputs << out_d if @out_d
+			outputs << out_e if @out_e
+		end
+		
+		def dimm_outputs
+			[out_f] # and more...
+		end
+		
+		def ttl_outputs
+			[out_g] # and more...
+		end
+	end
+end

data/lib/elemac/overview.rb

@@ -0,0 +1,114 @@
+require "elemac/property"
+require "elemac/converter"
+
+module Elemac
+	class Overview
+		PROP_CURRENT_HOUR 		= 62
+		PROP_CURRENT_MINUTE 	= 63
+		PROP_CURRENT_SECOND 	= 64
+		PROP_CURRENT_DAY 		= 371
+		PROP_CURRENT_MONTH 		= 370
+		PROP_CURRENT_YEAR 		= 369
+		PROP_CURRENT_DOW 		= 368
+		DAY_NIGHT_FLAG			= 84
+		DAY_NIGHT_LIGHT_FLAG	= 86
+		DAY_FLAG				= 4
+		DAY_LIGHT_FLAG			= 1
+		NIGHT_LIGHT_FLAG		= 64	
+		OFFSET = 0
+
+		def initialize(device:)
+			@device = device
+		end
+		
+		def get_offset
+			OFFSET
+		end
+		
+		def current_day
+			prop = Property.new(offset: get_offset, address: PROP_CURRENT_DAY, type: :char)
+			get_data(prop.to_s).to_i
+		end
+		
+		def current_month
+			prop = Property.new(offset: get_offset, address: PROP_CURRENT_MONTH, type: :char)
+			get_data(prop.to_s).to_i
+		end
+		
+		def current_year
+			prop = Property.new(offset: get_offset, address: PROP_CURRENT_YEAR, type: :char)
+			2000 + get_data(prop.to_s).to_i
+		end
+		
+		def current_date
+			Converter.format_date(current_year, current_month, current_day)
+		end
+		
+		def current_hour
+			prop = Property.new(offset: get_offset, address: PROP_CURRENT_HOUR, type: :char)
+			get_data(prop.to_s).to_i
+		end
+		
+		def current_minute
+			prop = Property.new(offset: get_offset, address: PROP_CURRENT_MINUTE, type: :char)
+			get_data(prop.to_s).to_i
+		end
+		
+		def current_second
+			prop = Property.new(offset: get_offset, address: PROP_CURRENT_SECOND, type: :char)
+			get_data(prop.to_s).to_i
+		end
+		
+		def current_time
+			Converter.format_time(current_hour, current_minute, current_second)
+		end
+		
+		def current_day_of_week
+			prop = Property.new(offset: get_offset, address: PROP_CURRENT_DOW, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def day_night_flags
+			prop = Property.new(offset: get_offset, address: DAY_NIGHT_FLAG, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def day_night_light_flags
+			prop = Property.new(offset: get_offset, address: DAY_NIGHT_LIGHT_FLAG, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def day
+			day_night_flags & DAY_FLAG != 0
+		end
+		
+		def night
+			!day
+		end
+		
+		def day_light
+			day_night_light_flags & DAY_LIGHT_FLAG != 0
+		end
+		
+		def night_light
+			day_night_light_flags & NIGHT_LIGHT_FLAG != 0
+		end
+		
+		def inspect
+			puts "DATE:\t\t#{current_date}"
+			puts "TIME:\t\t#{current_time}"
+			puts "DAY OF WEEK:\t#{current_day_of_week}"
+			puts "D/N FLG:\t#{day_night_flags} (#{day_night_flags.to_s(2)})"
+			puts "D/N LIGHT FLG:\t#{day_night_light_flags} (#{day_night_light_flags.to_s(2)})"
+			puts "IS DAY:\t\t#{day}" 
+			puts "IS NIGHT:\t#{night}"
+			puts "DAY LIGHT:\t#{day_light}"
+			puts "NIGHT LIGHT:\t#{night_light}"
+		end
+		
+		private
+		def get_data(address)
+			@device.request_data(address)
+		end
+	end
+end

data/lib/elemac/property.rb

@@ -0,0 +1,27 @@
+module Elemac
+	class Property
+		def initialize(address:, offset: 0, type: :int)
+			@address = address
+			@offset = offset
+			@type = type
+		end
+		def get_type(type)
+			case(type)
+			when :char 	# 1 byte
+				'r0'
+			when :short # 2 bytes
+				'r1'
+			when :int 	# 3 bytes
+				'r2'
+			when :long 	# 4 bytes
+				'r3'
+			end
+		end
+		def get_address
+			(@offset + @address).to_s(16).upcase.rjust(3, '0')
+		end
+		def to_s
+			"#{get_type(@type)}#{get_address}"
+		end
+	end
+end

data/lib/elemac/sensor/default.rb

@@ -0,0 +1,114 @@
+require "elemac/property"
+
+module Elemac
+	module Sensor
+		class Default
+			FLAGS			= 0
+			MEASURMENT 		= 2
+			HYSTERESIS		= 10
+			DAY_HIGH		= 6
+			NIGHT_HIGH		= 8
+			DAY_LOW			= 13
+			NIGHT_LOW		= 11
+			ALARM_HIGH		= 4
+			ALARM_LOW		= 15
+			DATA_SIZE		= 17	
+			FLAG_PRESENT 	= 1
+			FLAG_RISE		= 2
+			FLAG_LOWER 		= 4
+			FLAG_ALARM_HIGH	= 8
+			FLAG_ALARM_LOW	= 16
+			OFFSET 			= 1864
+			
+			def initialize(device:, index: 0, divider: 1.0)
+				throw 'Index has to be in range 0-5' if !(0..5).cover?(index)
+				@device = device
+				@index = index
+				@offset = get_offset
+				@divider = divider
+			end
+			def get_offset
+				# this does not include rh sensor yet
+				throw "Bad offset. Can be only 0,1,2,3 for TEMP or 4,5 for PH. #{@index} given." unless (0..5).cover?(@index)
+				OFFSET + (@index * DATA_SIZE)
+			end
+			def value
+				prop = Property.new(offset: get_offset, address: MEASURMENT, type: :short)
+				get_data(prop.to_s) / @divider
+			end
+			def hysteresis
+				prop = Property.new(offset: get_offset, address: HYSTERESIS, type: :char)
+				get_data(prop.to_s) / @divider
+			end
+			def day_high
+				prop = Property.new(offset: get_offset, address: DAY_HIGH, type: :short)
+				get_data(prop.to_s) / @divider
+			end
+			def day_low
+				prop = Property.new(offset: get_offset, address: DAY_LOW, type: :short)
+				get_data(prop.to_s) / @divider
+			end
+			def night_high
+				prop = Property.new(offset: get_offset, address: NIGHT_HIGH, type: :short)
+				get_data(prop.to_s) / @divider
+			end
+			def night_low
+				prop = Property.new(offset: get_offset, address: NIGHT_LOW, type: :short)
+				get_data(prop.to_s) / @divider
+			end
+			def alarm_high
+				prop = Property.new(offset: get_offset, address: ALARM_HIGH, type: :short)
+				get_data(prop.to_s) / @divider
+			end
+			def alarm_low
+				prop = Property.new(offset: get_offset, address: ALARM_LOW, type: :short)
+				get_data(prop.to_s) / @divider
+			end
+			def flags
+				prop = Property.new(offset: get_offset, address: FLAGS, type: :short)
+				get_data(prop.to_s)
+			end
+			def flag_present
+				flags & FLAG_PRESENT != 0
+			end
+			def flag_rise
+				return false unless flag_present
+				flags & FLAG_RISE != 0
+			end
+			def flag_lower
+				return false unless flag_present
+				flags & FLAG_LOWER != 0
+			end
+			def flag_alarm_high
+				return false unless flag_present
+				flags & FLAG_ALARM_HIGH != 0
+			end
+			def flag_alarm_low
+				return false unless flag_present
+				flags & FLAG_ALARM_LOW != 0
+			end
+			
+			def inspect
+				puts "MEASURMENT\t#{value}"
+				puts "HYSTERESIS\t#{hysteresis}"
+				puts "DAY LOW\t\t#{day_low}"
+				puts "DAY HIGH\t#{day_high}"
+				puts "NIGHT LOW\t#{night_low}"
+				puts "NIGHT HIGH\t#{night_high}"
+				puts "ALARM LOW\t#{alarm_low}"
+				puts "ALARM HIGH\t#{alarm_high}"
+				puts "FLAGS:\t\t#{flags} (#{flags.to_s(2)})"
+				puts "F_PRESENT:\t#{flag_present}"
+				puts "F_RISE:\t\t#{flag_rise}"
+				puts "F_LOWER:\t#{flag_lower}"
+				puts "F_ALARM_H:\t#{flag_alarm_high}"
+				puts "F_ALARM_L:\t#{flag_alarm_low}"
+			end
+			
+			private
+			def get_data(address)
+				@device.request_data(address)
+			end
+		end
+	end
+end

data/lib/elemac/sensor/ph.rb

@@ -0,0 +1,107 @@
+require "elemac/sensor/default"
+require "elemac/converter"
+
+# Index can be only 0 or 1, defined by Length in PhSettings.cs
+# to jest inny index (tylko dla PH) bo odwołujemy się do innego offsetu (ph offset)
+# CALIBR_7_OFFSET 	= 8 # not used in elemac
+# CALIBR_49_OFFSET 	= 9 # not used in elemac
+	module Elemac
+	class Sensor::Ph < Sensor::Default
+		PH_OFFSET			= 2786
+		PH_DATA_SIZE 		= 15
+		CALIBR_7 			= 1
+		CALIBR_49			= 3
+		CALIBR_DATE 		= 5
+		CALIBR_FLAGS 		= 0		# zwraca random, czasem 0,24,16 - brane sa 3 pierwsze bity pod uwage
+		SLOPE 				= 10
+		ELZERO 				= 12
+		REMINDER 			= 14
+		ADC_OFFSET			= 0
+		ADC1				= 228
+		ADC2				= 1540
+		
+		# -4 poniewaz index sensora jest 4 lub 5 dla ph, a dane offsetowe do kalibracji moga
+		# przyjmowac index 0 lub 1 wyłącznie co odpowiada indeksowi 0 lub 1 w zaleznosci od czujnika
+		def get_ph_offset
+			index = (@index - 4)
+			throw "Bad offset. Can be only 0 or 1. #{index} given." unless (0..1).cover?(index)
+			PH_OFFSET + (index * PH_DATA_SIZE)
+		end
+		
+		def calibr_7
+			prop = Property.new(offset: get_ph_offset, address: CALIBR_7, type: :short)
+			get_data(prop.to_s)
+		end
+		
+		# TODO: chyba nie sprowadza dobrych wartosci dla ph9 (218) - wyswietla tyle co w 4
+		def calibr_49
+			prop = Property.new(offset: get_ph_offset, address: CALIBR_49, type: :short)
+			get_data(prop.to_s)
+		end
+		
+		def calibr_flags
+			prop = Property.new(offset: get_ph_offset, address: CALIBR_FLAGS, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def calibr_date
+			prop = Property.new(offset: get_ph_offset, address: CALIBR_DATE, type: :int)
+			Converter.long_to_date(get_data(prop.to_s))
+		end
+		
+		# a warning should be shown when this value is > 22240
+		def slope
+			prop = Property.new(offset: get_ph_offset, address: SLOPE, type: :short)
+			get_data(prop.to_s)
+		end
+		
+		def slope_mv_ph
+			current_slope = slope
+			if current_slope == 0
+				0
+			else
+				1638400.0 / current_slope * (625.0 / 128.0) / 11.9090900421143
+			end
+		end
+		
+		def elzero
+			prop = Property.new(offset: get_ph_offset, address: ELZERO, type: :short)
+			get_data(prop.to_s)
+		end
+		
+		def reminder
+			prop = Property.new(offset: get_ph_offset, address: REMINDER, type: :char)
+			get_data(prop.to_s)
+		end
+		
+		def calibr_status
+			Converter.ph_reminder(calibr_flags, calibr_date, reminder)
+		end
+		
+		def ph_9_enabled
+			Converter.ph_9_enabled(calibr_flags)
+		end
+		
+		def adc
+			# depending on current ph 0 or 1, get adc value
+			adc_address = (@index - 4) == 0 ? ADC1 : ADC2
+			prop = Property.new(offset: ADC_OFFSET, address: ADC1, type: :short)
+			get_data(prop.to_s)
+		end
+		
+		def inspect
+			super
+			puts "ADC\t\t#{adc}"
+			puts "CALIBR 7\t#{calibr_7}"
+			puts "CALIBR 49\t#{calibr_49}"
+			puts "PH9 ENABLED\t#{ph_9_enabled}"
+			puts "CALIBR_FLAGS\t#{calibr_flags} (#{(calibr_flags & 7).to_s(2)})"
+			puts "CALIBR_DATE\t#{calibr_date}"
+			puts "SLOPE\t\t#{slope}"
+			puts "SLOPE mV/pH\t#{slope_mv_ph}"
+			puts "ELZERO\t\t#{elzero}"
+			puts "REMINDER\t#{reminder}"
+			puts "STATUS\t\t#{calibr_status}"
+		end
+	end
+end

data/lib/elemac/sensor/redox.rb

@@ -0,0 +1,9 @@
+require "elemac/sensor/default"
+
+module Elemac
+	class Sensor::Redox < Sensor::Default
+		def initialize
+			throw 'Not yet supported'
+		end
+	end
+end

data/lib/elemac/sensor/temperature.rb

@@ -0,0 +1,6 @@
+require "elemac/sensor/default"
+
+module Elemac
+	class Sensor::Temperature < Sensor::Default
+	end
+end

data/lib/elemac/sensors.rb

@@ -0,0 +1,51 @@
+# Sensors are described as 4 blocks of memory starting from offset 1864
+# those sensors are set as: temp1, temp2, temp3, temp4, ph1... dunno about ph2 and redox
+# measure is on +2. size of 17. so first reading is at 1864+2
+# ph starts at 1864 + 4*17. +2 is the ph measure
+
+require "elemac/sensor/temperature"
+require "elemac/sensor/ph"
+require "elemac/sensor/redox"
+
+module Elemac
+	class Sensors
+		def initialize(device:)
+			@device = device
+			# TODO: check loaded sensors
+			@temp1_available = true
+			@temp2_available = false
+			@temp3_available = false
+			@temp4_available = false
+			@ph1_available 	= true
+			@ph2_available 	= false
+		end
+		def temp1
+			throw 'Sensor temp1 unavailable' unless @temp1_available
+			Sensor::Temperature.new(device: @device, index: 0, divider: 10.0)
+		end
+		def temp2
+			throw 'Sensor temp2 unavailable' unless @temp2_available
+			Sensor::Temperature.new(device: @device, index: 1, divider: 10.0)
+		end
+		def temp3
+			throw 'Sensor temp3 unavailable' unless @temp3_available
+			Sensor::Temperature.new(device: @device, index: 2, divider: 10.0)
+		end
+		def temp4
+			throw 'Sensor temp4 unavailable' unless @temp4_available
+			Sensor::Temperature.new(device: @device, index: 3, divider: 10.0)
+		end
+		def ph1
+			throw 'Sensor ph1 unavailable' unless @ph1_available
+			Sensor::Ph.new(device: @device, index: 4, divider: 100.0)
+		end
+		def ph2
+			throw 'Sensor ph1 unavailable' unless @ph2_available
+			Sensor::Ph.new(device: @device, index: 5, divider: 100.0)
+		end
+		#def rh
+		#	throw 'Sensor rh unavailable' unless @ph2_available
+		#	Sensor::Redox.new(device: @device, index: 6, divider: 100.0)
+		#end
+	end
+end

data/lib/elemac/version.rb

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: elemac
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michał Prostko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hidapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: Ruby binding for ELEMAC SA-03 aquarium controller
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elemac.gemspec
+- lib/elemac.rb
+- lib/elemac/connection.rb
+- lib/elemac/converter.rb
+- lib/elemac/light.rb
+- lib/elemac/output/default.rb
+- lib/elemac/output/power.rb
+- lib/elemac/output/pwm.rb
+- lib/elemac/output/ttl.rb
+- lib/elemac/outputs.rb
+- lib/elemac/overview.rb
+- lib/elemac/property.rb
+- lib/elemac/sensor/default.rb
+- lib/elemac/sensor/ph.rb
+- lib/elemac/sensor/redox.rb
+- lib/elemac/sensor/temperature.rb
+- lib/elemac/sensors.rb
+- lib/elemac/version.rb
+homepage: https://github.com/mprostko/elemac
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby binding for ELEMAC SA-03 aquarium controller
+test_files: []