garden_messenger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf2e78c5ee99e2dcf110210cd876d6b54f0167a6e8152d23917bdf55f4e13f39
-  data.tar.gz: ca12a8feeb88be444d884fc4f7f57904e90ea8ee94435ab77e32969542a1c727
+  metadata.gz: a7b25c790bf561282f4fb0e150d2a6d5e75cbae1f7e2a7176af43a25caef39d9
+  data.tar.gz: 9e7109e232c79bea95bba4a1a7b885809bcddbd909af94f9ed5bb7ba26f72700
 SHA512:
-  metadata.gz: dc358cb22acfbdb7aeeb3a704927323228c16762c7f257c15311fa1bbb6a12e54e0e8488eecf4f90188281940f90e4775e43bc10cd4f141cab8ab8102dbb628a
-  data.tar.gz: 1e6ab85daf7cc36f5632eeb8655fcf9a40b34e10f7e51bd2d1cff86fc13487f915bb35c0e2bb55d3765e67f6cc4b6f31caeaa5d7d1b6bbd67a560906db99f212
+  metadata.gz: 2d90a0176635a0c122c70f169c9233bcfe7cad1851b8abf2ba3f855ea8e5f27093a10ea1a28614b00608cc7a8b3832f725a1e5740b41fac4ab671f9de293122c
+  data.tar.gz: 99a55d17590b04f90e76a2c4ec6680f46e7c40179629681bac3b7c5da15a1fdbd2b3e0b66ad771982479bda83f81db9fb728b7bcf9389b0c6b847d97d2a85754

data/.rubocop.yml

@@ -1,2 +1,2 @@
 inherit_from:
-  - https://raw.githubusercontent.com/siegy22/dotfiles/de0fd27c50d34b4fce5a3947c0041a55e36e9fcb/rubocop.yml
+  - https://raw.githubusercontent.com/siegy22/dotfiles/c4b42f0bba4e4eb0a573d538ecc99266be90a8f8/rubocop.yml

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    garden_messenger (0.1.0)
+    garden_messenger (0.2.0)
       action_cable_client (~> 3.0)
       http (~> 4.1)
-      i2c-devices (~> 0.0.6)
       thor (~> 0.20)
 
 GEM
@@ -12,9 +11,16 @@ GEM
   specs:
     action_cable_client (3.0.1)
       websocket-eventmachine-client (>= 1.2.0)
+    activesupport (6.0.0.rc1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.4)
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
+    concurrent-ruby (1.1.5)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     eventmachine (1.2.7)
@@ -27,7 +33,8 @@ GEM
       domain_name (~> 0.5)
     http-form_data (2.1.1)
     http_parser.rb (0.6.0)
-    i2c-devices (0.0.6)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
     minitest (5.11.3)
     parallel (1.17.0)
@@ -47,9 +54,12 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.10.0)
     thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
+    unf_ext (0.0.7.6)
     unicode-display_width (1.5.0)
     websocket (1.2.8)
     websocket-eventmachine-base (1.2.0)
@@ -59,11 +69,13 @@ GEM
     websocket-eventmachine-client (1.2.0)
       websocket-eventmachine-base (~> 1.0)
     websocket-native (1.0.0)
