max31865 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6650202e6b271c41a4f1356c3df2102442c93cd8f355d44c748dc73a460310dc
-  data.tar.gz: c23a50da188f3b31979d991f0ff7767c61a0e437c2cbf454ea80fc695b3c6b61
+  metadata.gz: 69cbff5d02f5701e1b98a9f7b67017facfa78b84455c5200d16ff4ebe925f6c1
+  data.tar.gz: 613d468a902e9b4bc369ae10bcbbec41ecc832900ec934ad2808cba8ce3ce29e
 SHA512:
-  metadata.gz: 646d1d5d29079cbb6935f2dedae557a7d4963e7e62455a9fdd8c18818a0ae16c7f900e29e0516bdf09d929b73a6c7599201d84d4d3393b483ac0575b3950c5dd
-  data.tar.gz: d6bc5d85c7c99e2abed7059993b78fb75abc75db7e2a171cee575ce9952a471590489c806e26771e75bbc834f4093513983624f2469d32789dc4bfe18eea031c
+  metadata.gz: 8c2bf110fc27a4d63634de577d12d22c41291a57695f98ba46cb75e579f5eb05ead43697ed72a7eceb91eb7c5b81b55385c6ce267fd423ccea901a64491fa2c7
+  data.tar.gz: 7eef1c2d368568968289955f83a6ae314f33fb1eefa7eb94568828db1cf6c1fb260883a6f18aa49ba0fd689b74bbd4bfa397a957dad3f15f00cca78863ed1b9d

data/README.md

@@ -26,9 +26,9 @@ Or install it yourself as:
 
     m = MAX31865.new(chip = 0, type = :k, clock = 2_000_000)
 
-    m.config # Must be run once (shutdown resets chip)
+    m.config # Run once (shutdown resets chip)
 
-    m.read   # [Cold Junction Temp, Thermocouple Temp] Floats in celsius
+    m.read   # RTD Temp (Float in celsius)
 
 
 ## Raspberry v3
@@ -60,6 +60,12 @@ and contributors are expected to adhere to the [Contributor Covenant](http://con
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+
+## Notes
+
+For Thermocouples, check out https://github.com/nofxx/MAX31856
+
+Thanks to https://github.com/hackenbergstefan/MAX31865
+
 
 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/lib/max31865.rb

@@ -5,13 +5,14 @@ require 'pi_piper'
 # MAX31865
 #
 # Thanks to https://github.com/steve71/MAX31865/blob/master/max31865.py
+# https://github.com/hackenbergstefan/MAX31865/blob/master/max31865.py
 class MAX31865
-  attr_accessor :chip, :clock, :wires, :hz
+  attr_accessor :chip, :clock, :type, :ref, :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
+  # Resistance at 0 degC for 400ohm R_Ref
+  R0 = 100.0
+
+  # Constants for Callendar-Van-Dusen equation
   A = 0.00390830
   B = -0.000000577500
   # C = -4.18301e-12 # for -200 <= T <= 0 (degC)
@@ -29,11 +30,12 @@ class MAX31865
     0x80 => 'High threshold limit (Cable fault/open)',
     0x40 => 'Low threshold limit (Cable fault/short)',
     0x04 => 'Overvoltage or Undervoltage Error',
-    0x01 => 'RTD Open-Circuit Fault'
+    0xff => 'Circuit Fault'
   }.freeze
 
-  def initialize(chip = 0, clock = 2_000_000)
-    @chip = CHIPS[chip]
+  def initialize(chip: 0, ref: 430.0, clock: 2_000_000)
+    @chip  = CHIPS[chip]
+    @ref   = ref
     @clock = clock
   end
 
@@ -80,7 +82,7 @@ class MAX31865
   # 0b11010010 or 0xD2 for continuous auto conversion
   # at 60Hz (faster conversion)
   # 0b10110010 = 0xB2
-  def config(byte = 0xB2)
+  def config(byte = 0b11010010)
     spi_work do |spi|
       spi.write(0x80, byte)
     end
@@ -99,28 +101,39 @@ class MAX31865
   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
+  # Callendar-Van Dusen equations
+  #
+  # Convert 0 <= raw_temp < 2^l5 to temperature in oC using quadratic polynom:
+  #
+  #  R(T)=R(0)(1+A*T+B*T^{2})
+  #
+  # => T = (-A*R(0) + sqrt(A^2 R(0)^2 - 4*B*R(0)*(R(0) - R(T)))) / (2*B*R(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
+  def quadratic(adc, rtd)
+    temp = -(A * R0)
+    temp += Math.sqrt(A * A * R0 * R0 - 4 * B * R0 * (R0 - rtd))
+    temp /= 2 * B * R0
+    # puts "Callendar-Van Dusen Temp (degC > 0): #{temp}C"
+    temp < 0 ? (adc / 32) - 256 : temp
+  end
+
+  # """
+  # Convert 0 <= raw_temp < 2^15 to temperature in oC using quartic polynom:
+  #
+  #  R(T) = R(0)[1+A*T+B*T^{2}+(T-100)C*T^{3}]
+  #
+  # => 0 = R(0)[1 + A*T + B*T^2 - 100*C*T^3 + C*T^4] - R(T)
+  #
+  # Solution is calculated numerically.
+  #
+  def quartic(rtd)
+    temp = rtd * R0 / (2**15 - 1)
+    roots = [C * R0, -100 * R0 * C, B * R0, A * R0, R0 - temp]
+            .map { |n| Math.sqrt(n) }
+    Math.abs(roots[-1])
   end
 
   #
@@ -129,13 +142,13 @@ class MAX31865
   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"
+    adc = ((rtd_msb << 8) | rtd_lsb) >> 1
+    # puts "RTD ADC Code: #{adc}"
+    # temp_line = (adc / 32.0) - 256.0
+    # puts "Straight Line Approx. Temp: #{temp_line}C"
+    rtd = (adc * ref) / 32_768.0 # PT100 Resistance
+    # puts "PT100 Resistance: #{rtd} ohms"
+    quadratic(adc, rtd)
   end
 
   #

data/lib/max31865/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: max31865
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Marcos Piccinini