max31865 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6650202e6b271c41a4f1356c3df2102442c93cd8f355d44c748dc73a460310dc
+  data.tar.gz: c23a50da188f3b31979d991f0ff7767c61a0e437c2cbf454ea80fc695b3c6b61
+SHA512:
+  metadata.gz: 646d1d5d29079cbb6935f2dedae557a7d4963e7e62455a9fdd8c18818a0ae16c7f900e29e0516bdf09d929b73a6c7599201d84d4d3393b483ac0575b3950c5dd
+  data.tar.gz: d6bc5d85c7c99e2abed7059993b78fb75abc75db7e2a171cee575ce9952a471590489c806e26771e75bbc834f4093513983624f2469d32789dc4bfe18eea031c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,6 @@
+# Contributor Covenant Code of Conduct
+
+
+## Our Standards
+
+Do what the fuck you want to.

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 max31865.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Marcos Piccinini
+
+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,65 @@
+# MAX31865
+
+MAX31865 - Precision RTD (PT-100) Digital Converter with Linearization
+
+Ruby SPI interface using PiPiper
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'max31865'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install max31865
+
+
+## Usage
+
+    m = MAX31865.new(chip = 0, type = :k, clock = 2_000_000)
+
+    m.config # Must be run once (shutdown resets chip)
+
+    m.read   # [Cold Junction Temp, Thermocouple Temp] Floats in celsius
+
+
+## Raspberry v3
+
+To enable SPI on the Rpi, on `/boot/config.txt`:
+
+    dtparam=spi=on
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` 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/nofxx/max31865.
+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 MAX31865 project’s codebases and issue trackers is expected to follow the [code of conduct](https://github.com/nofxx/max31865/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'max31865'
+
+# 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__)
+
+m = MAX31865.new
+m.read_fault
+m.config
+loop do
+  m.read_all
+end

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/max31865.rb

@@ -0,0 +1,160 @@
+require 'max31865/version'
+require 'pi_piper'
+
+#
+# MAX31865
+#
+# Thanks to https://github.com/steve71/MAX31865/blob/master/max31865.py
+class MAX31865
+  attr_accessor :chip, :clock, :wires, :hz
+
+  # Read registers
+  READ_REG = [0, 8].freeze
+  R_REF = 430.0 # Reference Resistor
+  R0    = 100.0 # Resistance at 0 degC for 400ohm R_Ref
+  A = 0.00390830
+  B = -0.000000577500
+  # C = -4.18301e-12 # for -200 <= T <= 0 (degC)
+  C = -0.00000000000418301
+  # C = 0 # for 0 <= T <= 850 (degC)
+
+  CHIPS = {
+    0 => PiPiper::Spi::CHIP_SELECT_0,
+    1 => PiPiper::Spi::CHIP_SELECT_1,
+    2 => PiPiper::Spi::CHIP_SELECT_BOTH,
+    3 => PiPiper::Spi::CHIP_SELECT_NONE
+  }.freeze
+
+  FAULTS = {
+    0x80 => 'High threshold limit (Cable fault/open)',
+    0x40 => 'Low threshold limit (Cable fault/short)',
+    0x04 => 'Overvoltage or Undervoltage Error',
+    0x01 => 'RTD Open-Circuit Fault'
+  }.freeze
+
+  def initialize(chip = 0, clock = 2_000_000)
+    @chip = CHIPS[chip]
+    @clock = clock
+  end
+
+  def spi_work
+    PiPiper::Spi.begin do |spi|
+      # Set cpol, cpha
+      PiPiper::Spi.set_mode(1, 1)
+
+      # Setup the chip select behavior
+      spi.chip_select_active_low(true)
+
+      # Set the bit order to MSB
+      spi.bit_order PiPiper::Spi::MSBFIRST
+
+      # Set the clock divider to get a clock speed of 2MHz
+      spi.clock clock
+
+      spi.chip_select(chip) do
+        yield spi
+      end
+    end
+  end
+
+  #
+  # Run once config
+  #
+  #
+  # Optionally set samples
+  #
+  # 0x8x to specify 'write register value'
+  # 0xx0 to specify 'configuration register'
+  #
+  #
+  # Config Register
+  # ---------------
+  # bit 7  : Vbias -> 1 (ON)
+  # bit 6  : Conversion Mode -> 0 (MANUAL)
+  # bit 5  : 1-shot ->1 (ON)
+  # bit 4  : 3-wire select -> 1 (3 wire config)
+  # bit 3-2: fault detection cycle -> 0 (none)
+  # bit 1  : fault status clear -> 1 (clear any fault)
+  # bit 0  : 50/60 Hz filter select -> 0 (60Hz)
+  #
+  # 0b11010010 or 0xD2 for continuous auto conversion
+  # at 60Hz (faster conversion)
+  # 0b10110010 = 0xB2
+  def config(byte = 0xB2)
+    spi_work do |spi|
+      spi.write(0x80, byte)
+    end
+    sleep 0.2 # give it 200ms for conversion
+  end
+
+  #
+  # Read temperature!
+  #
+  def read
+    spi_work do |spi|
+      read_temp(spi.write(Array.new(8, 0x01)))
+    end
+  end
+
+  private
+
+  #
+  # Callendar-Van Dusen equation
+  # Res_RTD = Res0 * (1 + a*T + b*T**2 + c*(T-100)*T**3)
+  # Res_RTD = Res0 + a*Res0*T + b*Res0*T**2 # c = 0
+  # (c*Res0)T**4 - (c*Res0)*100*T**3
+  # + (b*Res0)*T**2 + (a*Res0)*T + (Res0 - Res_RTD) = 0
+  #
+  # quadratic formula:
+  # for 0 <= T <= 850 (degC)
+  #
+  def callendar_van_dusen(rtd)
+    temp = -(A * R0) +
+           Math.sqrt(A * A * R0 * R0 - 4 * (B * R0) * (R0 - rtd))
+    temp /= (2 * (B * R0))
+    # temp_line = (rtd_adc_code / 32.0) - 256.0
+    # puts "Straight Line Approx. Temp: #{temp_line}C"
+    # removing numpy.roots will greatly speed things up
+    # temp_C_numpy = numpy.roots([c*R0, -c*R0*100, b*R0, a*R0, (R0 - rtd)])
+    # temp_C_numpy = abs(temp_C_numpy[-1])
+    # print "Solving Full Callendar-Van Dusen using numpy: %f" %  temp_C_numpy
+    # use straight line approximation if less than 0
+    # Can also use python lib numpy to solve cubic
+    temp < 0 ? (rtd_adc_code / 32) - 256 : temp
+  end
+
+  #
+  # Read temperature
+  #
+  def read_temp(raw)
+    read_fault(raw[7])
+    rtd_msb, rtd_lsb = raw[1], raw[2]
+    rtd_adc_code = ((rtd_msb << 8) | rtd_lsb) >> 1
+
+    puts "RTD ADC Code: #{rtd_adc_code}"
+    rtd = (rtd_adc_code * R_REF) / 32_768.0 # PT100 Resistance
+    temp = callendar_van_dusen(rtd)
+    puts "PT100 Resistance: #{rtd} ohms"
+    puts "Callendar-Van Dusen Temp (degC > 0): #{temp}C"
+  end
+
+  #
+  # Read register faults
+  #
+  # 10 Mohm resistor is on breakout board to help detect cable faults
+  #
+  # bit 7: RTD High Threshold / cable fault open
+  # bit 6: RTD Low Threshold / cable fault short
+  # bit 5: REFIN- > 0.85 x VBias -> must be requested
+  # bit 4: REFIN- < 0.85 x VBias (FORCE- open) -> must be requested
+  # bit 3: RTDIN- < 0.85 x VBias (FORCE- open) -> must be requested
+  # bit 2: Overvoltage / undervoltage fault
+  # bits 1,0 don't care
+  # print "Status byte: #{status}"
+  #
+  def read_fault(byte)
+    FAULTS.each do |code, fault|
+      raise fault if byte & code == 1
+    end
+  end
+end

data/lib/max31865/version.rb

@@ -0,0 +1,3 @@
+class MAX31865
+  VERSION = '0.1.7'.freeze
+end

data/max31865.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'max31865/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'max31865'
+  spec.version       = MAX31865::VERSION
+  spec.authors       = ['Marcos Piccinini']
+  spec.email         = ['x@nofxx.com']
+
+  spec.summary       = %q{Read temperatures from MAX31865 Thermocouple.}
+  spec.description   = %q{PiPiper based wrapper for MAX31865 SPI Interface.}
+  spec.homepage      = 'https://github.com/nofxx/max31865'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'pi_piper', '~> 2.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: max31865
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Marcos Piccinini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pi_piper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: PiPiper based wrapper for MAX31865 SPI Interface.
+email:
+- x@nofxx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/max31865.rb
+- lib/max31865/version.rb
+- max31865.gemspec
+homepage: https://github.com/nofxx/max31865
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Read temperatures from MAX31865 Thermocouple.
+test_files: []