+    zeitwerk (2.1.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (= 6.0.0.rc1)
   bundler (~> 2.0)
   garden_messenger!
   minitest (~> 5.0)

data/README.md

@@ -6,10 +6,10 @@ Collects data of [AtlasScientific](https://www.atlas-scientific.com/) and [myStr
 
 Currently supported:
 
-[ ] [pH Kit](https://www.atlas-scientific.com/product_pages/kits/ph-kit.html)
-[ ] [Conductivity K 1.0 Kit](https://www.atlas-scientific.com/product_pages/kits/ec_k1_0_kit.html)
-[ ] [Temperature Kit](https://www.atlas-scientific.com/product_pages/kits/temp_kit.html)
-[x] [myStrom Switch (CH)](https://mystrom.ch/wifi-switch-ch/)
+- [x] [pH Kit](https://www.atlas-scientific.com/product_pages/kits/ph-kit.html)
+- [x] [Conductivity Kit](https://www.atlas-scientific.com/product_pages/kits/ec_k1_0_kit.html)
+- [x] [Temperature Kit](https://www.atlas-scientific.com/product_pages/kits/temp_kit.html)
+- [x] [myStrom Switch (CH)](https://mystrom.ch/wifi-switch-ch/)
 
 
 ## Installation

data/exe/garden_messenger

@@ -1,54 +1,5 @@
 #!/usr/bin/env ruby
 
 require 'garden_messenger'
-require 'thor'
 
-class MessengerCLI < Thor
-  desc 'report MONITOR_URL TOKEN [options]', 'Report to a monitor which is located on MONITOR_URL'
-  option 'wattage-switch-host'
-  option 'update-rate'
-  option 'verbose', type: :boolean
-  def report(monitor_url, token)
-    reporter = GardenMessenger::Reporter.new(
-      monitor_url,
-      token,
-      options.fetch('update-rate') { 30 },
-      options.fetch('verbose') { false }
-    )
-
-    reporter.report! do
-      data = {}
-
-      if options.key?('wattage-switch-host')
-        wattage = GardenMessenger::Wattage.new(options['wattage-switch-host'])
-        data[:wattage] = wattage.get
-      end
-
-      data[:temp] = rand(18.0...26.0)
-      data[:ph] = rand(4.0...8.0)
-      data[:ec] = rand(0.8...1.6)
-
-      data
-    end
-  end
-
-  desc 'dev', 'Report random values to local monitor'
-  def dev
-    reporter = GardenMessenger::Reporter.new(
-      'ws://localhost:3000/cable',
-      'dev-token',
-      1,
-      true
-    )
-
-    reporter.report! do
-      temp = rand(18.0...26.0)
-      ph = rand(4.0...8.0)
-      ec = rand(0.8...1.6)
-      wattage = rand(700.0...800.0)
-      { temp: temp, ph: ph, ec: ec, wattage: wattage }
-    end
-  end
-end
-
-MessengerCLI.start(ARGV)
+GardenMessenger::CLI.start(ARGV)

data/garden_messenger.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'action_cable_client', '~> 3.0'
   spec.add_dependency 'http', '~> 4.1'
-  spec.add_dependency 'i2c-devices', '~> 0.0.6'
   spec.add_dependency 'thor', '~> 0.20'
 
+  spec.add_development_dependency 'activesupport', '6.0.0.rc1'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/garden_messenger/atlas_scientific/ec.rb

@@ -0,0 +1,21 @@
+require 'garden_messenger/atlas_scientific/i2c_device'
+
+module GardenMessenger
+  module AtlasScientific
+    # Abstraction layer to EZO Conductivity Circuit
+    # https://www.atlas-scientific.com/product_pages/circuits/ezo_ec.html
+    class EC < I2CDevice
+      def initialize(address = 0x64)
+        super(address)
+      end
+
+      def probe_type=(type)
+        k(type)
+      end
+
+      def k(*args)
+        execute('k', *args)
+      end
+    end
+  end
+end

data/lib/garden_messenger/atlas_scientific/i2c_device.rb

@@ -0,0 +1,100 @@
+module GardenMessenger
+  module AtlasScientific
+    class I2CDevice
+      class NoDataToSendError < StandardError; end
+      class StillProcessingError < StandardError; end
+      class CommandSyntaxError < StandardError; end
+      class UnknownStatusCodeError < StandardError; end
+
+      STILL_PROCESSING = 254
+      I2C_SLAVE = 0x0703
+
+      def initialize(address, path = Dir.glob('/dev/i2c-*').first)
+        @address = address
+        @path = path
+      end
+
+      # Takes a reading using the r ezo command
+      # and casts it to a float
+      def reading
+        r.to_f
+      end
+      alias take_reading reading
+      alias read reading
+
+      def take_reading_with_temperature_compensation(temperature)
+        rt(temperature.to_s).to_f
+      end
+
+      def calibrated?
+        !execute('cal', '?').casecmp?('?cal,0')
+      end
+
+      [
+        'baud',
+        'cal',
+        'factory',
+        'find',
+        'i',
+        'i2c',
+        'l',
+        'o',
+        'plock',
+        'r',
+        'rt',
+        'sleep',
+        'status',
+        't'
+      ].each do |cmd|
+        define_method(cmd) do |*args|
+          execute(cmd, *args)
+        end
+      end
+
+      alias information i
+
+      alias temperature_compensation t
+
+      alias protocol_lock plock
+
+      def execute(command, *args)
+        io = File.open(@path, 'r+')
+        # Set i2c address and mode
+        io.ioctl(I2C_SLAVE, @address)
+
+        # Prepare EZO command like
+        ezo_command = [command, *args].join(',')
+
+        io.syswrite(ezo_command)
+        return if command == 'sleep'
+
+        # Wait for the command to finish
+        result, status = loop do
+          result = io.read(31)
+          status = result[0].unpack1('C')
+          break [result, status] unless status == STILL_PROCESSING
+        end
+
+        check_for_status_code(status, ezo_command)
+        result[1..-1].strip
+      ensure
+        io&.close
+      end
+
+      def check_for_status_code(code, ezo_command)
+        return if code == 1
+
+        case code
+        when 255
+          raise NoDataToSendError
+        when 2
+          raise CommandSyntaxError, "There was an error executing the following command: #{ezo_command}\n" \
+                                    'Please check the documentation of your circuit.'
+        else
+          raise UnknownStatusCodeError, "Unkown Response code: #{code} received from device.\n" \
+                                        'Check the latest datasheet of atlas scientific.'
+        end
+      end
+    end
+  end
+end

data/lib/garden_messenger/atlas_scientific/ph.rb

@@ -0,0 +1,17 @@
+require 'garden_messenger/atlas_scientific/i2c_device'
+
+module GardenMessenger
+  module AtlasScientific
+    # Abstraction layer to EZO pH Circuit
+    # https://www.atlas-scientific.com/product_pages/circuits/ezo_ph.html
+    class PH < I2CDevice
+      def initialize(address = 0x63)
+        super(address)
+      end
+
+      def slope
+        execute('slope', '?')
+      end
+    end
+  end
+end

data/lib/garden_messenger/atlas_scientific/temperature.rb

@@ -0,0 +1,13 @@
+require 'garden_messenger/atlas_scientific/i2c_device'
+
+module GardenMessenger
+  module AtlasScientific
+    # Abstraction layer to EZO RTD Temperature Circuit
+    # https://www.atlas-scientific.com/product_pages/circuits/ezo_rtd.html
+    class Temperature < I2CDevice
+      def initialize(address = 0x66)
+        super(address)
+      end
+    end
+  end
+end

data/lib/garden_messenger/cli.rb

@@ -0,0 +1,57 @@
+require 'thor'
+
+module GardenMessenger
+  class CLI < Thor
+    desc 'report MONITOR_URL TOKEN [options]', 'Report to a monitor which is located on MONITOR_URL'
+    option 'wattage-switch-host'
+    option 'update-rate'
+    option 'verbose', type: :boolean
+    def report(monitor_url, token)
+      reporter = GardenMessenger::Reporter.new(
+        monitor_url,
+        token,
+        options.fetch('update-rate') { 30 },
+        options.fetch('verbose') { false }
+      )
+
+      water_temperature = GardenMessenger::AtlasScientific::Temperature.new
+      ph = GardenMessenger::AtlasScientific::PH.new
+      ec = GardenMessenger::AtlasScientific::EC.new
+      wattage = GardenMessenger::Wattage.new(options['wattage-switch-host'])
+
+      reporter.report! do
+        data = { air_temp: 0.0, humidity: 0.0 }
+
+        data[:wattage] = wattage.get if options.key?('wattage-switch-host')
+        data[:water_temp] = water_temperature.take_reading
+        ph_thread = Thread.new { ph.take_reading_with_temperature_compensation(data[:water_temp]) }
+        ec_thread = Thread.new { ec.take_reading_with_temperature_compensation(data[:water_temp]) }
+        data[:ph] = ph_thread.value
+        data[:ec] = ec_thread.value
+
+        data
+      end
+    end
+
+    desc 'dev', 'Report random values to local monitor'
+    def dev
+      reporter = GardenMessenger::Reporter.new(
+        'ws://localhost:3000/cable',
+        'dev-token',
+        1,
+        true
+      )
+
+      reporter.report! do
+        {
+          air_temp: rand(18.0...30.0),
+          humidity: rand(50.0...60.0),
+          water_temp: rand(18.0...26.0),
+          ph: rand(4.0...8.0),
+          ec: rand(0.8...1.6),
+          wattage: rand(700.0...800.0)
+        }
+      end
+    end
+  end
+end

data/lib/garden_messenger/reporter.rb

@@ -6,7 +6,7 @@ module GardenMessenger
     def initialize(monitor_url, token, update_rate, verbose = false)
       @monitor_url = monitor_url
       @token = token
-      @update_rate = update_rate
+      @update_rate = Integer(update_rate)
       @verbose = verbose
 
       if @verbose

data/lib/garden_messenger/version.rb

@@ -1,3 +1,3 @@
 module GardenMessenger
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/garden_messenger.rb

@@ -1,6 +1,11 @@
+require 'garden_messenger/cli'
 require 'garden_messenger/reporter'
 require 'garden_messenger/version'
 require 'garden_messenger/wattage'
+require 'garden_messenger/atlas_scientific/i2c_device'
+require 'garden_messenger/atlas_scientific/ph'
+require 'garden_messenger/atlas_scientific/ec'
+require 'garden_messenger/atlas_scientific/temperature'
 
 module GardenMessenger
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garden_messenger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yves Siegrist
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2019-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: action_cable_client
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: i2c-devices
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: '0.20'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.20'
-  type: :runtime
+        version: 6.0.0.rc1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 6.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +148,11 @@ files:
 - garden_messenger.gemspec
 - garden_messenger.service
 - lib/garden_messenger.rb
+- lib/garden_messenger/atlas_scientific/ec.rb
+- lib/garden_messenger/atlas_scientific/i2c_device.rb
+- lib/garden_messenger/atlas_scientific/ph.rb
+- lib/garden_messenger/atlas_scientific/temperature.rb
+- lib/garden_messenger/cli.rb
 - lib/garden_messenger/reporter.rb
 - lib/garden_messenger/version.rb
 - lib/garden_messenger/wattage.rb