atlas_scientific 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9984113c1b34d48088d53279bbfe26f8ef88bb038aafa7e510b30eb12df615d
+  data.tar.gz: 36ab968dc9358881fe662a156735a93a99deb93588ad255687f1c009a95ed63b
+SHA512:
+  metadata.gz: 01eef62a0e98a34fd15b8f8a8cc0cea9ddf63bc9df3652258a6f107b5e904cbe05d5cb1a8aecb5066ddabee57e4c8bee65ed566b61ed3b6f9630d4e38825f7c2
+  data.tar.gz: 39aa5e120126a4556bceea849db88ef2c3d0f48056402706bda730d8b5154e42f8a51d7e5e270bb5b6220bebb32413c6d54aae6dc214d5e12cc52fa6251bc3fd

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at Elektron1c97@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    atlas_scientific (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.12.2)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  atlas_scientific!
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yves Siegrist
+
+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,88 @@
+# AtlasScientific
+
+AtlasScientific is an abstraction layer [atlas scientific](https://www.atlas-scientific.com) devices.
+Any atlas scientific can be used, although the checked ones are supported with easier and optimized APIs.
+
+- [x] [PH circuit](https://www.atlas-scientific.com/product_pages/circuits/ezo_ph.html)
+- [x] [EC circuit](https://www.atlas-scientific.com/product_pages/circuits/ezo_ec.html)
+- [x] [Temperature circuit](https://www.atlas-scientific.com/product_pages/circuits/ezo_rtd.html)
+- [ ] [ORP circuit](https://www.atlas-scientific.com/product_pages/circuits/ezo_orp.html)
+- [ ] [Dissolved oxygen circuit](https://www.atlas-scientific.com/dissolved-oxygen.html)
+- [ ] [Carbon dioxide Sensor (CO2)](https://www.atlas-scientific.com/product_pages/probes/ezo-co2.html)
+- [ ] [Pressure Sensor](https://www.atlas-scientific.com/product_pages/pressure/ezo-prs.html)
+- [ ] [Flow Meter Totalizer](https://www.atlas-scientific.com/product_pages/circuits/ezo_flow.html)
+- [ ] [Color Sensor](https://www.atlas-scientific.com/product_pages/probes/ezo-rgb.html)
+
+_Disclaimer: This library only supports `i2c` mode._
+
+**NOTE**: Although they aren't "supported" you can still use this library to access them easily. See [usage](#usage).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'atlas_scientific'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install atlas_scientific
+
+## Usage
+
+There's a base class for any AtlasScientific device which can be used like this:
+
+```ruby
+require 'atlas_scientific'
+
+# The path parameter will automatically look for the first `i2c-*` device in your `/dev` folder.
+# But you can also explicitly pass it as an argument:
+pressure = AtlasScientific::I2CDevice.new(0x6A, path: '/dev/i2c-1')
+pressure.take_reading # => 12.3
+
+# enable/disables the LED
+pressure.l # => "?"
+
+# A lot of "default" commands are support through methods, e.g. cal, factory, i, find, o, status etc.
+pressure.i => "?I,psi"
+
+# If there happens to be a command which is not implemented as a method, you can call "execute":
+# This command will change the output of the pressure unit sensor as specified in the datasheet.
+# On page 46: https://www.atlas-scientific.com/_files/_datasheets/_pressure/EZO-PRS-Datasheet.pdf
+pressure.execute('u', 'bar')
+```
+
+There are also better abstraction classes for the checked circuit/probes at the top:
+
+```ruby
+# Automatically takes the default I2C address of the PH circuit (0x63)
+# The default i2c addresses can be found in the datasheets of the circuits
+# E.g. PH: https://www.atlas-scientific.com/_files/_datasheets/_circuit/pH_EZO_Datasheet.pdf
+ph = AtlasScientific::PH.new
+ph.slope # => 7.58
+ph.take_reading # => 7.58
+ph.take_reading_with_temperature_compensation(29.3) # => 7.49
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/siegy22/atlas_scientific. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AtlasScientific project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/siegy22/atlas_scientific/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/atlas_scientific.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'atlas_scientific/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'atlas_scientific'
+  spec.version       = AtlasScientific::VERSION
+  spec.authors       = ['Yves Siegrist']
+  spec.email         = ['yves@siegrist.io']
+
+  spec.summary       = 'Ruby library to provide an easy abstraction of the I2C command protocol which atlas scientific devices implement'
+  spec.homepage      = 'https://github.com/siegy22/atlas_scientific'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "atlas_scientific"
+
+# 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/lib/atlas_scientific.rb

@@ -0,0 +1,9 @@
+require 'atlas_scientific/version'
+require 'atlas_scientific/i2c_device'
+require 'atlas_scientific/ec'
+require 'atlas_scientific/ph'
+require 'atlas_scientific/temperature'
+
+module AtlasScientific
+  class Error < StandardError; end
+end

data/lib/atlas_scientific/ec.rb

@@ -0,0 +1,19 @@
+require 'atlas_scientific/i2c_device'
+
+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

data/lib/atlas_scientific/i2c_device.rb

@@ -0,0 +1,101 @@
+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
+
+    # Takes a reading with a given temperature
+    # and casts it to a float
+    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

data/lib/atlas_scientific/ph.rb

@@ -0,0 +1,15 @@
+require 'atlas_scientific/i2c_device'
+
+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

data/lib/atlas_scientific/temperature.rb

@@ -0,0 +1,11 @@
+require 'atlas_scientific/i2c_device'
+
+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

data/lib/atlas_scientific/version.rb

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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: atlas_scientific
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yves Siegrist
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: 
+email:
+- yves@siegrist.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- atlas_scientific.gemspec
+- bin/console
+- bin/setup
+- lib/atlas_scientific.rb
+- lib/atlas_scientific/ec.rb
+- lib/atlas_scientific/i2c_device.rb
+- lib/atlas_scientific/ph.rb
+- lib/atlas_scientific/temperature.rb
+- lib/atlas_scientific/version.rb
+homepage: https://github.com/siegy22/atlas_scientific
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby library to provide an easy abstraction of the I2C command protocol which
+  atlas scientific devices implement
+test_files: []