├── .gitignore ├── Examples ├── Full_Test_Oled │ └── Full_Test_Oled.ino ├── Full_Test_Serial │ └── Full_Test_Serial.ino └── Read_Temperature │ └── Read_Temperature.ino ├── LICENSE ├── MAX31865.cpp ├── MAX31865.h ├── README.md └── keywords.txt /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | -------------------------------------------------------------------------------- /Examples/Full_Test_Oled/Full_Test_Oled.ino: -------------------------------------------------------------------------------- 1 | // **************************************************************************** 2 | // MAX31865 Break-out board Full test Example with OLED display 3 | // ***************************************************************************** 4 | // 5 | // For any explanation on this breakout board 6 | // look at my blog post here http://hallard.me/max31865 7 | // 8 | // Written by Charles-Henri Hallard (http://hallard.me) 9 | // 10 | // History : V1.00 2015-07-14 - First release 11 | // 12 | // This sketch as been tested on early ULPNode prototype called ArduiNode 13 | // see https://github.com/hallard/ULPNode/tree/master/hardware/ArduiNode 14 | // where MAX31865 breakout board was plugged in 15 | // 16 | // It should work on any 3.3V (if 5V you need to add level converters) boards 17 | // such as Arduino/Clone as soon as connections are as follow 18 | // 19 | // Arduino Uno --> MAX31865 break out board 20 | // ------------------------------------------- 21 | // 3V3 (!not 5V) --> NRF Connector pin 8 (VCC) 22 | // GND --> NRF Connector pin 1 (GND) 23 | // CS: pin D10 --> NRF Connector pin 7 (CSN) 24 | // MOSI: pin D11 --> NRF Connector pin 6 (MOSI) 25 | // MISO: pin D12 --> NRF Connector pin 4 (MISO) 26 | // SCK: pin D13 --> NRF Connector pin 3 (SCK) 27 | // 28 | // Optional IRQ and LED (set #define below) 29 | // ------------------------------------------- 30 | // IO pin D8 --> NRF Connector pin 2 (LED) 31 | // IRQ: pin D2 --> NRF Connector pin 5 (IRQ) 32 | // 33 | // Optional OLED I2C Display 34 | // (4K7 Pullup on SDA/SCL recommended) 35 | // Arduino Uno --> 128x*64 OLED Display 36 | // ------------------------------------------- 37 | // 3V3 --> OLED 3V3 38 | // GND --> OLED GND 39 | // SDA pin A4 --> OLED I2C SDA 40 | // SCL pin A5 --> OLED I2C SCL 41 | // 42 | // Dependencies 43 | // ============ 44 | // u8glib library see https://github.com/olikraus/U8glib_Arduino 45 | // 46 | // ***************************************************************************** 47 | // This program is free software: you can redistribute it and/or modify 48 | // it under the terms of the GNU General Public License as published by 49 | // the Free Software Foundation, either version 3 of the License, or 50 | // (at your option) any later version. 51 | // 52 | // This program is distributed in the hope that it will be useful, 53 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 54 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 55 | // GNU General Public License for more details. 56 | // 57 | // You should have received a copy of the GNU General Public License 58 | // along with this program. If not, see . 59 | // 60 | // All text above must be included in any redistribution. 61 | // 62 | // ***************************************************************************** 63 | 64 | #include 65 | #include 66 | #include 67 | #include 68 | #include "U8glib.h" 69 | 70 | 71 | // define here PT1000 or PT100 72 | // =========================== 73 | #define PT1000 74 | //#define PT100 75 | 76 | // define here false for 2 wires 77 | // true for 3/4 wires 78 | // ============================== 79 | #define USE_3WIRES false 80 | //#define USE_3WIRES true 81 | 82 | // Led on MAX31865 Break-out Board 83 | #define LED_MAX31865 8 84 | // Data Ready Signal on MAX31865 Break-out Board 85 | // Comment if you did not connected te IRQ signal of 86 | // breakout board to a IO, else set IO here 87 | #define DRDY_MAX31865 2 88 | 89 | // Chip Select Pin 90 | #define RTD_CS_PIN 10 91 | 92 | // MAX31865 device status seen on SPI bus or not 93 | // This is before device internal status register 94 | #define MAX31865_STATE_NOT_FOUND 0 95 | #define MAX31865_STATE_TRANSMIT_ERROR 1 96 | #define MAX31865_STATE_OK 2 97 | #define MAX31865_RTD_CONFIG_FAULT 3 98 | 99 | // Do measure every 2 seconds 100 | #define MEASURE_INTERVAL 2000L 101 | 102 | // mask to know where to print data 103 | #define PRINT_MODE_SERIAL 0x01 104 | #define PRINT_MODE_OLED 0x02 105 | #define PRINT_MODE_BOTH (PRINT_MODE_SERIAL | PRINT_MODE_OLED) 106 | 107 | // Got some of old Arduinode revisions and prototype boards 108 | // so I need specifc setup to define board type to adjust the pin 109 | // mapping depending on the board used during my tests 110 | // Early ULPNode board (I use on this one but it's not mandatory) 111 | // See https://github.com/hallard/ULPNode/tree/master/hardware/ArduiNode 112 | // for schematics of this little test board 113 | // Don't worry, it works on any board, it's just my specific settings 114 | #ifdef ARDUINO_ARDUINODE_V13 115 | #define RF_IRQ 2 116 | #define SW_IRQ 3 117 | #define LED_BLU 4 118 | #define LED_GRN 5 119 | #define LED_RED 6 120 | #define OLED_POWER_PIN 7 121 | #define RF_CE 8 122 | #define RF_POWER_PIN 9 123 | #define RF_SS 10 124 | #define VBATT A1 125 | #define SENSOR_POWER_PIN A2 126 | #define SENSOR_DHT_DQ A3 127 | #define SENSOR_NTC A6 128 | #define SENSOR_LIGHT A7 129 | #define rfPWR_ON() digitalWrite(RF_POWER_PIN, LOW) 130 | #define rfPWR_OFF() digitalWrite(RF_POWER_PIN, HIGH) 131 | #define sensorPWR_ON() digitalWrite(SENSOR_POWER_PIN, HIGH) 132 | #define sensorPWR_OFF() digitalWrite(SENSOR_POWER_PIN, LOW) 133 | #define oledPWR_ON() digitalWrite(OLED_POWER_PIN, LOW) 134 | #define oledPWR_OFF() digitalWrite(OLED_POWER_PIN, HIGH) 135 | 136 | // turn the LED on (Arduino pin = 1 = Led ON because of hardware, change if needed) 137 | // 138 | // R LED 139 | // GND +----===----|<|----- Aruino Pin 140 | // 141 | #define ledON(x) digitalWrite(x, HIGH) 142 | #define ledOFF(x) digitalWrite(x, LOW) 143 | #endif 144 | 145 | // see MAX31865 datasheet page 20/21 146 | // Table 9. Temperature Example for PT100 with 400Ω RREF 147 | // to set Min Max temps (value) 148 | #define FAULT_HIGH_THRESHOLD 0x9304 /* +350C */ 149 | #define FAULT_LOW_THRESHOLD 0x2690 /* -100C */ 150 | //#define FAULT_HIGH_THRESHOLD 0xBE64 /* +550C */ 151 | //#define FAULT_LOW_THRESHOLD 0x0BDA /* -200C */ 152 | 153 | #ifdef PT1000 154 | // For PT 1000 (Ref on breakout board = 3900 Ohms 0.1%) 155 | MAX31865_RTD rtd( MAX31865_RTD::RTD_PT1000, RTD_CS_PIN, 3900 ); 156 | #endif 157 | 158 | #ifdef PT100 159 | // For PT 100 (Ref Ref on breakout board = 390 Ohms 0.1%) 160 | MAX31865_RTD rtd( MAX31865_RTD::RTD_PT100, RTD_CS_PIN, 390 ); 161 | #endif 162 | 163 | // Instantiate the I2C OLED 164 | U8GLIB_SSD1306_128X64 display(U8G_I2C_OPT_DEV_0|U8G_I2C_OPT_NO_ACK|U8G_I2C_OPT_FAST); // Fast I2C / TWI 165 | 166 | // Macro to calculate where to place text to center it 167 | #define CenterText(t) ( (display.getWidth() - display.getStrWidth(t) ) / 2) 168 | 169 | //#define U8G_FONT_SMALL u8g_font_7x14 170 | //#define U8G_FONT_SMALL u8g_font_profont15 171 | //#define U8G_FONT_MEDIUM u8g_font_fub14r 172 | //#define U8G_FONT_BOLD u8g_font_fub11r 173 | #define U8G_FONT_BOLD u8g_font_9x15Br 174 | //#define U8G_DIGIT u8g_font_freedoomr25n 175 | #define U8G_DIGIT u8g_font_fub25n 176 | 177 | // Error message associated to status 178 | uint8_t status; 179 | String status_text; 180 | char buffer[32]; // Temp buffer for formating string/display text 181 | // MAX31865 device status seen on SPI bus or not 182 | uint8_t max31865_state = MAX31865_STATE_NOT_FOUND; 183 | 184 | 185 | /* ====================================================================== 186 | Function: status2text 187 | Purpose : convert status to human readable text 188 | Input : status register of MAX31865 189 | Output : pointer to error string 190 | Comments: - 191 | ====================================================================== */ 192 | String status2text(uint8_t status) 193 | { 194 | // Default 195 | status_text = ""; 196 | 197 | if( status == 0 ) 198 | status_text += F("OK!"); 199 | else { 200 | if( status & MAX31865_FAULT_HIGH_THRESHOLD ) 201 | status_text += F("RTD high thre. exceeded "); 202 | if( status & MAX31865_FAULT_LOW_THRESHOLD ) 203 | status_text += F("RTD low thres. exceeded "); 204 | if( status & MAX31865_FAULT_REFIN ) 205 | status_text += F("REFIN- > 0.85x V_BIAS "); 206 | if( status & MAX31865_FAULT_REFIN_FORCE ) 207 | status_text += F("REFIN- < 0.85x V_BIAS F- Open "); 208 | if( status & MAX31865_FAULT_RTDIN_FORCE ) 209 | status_text += F("RTDIN- < 0.85x V_BIAS F- Open "); 210 | if( status & MAX31865_FAULT_VOLTAGE ) 211 | status_text += F("Overvoltage / undervoltage "); 212 | } 213 | 214 | return (status_text); 215 | } 216 | 217 | /* ====================================================================== 218 | Function: drawTemp 219 | Purpose : display temp big digit on OLED page loop 220 | Input : temp formated string 221 | Output : - 222 | Comments: - 223 | ====================================================================== */ 224 | void drawTemp(char * temp) 225 | { 226 | display.setFont(U8G_FONT_BOLD); 227 | display.setFontPosTop(); 228 | 229 | // Temp with big digit 230 | display.setFont(U8G_DIGIT); 231 | display.setFontPosTop(); 232 | display.drawStr( CenterText(temp), 0, temp); 233 | 234 | // R Ref and R measured values 235 | display.setFont(U8G_FONT_BOLD); 236 | display.setFontPosTop(); 237 | 238 | sprintf_P(buffer, PSTR("RTD %d Ohms"), rtd.raw_resistance()); 239 | display.drawStr( CenterText(buffer), 32, buffer); 240 | 241 | sprintf_P(buffer, PSTR("REF %d Ohms"), rtd.cfg_rref()); 242 | display.drawStr( CenterText(buffer), 48, buffer); 243 | } 244 | 245 | /* ====================================================================== 246 | Function: drawError 247 | Purpose : display error OLED page loop 248 | Input : status register of MAX31865 249 | Output : - 250 | Comments: - 251 | ====================================================================== */ 252 | void drawError(uint8_t status) 253 | { 254 | display.setFont(U8G_FONT_BOLD); 255 | display.setFontPosTop(); 256 | 257 | if (max31865_state==MAX31865_STATE_NOT_FOUND) 258 | { 259 | strcpy_P(buffer, PSTR("Unable to")); 260 | display.drawStr( CenterText(buffer), 0, buffer); 261 | strcpy_P(buffer, PSTR("Communicate")); 262 | display.drawStr( CenterText(buffer),16, buffer); 263 | strcpy_P(buffer, PSTR("with MAX31865")); 264 | display.drawStr( CenterText(buffer),32, buffer); 265 | strcpy_P(buffer, PSTR("chip plugged ?")); 266 | display.drawStr( CenterText(buffer),48, buffer); 267 | } 268 | else if (max31865_state==MAX31865_STATE_TRANSMIT_ERROR) 269 | { 270 | strcpy_P(buffer, PSTR("MAX31868 SPI")); 271 | display.drawStr( CenterText(buffer), 0, buffer); 272 | strcpy_P(buffer, PSTR("Communication")); 273 | display.drawStr( CenterText(buffer),16, buffer); 274 | strcpy_P(buffer, PSTR("problem")); 275 | display.drawStr( CenterText(buffer),32, buffer); 276 | strcpy_P(buffer, PSTR("check wiring!")); 277 | display.drawStr( CenterText(buffer),48, buffer); 278 | } 279 | /* 280 | else if (max31865_state==MAX31865_RTD_CONFIG_FAULT) 281 | { 282 | display.setCursor(8,0); 283 | display.print("RTD Config"); 284 | display.setCursor(32,2); 285 | display.print("Error"); 286 | display.setCursor(4,4); 287 | display.print("Check Solder"); 288 | display.setCursor(4,6); 289 | display.print("pads config!"); 290 | 291 | }*/ 292 | else 293 | { 294 | sprintf_P(buffer, PSTR("Status:0x%02X"), status); 295 | display.drawStr( CenterText(buffer), 0, buffer); 296 | //display.setPrintPos(0,16); 297 | sprintf_P(buffer, PSTR("RTD=%d"), rtd.raw_resistance()); 298 | display.drawStr( CenterText(buffer),16, buffer); 299 | 300 | // Get status in text format 301 | status2text(status); 302 | //display.print( status_text ); 303 | 304 | display.setPrintPos(0,32); 305 | 306 | // Handle new line on OLED 307 | for (uint8_t i=0; i= MEASURE_INTERVAL) 441 | { 442 | // reset our last measure 443 | lastRefreshed += MEASURE_INTERVAL; 444 | 445 | // default not found 446 | max31865_state = MAX31865_STATE_NOT_FOUND; 447 | 448 | Serial.print( millis()/1000); 449 | Serial.print(F("\tChecking MAX31865 SPI chip...")); 450 | 451 | // Indicate onboard MAX31865 we do a measure 452 | #ifdef LED_MAX31865 453 | digitalWrite(LED_MAX31865, 0); 454 | #endif 455 | 456 | /* Reconfigure this allow us to plug/unplug the module and check PT100/PT1000 457 | V_BIAS enabled 458 | No Auto-conversion 459 | 1-shot disabled 460 | 3-wire 461 | Fault detection: we need to manual mode, set manual 1 => First stage 462 | because on MAX31865 beakout board, RC constant is > 100us 463 | see MAX31865 datasheet page 14 / Section Fault Detection Cycle (D3:D2) 464 | Fault status: auto-clear 465 | 50 Hz filter 466 | Low threshold: FAULT_LOW_THRESHOLD 467 | High threshold: FAULT_HIGH_THRESHOLD 468 | */ 469 | 470 | // 1st do full configuration, enable vbias and wait 5*RC constant 471 | // see MAX31865 datasheet page 14 / Section Fault Detection Cycle (D3:D2) 472 | rtd.configure( true, false, false, USE_3WIRES, MAX31865_FAULT_DETECTION_NONE, 473 | true, true, FAULT_LOW_THRESHOLD, FAULT_HIGH_THRESHOLD ); 474 | //delay(60); 475 | 476 | // We will read back thresold, to check it's same we wrote 477 | rtd.read_all( ); 478 | 479 | // Spi read 0xffff or 0x0000, mainly no com with device 480 | if ( ( rtd.low_threshold()== 0x0 || rtd.low_threshold() == 0xffff ) && 481 | ( rtd.high_threshold()== 0x0 || rtd.high_threshold()== 0xffff ) ) 482 | { 483 | #ifdef ARDUINO_ARDUINODE_V13 484 | ledOFF(LED_BLU); 485 | #endif 486 | max31865_state = MAX31865_STATE_NOT_FOUND; 487 | Serial.println(F("No communication, is breakout board plugged ?")); 488 | 489 | // Blue LED off (on = indicate MAX31865 seen and talk) 490 | } 491 | // we found something, but not what we wrote on threshold registers, bad com!!! 492 | else if ( (rtd.low_threshold()!= FAULT_LOW_THRESHOLD) || (rtd.high_threshold()!=FAULT_HIGH_THRESHOLD)) 493 | { 494 | // Blue LED off (on = indicate MAX31865 seen and talk) 495 | #ifdef ARDUINO_ARDUINODE_V13 496 | ledOFF(LED_BLU); 497 | #endif 498 | max31865_state = MAX31865_STATE_TRANSMIT_ERROR; 499 | Serial.println(F("SPI transmission error, verify wiring!")); 500 | Serial.print(F("\t Set low threshold to 0x")); 501 | Serial.print( FAULT_LOW_THRESHOLD,HEX); 502 | Serial.print(F( " just read 0x")); 503 | Serial.println( rtd.low_threshold(),HEX); 504 | Serial.print(F( "\t Set high threshold to 0x")); 505 | Serial.print( FAULT_HIGH_THRESHOLD,HEX); 506 | Serial.print(F( " just read 0x")); 507 | Serial.println( rtd.high_threshold(),HEX); 508 | } 509 | // ok all seems fine untils there we can talk to device to do action 510 | else 511 | { 512 | // Blue LED indicate MAX31865 seen and talk 513 | #ifdef ARDUINO_ARDUINODE_V13 514 | ledON(LED_BLU); 515 | #endif 516 | 517 | max31865_state = MAX31865_STATE_OK; 518 | Serial.println(F("Found OK!")); 519 | Serial.print(F("\t Checking manual fault detection Stage 1 ")); 520 | 521 | // Stage 1 522 | // Now we're ready to start fault detection (RTD connection) 523 | // V_BIAS enabled , No Auto-conversion, 1-shot disabled, Fault detection Stage 1 524 | rtd.configure( true, false, false, MAX31865_FAULT_DETECTION_MANUAL_1 ); 525 | 526 | // wait some time MAX31865 has finished the test 527 | // no indication in datasheet on how much time it take 528 | // but without this delay value returned is not 0x20 but 0x00 529 | delay(2); 530 | 531 | // After stage 1, fault status should return 0x20 532 | // MAX31865 datasheet page 14 / Section Fault Detection Cycle (D3:D2) 533 | sprintf_P(buffer, PSTR("status=%02X => OK!"), rtd.fault_status() ); 534 | Serial.println(buffer); 535 | Serial.print(F("\t Checking manual fault detection Stage 2 ")); 536 | 537 | // Wait 5 * RC constant before stage 2 538 | // see MAX31865 datasheet page 14 / Section Fault Detection Cycle (D3:D2) 539 | delay(60); 540 | 541 | // Stage 2 542 | // V_BIAS enabled , No Auto-conversion, 1-shot disabled, 543 | rtd.configure( true, false, false, MAX31865_FAULT_DETECTION_MANUAL_2 ); 544 | 545 | // wait some time MAX31865 has finished the test 546 | // no indication in datasheet on how much time it take 547 | // but without this delay value returned may be inconsistent 548 | delay(2); 549 | 550 | // ok what device is saying about Fault Detection ? 551 | status = rtd.fault_status(); 552 | 553 | sprintf_P(buffer, PSTR("status=%02X =>"), status ); 554 | Serial.print(buffer); 555 | 556 | status2text(status); 557 | Serial.println(status_text); 558 | 559 | // Ok all wnet fine ? we'll do a measure 560 | if (status==0 ) 561 | { 562 | max31865_state = MAX31865_STATE_OK; 563 | 564 | Serial.print(F("\t Starting conversion...")); 565 | 566 | // Start 1 shot measure 567 | // V_BIAS enabled , No Auto-conversion, 1-shot enabled, No Fault detection 568 | rtd.configure( true, false, true, MAX31865_FAULT_DETECTION_NONE ); 569 | 570 | // onboard MAX31865 will push DRDY line low when measure's done 571 | #ifdef DRDY_MAX31865 572 | // Time out start 573 | unsigned long timeout = millis(); 574 | 575 | // wait chip says finished or timeout (datasheet says max 66ms) 576 | while ( digitalRead(DRDY_MAX31865)==1 && millis()-timeout < 70); 577 | 578 | if ( millis()-timeout>=70) 579 | // Display conversion time 580 | Serial.print(F("(timed-out ")); 581 | else 582 | // Display conversion time 583 | Serial.print(F("(in ")); 584 | 585 | Serial.print(millis()-timeout,DEC); 586 | Serial.print(F("ms) ")); 587 | #else 588 | // 50 Hz max conversion time in one shot 589 | delay(70); 590 | #endif 591 | 592 | // Read MAX31865 all registers values 593 | status = rtd.read_all(); 594 | 595 | sprintf_P(buffer, PSTR("Status:%02X "), status ); 596 | Serial.println(buffer); 597 | 598 | Serial.print(F( "\t RTD:")); 599 | Serial.print( rtd.raw_resistance()); 600 | 601 | // display temperature reading on serial 602 | double temperature = rtd.temperature(); 603 | Serial.print(F( " Ohms => Temp:")); 604 | Serial.print( temperature,1); 605 | Serial.println(F(" C" )); 606 | 607 | display.firstPage(); 608 | do { 609 | // display temperature reading on OLED 610 | dtostrf(temperature, 3,1, buffer); 611 | drawTemp(buffer); 612 | } 613 | while( display.nextPage() ); 614 | } 615 | 616 | // disable V_BIAS and one shot to reduce power 617 | rtd.configure( false, false, false, MAX31865_FAULT_DETECTION_NONE); 618 | 619 | } // device seen 620 | 621 | // All is good ? 622 | if( max31865_state==MAX31865_STATE_OK && status==0 && rtd.raw_resistance()!=0 ) 623 | { 624 | // We displayed all, add what you want there 625 | } 626 | else 627 | { 628 | display.firstPage(); 629 | do { 630 | drawError(status); 631 | } 632 | while( display.nextPage() ); 633 | } 634 | 635 | #ifdef LED_MAX31865 636 | // measure done 637 | digitalWrite(LED_MAX31865, 1); 638 | #endif 639 | 640 | Serial.println(F("\tDone!\r\n")); 641 | } 642 | 643 | // Manage blink led (Red error, Green OK) 644 | #ifdef ARDUINO_ARDUINODE_V13 645 | uint8_t led ; 646 | led = status==0?LED_GRN:LED_RED; 647 | if (millis() % 200 < 50 ) 648 | ledON(led); 649 | else 650 | ledOFF(led); 651 | #endif 652 | } 653 | 654 | -------------------------------------------------------------------------------- /Examples/Full_Test_Serial/Full_Test_Serial.ino: -------------------------------------------------------------------------------- 1 | // **************************************************************************** 2 | // MAX31865 Break-out board Full test Example on Serial 3 | // ***************************************************************************** 4 | // 5 | // For any explanation on this breakout board 6 | // look at my blog post here http://hallard.me/max31865 7 | // 8 | // Written by Charles-Henri Hallard (http://hallard.me) 9 | // 10 | // History : V1.00 2015-07-14 - First release 11 | // 12 | // This sketch as been tested on early ULPNode prototype called ArduiNode 13 | // see https://github.com/hallard/ULPNode/tree/master/hardware/ArduiNode 14 | // where MAX31865 breakout board was plugged in 15 | // 16 | // It should work on any 3.3V (if 5V you need to add level converters) boards 17 | // such as Arduino/Clone as soon as connections are as follow 18 | // 19 | // Arduino Uno --> MAX31865 break out board 20 | // ------------------------------------------- 21 | // 3V3 (!not 5V) --> NRF Connector pin 8 (VCC) 22 | // GND --> NRF Connector pin 1 (GND) 23 | // CS: pin D10 --> NRF Connector pin 7 (CSN) 24 | // MOSI: pin D11 --> NRF Connector pin 6 (MOSI) 25 | // MISO: pin D12 --> NRF Connector pin 4 (MISO) 26 | // SCK: pin D13 --> NRF Connector pin 3 (SCK) 27 | // 28 | // Optional IRQ and LED (set #define below) 29 | // ------------------------------------------- 30 | // IO pin D8 --> NRF Connector pin 2 (LED) 31 | // IRQ: pin D2 --> NRF Connector pin 5 (IRQ) 32 | // 33 | // Optional OLED I2C Display 34 | // (4K7 Pullup on SDA/SCL recommended) 35 | // Arduino Uno --> 128x*64 OLED Display 36 | // ------------------------------------------- 37 | // 3V3 --> OLED 3V3 38 | // GND --> OLED GND 39 | // SDA pin A4 --> OLED I2C SDA 40 | // SCL pin A5 --> OLED I2C SCL 41 | // 42 | // Dependencies 43 | // ============ 44 | // u8glib library see https://github.com/olikraus/U8glib_Arduino 45 | // 46 | // ***************************************************************************** 47 | // This program is free software: you can redistribute it and/or modify 48 | // it under the terms of the GNU General Public License as published by 49 | // the Free Software Foundation, either version 3 of the License, or 50 | // (at your option) any later version. 51 | // 52 | // This program is distributed in the hope that it will be useful, 53 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 54 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 55 | // GNU General Public License for more details. 56 | // 57 | // You should have received a copy of the GNU General Public License 58 | // along with this program. If not, see . 59 | // 60 | // All text above must be included in any redistribution. 61 | // 62 | // ***************************************************************************** 63 | 64 | #include 65 | #include 66 | #include 67 | #include 68 | 69 | // define here PT1000 or PT100 70 | // =========================== 71 | #define PT1000 72 | //#define PT100 73 | 74 | // define here false for 2 wires 75 | // true for 3/4 wires 76 | // ============================== 77 | #define USE_3WIRES false 78 | //#define USE_3WIRES true 79 | 80 | 81 | // Led on MAX31865 Break-out Board 82 | #define LED_MAX31865 8 83 | // Data Ready Signal on MAX31865 Break-out Board 84 | // Comment if you did not connected te IRQ signal of 85 | // breakout board to a IO, else set IO here 86 | #define DRDY_MAX31865 2 87 | 88 | // Chip Select Pin 89 | #define RTD_CS_PIN 10 90 | 91 | // MAX31865 device status seen on SPI bus or not 92 | // This is before device internal status register 93 | #define MAX31865_STATE_NOT_FOUND 0 94 | #define MAX31865_STATE_TRANSMIT_ERROR 1 95 | #define MAX31865_STATE_OK 2 96 | #define MAX31865_RTD_CONFIG_FAULT 3 97 | 98 | // Do measure every 2 seconds 99 | #define MEASURE_INTERVAL 2000L 100 | 101 | // mask to know where to print data 102 | #define PRINT_MODE_SERIAL 0x01 103 | #define PRINT_MODE_OLED 0x02 104 | #define PRINT_MODE_BOTH (PRINT_MODE_SERIAL | PRINT_MODE_OLED) 105 | 106 | // Got some of old Arduinode revisions and prototype boards 107 | // so I need specifc setup to define board type to adjust the pin 108 | // mapping depending on the board used during my tests 109 | // Early ULPNode board (I use on this one but it's not mandatory) 110 | // See https://github.com/hallard/ULPNode/tree/master/hardware/ArduiNode 111 | // for schematics of this little test board 112 | // Don't worry, it works on any board, it's just my specific settings 113 | #ifdef ARDUINO_ARDUINODE_V13 114 | #define RF_IRQ 2 115 | #define SW_IRQ 3 116 | #define LED_BLU 4 117 | #define LED_GRN 5 118 | #define LED_RED 6 119 | #define OLED_POWER_PIN 7 120 | #define RF_CE 8 121 | #define RF_POWER_PIN 9 122 | #define RF_SS 10 123 | #define VBATT A1 124 | #define SENSOR_POWER_PIN A2 125 | #define SENSOR_DHT_DQ A3 126 | #define SENSOR_NTC A6 127 | #define SENSOR_LIGHT A7 128 | #define rfPWR_ON() digitalWrite(RF_POWER_PIN, LOW) 129 | #define rfPWR_OFF() digitalWrite(RF_POWER_PIN, HIGH) 130 | #define sensorPWR_ON() digitalWrite(SENSOR_POWER_PIN, HIGH) 131 | #define sensorPWR_OFF() digitalWrite(SENSOR_POWER_PIN, LOW) 132 | #define oledPWR_ON() digitalWrite(OLED_POWER_PIN, LOW) 133 | #define oledPWR_OFF() digitalWrite(OLED_POWER_PIN, HIGH) 134 | 135 | // turn the LED on (Arduino pin = 1 = Led ON because of hardware, change if needed) 136 | // 137 | // R LED 138 | // GND +----===----|<|----- Aruino Pin 139 | // 140 | #define ledON(x) digitalWrite(x, HIGH) 141 | #define ledOFF(x) digitalWrite(x, LOW) 142 | #endif 143 | 144 | // see MAX31865 datasheet page 20/21 145 | // Table 9. Temperature Example for PT100 with 400Ω RREF 146 | // to set Min Max temps (value) 147 | #define FAULT_HIGH_THRESHOLD 0x9304 /* +350C */ 148 | #define FAULT_LOW_THRESHOLD 0x2690 /* -100C */ 149 | //#define FAULT_HIGH_THRESHOLD 0xBE64 /* +550C */ 150 | //#define FAULT_LOW_THRESHOLD 0x0BDA /* -200C */ 151 | 152 | #ifdef PT1000 153 | // For PT 1000 (Ref on breakout board = 3900 Ohms 0.1%) 154 | MAX31865_RTD rtd( MAX31865_RTD::RTD_PT1000, RTD_CS_PIN, 3900 ); 155 | #endif 156 | 157 | #ifdef PT100 158 | // For PT 100 (Ref Ref on breakout board = 390 Ohms 0.1%) 159 | MAX31865_RTD rtd( MAX31865_RTD::RTD_PT100, RTD_CS_PIN, 390 ); 160 | #endif 161 | 162 | // Error message associated to status 163 | uint8_t status; 164 | String status_text; 165 | char buffer[32]; // Temp buffer for formating string/display text 166 | // MAX31865 device status seen on SPI bus or not 167 | uint8_t max31865_state = MAX31865_STATE_NOT_FOUND; 168 | 169 | /* ====================================================================== 170 | Function: status2text 171 | Purpose : convert status to human readable text 172 | Input : status register of MAX31865 173 | Output : pointer to error string 174 | Comments: - 175 | ====================================================================== */ 176 | String status2text(uint8_t status) 177 | { 178 | // Default 179 | status_text = ""; 180 | 181 | if( status == 0 ) 182 | status_text += F("OK!"); 183 | else { 184 | if( status & MAX31865_FAULT_HIGH_THRESHOLD ) 185 | status_text += F("RTD high thre. exceeded "); 186 | if( status & MAX31865_FAULT_LOW_THRESHOLD ) 187 | status_text += F("RTD low thres. exceeded "); 188 | if( status & MAX31865_FAULT_REFIN ) 189 | status_text += F("REFIN- > 0.85x V_BIAS "); 190 | if( status & MAX31865_FAULT_REFIN_FORCE ) 191 | status_text += F("REFIN- < 0.85x V_BIAS F- Open "); 192 | if( status & MAX31865_FAULT_RTDIN_FORCE ) 193 | status_text += F("RTDIN- < 0.85x V_BIAS F- Open "); 194 | if( status & MAX31865_FAULT_VOLTAGE ) 195 | status_text += F("Overvoltage / undervoltage "); 196 | } 197 | 198 | return (status_text); 199 | } 200 | 201 | /* ====================================================================== 202 | Function: setup 203 | Purpose : init arduino stuff 204 | Input : - 205 | Output : - 206 | Comments: - 207 | ====================================================================== */ 208 | void setup() 209 | { 210 | #ifdef ARDUINO_ARDUINODE_V13 211 | // Set clock to 16MHZ 212 | clock_prescale_set(clock_div_1); 213 | #endif 214 | 215 | // Init Serial Port 216 | Serial.begin( 115200 ); 217 | 218 | Serial.println(F("====================")); 219 | Serial.println(F(__FILE__)); 220 | Serial.println(F(__DATE__ " " __TIME__ "\r\n")); 221 | 222 | /* Initialize SPI communication. */ 223 | // device can go up to 5MHz, set it to 4MHz 224 | SPI.begin(); 225 | SPI.setClockDivider( SPI_CLOCK_DIV4 ); 226 | SPI.setDataMode( SPI_MODE1 ); 227 | 228 | // Ports Initialization 229 | // ==================== 230 | // Led as output 231 | #ifdef ARDUINO_ARDUINODE_V13 232 | pinMode(LED_GRN, OUTPUT); 233 | pinMode(LED_BLU, OUTPUT); 234 | ledOFF(LED_GRN); 235 | ledOFF(LED_BLU); 236 | ledOFF(LED_RED); 237 | 238 | // Power pin that control module (On/Off) 239 | pinMode(RF_POWER_PIN, OUTPUT); 240 | pinMode(SENSOR_POWER_PIN, OUTPUT); 241 | pinMode(OLED_POWER_PIN, OUTPUT); 242 | 243 | // Power them all 244 | rfPWR_ON(); 245 | sensorPWR_ON(); 246 | oledPWR_ON(); 247 | #endif 248 | 249 | pinMode(10, OUTPUT); // SPI SS (avoid becoming SPI Slave) 250 | #ifdef LED_MAX31865 251 | pinMode(LED_MAX31865, OUTPUT); // RFM breakout board LED 252 | // small blink 253 | digitalWrite(LED_MAX31865, 0); 254 | delay(50); 255 | digitalWrite(LED_MAX31865, 1); 256 | 257 | #endif 258 | 259 | #ifdef DRDY_MAX31865 260 | pinMode(DRDY_MAX31865, INPUT_PULLUP); // RFM breakout board DRDY 261 | #endif 262 | 263 | #ifdef ARDUINO_ARDUINODE_V13 264 | // Small light to indicate we're all fine 265 | ledON(LED_GRN); 266 | delay(25); 267 | ledOFF(LED_GRN); 268 | ledON(LED_RED); 269 | delay(25); 270 | ledOFF(LED_RED); 271 | ledON(LED_BLU); 272 | delay(25); 273 | ledOFF(LED_BLU); 274 | #endif 275 | 276 | // Allow display reading and MAX31865 to warm up 277 | delay( 1000 ); 278 | } 279 | 280 | /* ====================================================================== 281 | Function: loop 282 | Purpose : main Arduino loop 283 | Input : - 284 | Output : - 285 | Comments: read temperature and display on serial and OLED 286 | ====================================================================== */ 287 | void loop() 288 | { 289 | static unsigned long lastRefreshed = 0; 290 | uint8_t status; 291 | 292 | // Do measure every MEASURE_INTERVAL (in ms) ? 293 | if( millis()-lastRefreshed >= MEASURE_INTERVAL) 294 | { 295 | // reset our last measure 296 | lastRefreshed += MEASURE_INTERVAL; 297 | 298 | // default not found 299 | max31865_state = MAX31865_STATE_NOT_FOUND; 300 | 301 | Serial.print( millis()/1000); 302 | Serial.print(F("\tChecking MAX31865 SPI chip...")); 303 | 304 | // Indicate onboard MAX31865 we do a measure 305 | #ifdef LED_MAX31865 306 | digitalWrite(LED_MAX31865, 0); 307 | #endif 308 | 309 | /* Reconfigure this allow us to plug/unplug the module and check PT100/PT1000 310 | V_BIAS enabled 311 | No Auto-conversion 312 | 1-shot disabled 313 | 3-wire 314 | Fault detection: we need to manual mode, set manual 1 => First stage 315 | because on MAX31865 beakout board, RC constant is > 100us 316 | see MAX31865 datasheet page 14 / Section Fault Detection Cycle (D3:D2) 317 | Fault status: auto-clear 318 | 50 Hz filter 319 | Low threshold: FAULT_LOW_THRESHOLD 320 | High threshold: FAULT_HIGH_THRESHOLD 321 | */ 322 | 323 | // 1st do full configuration, enable vbias and wait 5*RC constant 324 | // see MAX31865 datasheet page 14 / Section Fault Detection Cycle (D3:D2) 325 | rtd.configure( true, false, false, USE_3WIRES, MAX31865_FAULT_DETECTION_NONE, 326 | true, true, FAULT_LOW_THRESHOLD, FAULT_HIGH_THRESHOLD ); 327 | //delay(60); 328 | 329 | // We will read back thresold, to check it's same we wrote 330 | rtd.read_all( ); 331 | 332 | // Spi read 0xffff or 0x0000, mainly no com with device 333 | if ( ( rtd.low_threshold()== 0x0 || rtd.low_threshold() == 0xffff ) && 334 | ( rtd.high_threshold()== 0x0 || rtd.high_threshold()== 0xffff ) ) 335 | { 336 | #ifdef ARDUINO_ARDUINODE_V13 337 | ledOFF(LED_BLU); 338 | #endif 339 | max31865_state = MAX31865_STATE_NOT_FOUND; 340 | Serial.println(F("No communication, is breakout board plugged ?")); 341 | 342 | // Blue LED off (on = indicate MAX31865 seen and talk) 343 | } 344 | // we found something, but not what we wrote on threshold registers, bad com!!! 345 | else if ( (rtd.low_threshold()!= FAULT_LOW_THRESHOLD) || (rtd.high_threshold()!=FAULT_HIGH_THRESHOLD)) 346 | { 347 | // Blue LED off (on = indicate MAX31865 seen and talk) 348 | #ifdef ARDUINO_ARDUINODE_V13 349 | ledOFF(LED_BLU); 350 | #endif 351 | max31865_state = MAX31865_STATE_TRANSMIT_ERROR; 352 | Serial.println(F("SPI transmission error, verify wiring!")); 353 | Serial.print(F("\t Set low threshold to 0x")); 354 | Serial.print( FAULT_LOW_THRESHOLD,HEX); 355 | Serial.print(F( " just read 0x")); 356 | Serial.println( rtd.low_threshold(),HEX); 357 | Serial.print(F( "\t Set high threshold to 0x")); 358 | Serial.print( FAULT_HIGH_THRESHOLD,HEX); 359 | Serial.print(F( " just read 0x")); 360 | Serial.println( rtd.high_threshold(),HEX); 361 | } 362 | // ok all seems fine untils there we can talk to device to do action 363 | else 364 | { 365 | // Blue LED indicate MAX31865 seen and talk 366 | #ifdef ARDUINO_ARDUINODE_V13 367 | ledON(LED_BLU); 368 | #endif 369 | 370 | max31865_state = MAX31865_STATE_OK; 371 | Serial.println(F("Found OK!")); 372 | Serial.print(F("\t Checking manual fault detection Stage 1 ")); 373 | 374 | // Stage 1 375 | // Now we're ready to start fault detection (RTD connection) 376 | // V_BIAS enabled , No Auto-conversion, 1-shot disabled, Fault detection Stage 1 377 | rtd.configure( true, false, false, MAX31865_FAULT_DETECTION_MANUAL_1 ); 378 | 379 | // wait some time MAX31865 has finished the test 380 | // no indication in datasheet on how much time it take 381 | // but without this delay value returned is not 0x20 but 0x00 382 | delay(2); 383 | 384 | // After stage 1, fault status should return 0x20 385 | // MAX31865 datasheet page 14 / Section Fault Detection Cycle (D3:D2) 386 | sprintf_P(buffer, PSTR("status=%02X => OK!"), rtd.fault_status() ); 387 | Serial.println(buffer); 388 | Serial.print(F("\t Checking manual fault detection Stage 2 ")); 389 | 390 | // Wait 5 * RC constant before stage 2 391 | // see MAX31865 datasheet page 14 / Section Fault Detection Cycle (D3:D2) 392 | delay(60); 393 | 394 | // Stage 2 395 | // V_BIAS enabled , No Auto-conversion, 1-shot disabled, 396 | rtd.configure( true, false, false, MAX31865_FAULT_DETECTION_MANUAL_2 ); 397 | 398 | // wait some time MAX31865 has finished the test 399 | // no indication in datasheet on how much time it take 400 | // but without this delay value returned may be inconsistent 401 | delay(2); 402 | 403 | // ok what device is saying about Fault Detection ? 404 | status = rtd.fault_status(); 405 | 406 | sprintf_P(buffer, PSTR("status=%02X => "), status ); 407 | Serial.print(buffer); 408 | 409 | status2text(status); 410 | Serial.println(status_text); 411 | 412 | // Ok all wnet fine ? we'll do a measure 413 | if (status==0 ) 414 | { 415 | max31865_state = MAX31865_STATE_OK; 416 | 417 | Serial.print(F("\t Starting conversion...")); 418 | 419 | // Start 1 shot measure 420 | // V_BIAS enabled , No Auto-conversion, 1-shot enabled, No Fault detection 421 | rtd.configure( true, false, true, MAX31865_FAULT_DETECTION_NONE ); 422 | 423 | // onboard MAX31865 will push DRDY line low when measure's done 424 | #ifdef DRDY_MAX31865 425 | // Time out start 426 | unsigned long timeout = millis(); 427 | 428 | // wait chip says finished or timeout (datasheet says max 66ms) 429 | while ( digitalRead(DRDY_MAX31865)==1 && millis()-timeout < 70); 430 | 431 | if ( millis()-timeout>=70) 432 | // Display conversion time 433 | Serial.print(F("(timed-out ")); 434 | else 435 | // Display conversion time 436 | Serial.print(F("(in ")); 437 | 438 | Serial.print(millis()-timeout,DEC); 439 | Serial.print(F("ms) ")); 440 | #else 441 | // 50 Hz max conversion time in one shot 442 | delay(70); 443 | #endif 444 | 445 | // Read MAX31865 all registers values 446 | status = rtd.read_all(); 447 | 448 | sprintf_P(buffer, PSTR("Status:%02X "), status ); 449 | Serial.println(buffer); 450 | 451 | Serial.print(F( "\t RTD:")); 452 | Serial.print( rtd.raw_resistance()); 453 | 454 | // display temperature reading on serial 455 | double temperature = rtd.temperature(); 456 | Serial.print(F( " Ohms => Temp:")); 457 | Serial.print( temperature,1); 458 | Serial.println(F(" C" )); 459 | } 460 | 461 | // disable V_BIAS and one shot to reduce power 462 | rtd.configure( false, false, false, MAX31865_FAULT_DETECTION_NONE); 463 | 464 | } // device seen 465 | 466 | // All is good ? 467 | if( max31865_state==MAX31865_STATE_OK && status==0 && rtd.raw_resistance()!=0 ) 468 | { 469 | // We displayed all, add what you want there 470 | } 471 | 472 | #ifdef LED_MAX31865 473 | // measure done 474 | digitalWrite(LED_MAX31865, 1); 475 | #endif 476 | 477 | Serial.println(F("\tDone!\r\n")); 478 | } 479 | 480 | // Manage blink led (Red error, Green OK) 481 | #ifdef ARDUINO_ARDUINODE_V13 482 | uint8_t led ; 483 | led = status==0?LED_GRN:LED_RED; 484 | if (millis() % 200 < 50 ) 485 | ledON(led); 486 | else 487 | ledOFF(led); 488 | #endif 489 | } 490 | 491 | -------------------------------------------------------------------------------- /Examples/Read_Temperature/Read_Temperature.ino: -------------------------------------------------------------------------------- 1 | /************************************************************************** 2 | * MAX31865 Basic Example 3 | * 4 | * Copyright (C) 2015 Ole Wolf 5 | * 6 | * 7 | * Example code that reads the temperature from an MAX31865 and outputs 8 | * it on the serial line. 9 | * 10 | * Wire the circuit as follows, assuming that level converters have been 11 | * added for the 3.3V signals: 12 | * 13 | * Arduino Uno --> MAX31865 14 | * --------------------------- 15 | * CS: pin 10 --> CS 16 | * MOSI: pin 11 --> SDI (must not be changed for hardware SPI) 17 | * MISO: pin 12 --> SDO (must not be changed for hardware SPI) 18 | * SCK: pin 13 --> SCLK (must not be changed for hardware SPI) 19 | * 20 | * 21 | * This program is free software: you can redistribute it and/or modify 22 | * it under the terms of the GNU General Public License as published by 23 | * the Free Software Foundation, either version 3 of the License, or 24 | * (at your option) any later version. 25 | * 26 | * This program is distributed in the hope that it will be useful, 27 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 28 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 29 | * GNU General Public License for more details. 30 | * 31 | * You should have received a copy of the GNU General Public License 32 | * along with this program. If not, see . 33 | **************************************************************************/ 34 | 35 | #include 36 | #include 37 | 38 | 39 | #define RTD_CS_PIN 10 40 | 41 | 42 | MAX31865_RTD rtd( MAX31865_RTD::RTD_PT100, RTD_CS_PIN ); 43 | 44 | 45 | void setup() 46 | { 47 | Serial.begin( 115200 ); 48 | 49 | /* Initialize SPI communication. */ 50 | SPI.begin( ); 51 | SPI.setClockDivider( SPI_CLOCK_DIV16 ); 52 | SPI.setDataMode( SPI_MODE3 ); 53 | 54 | /* Allow the MAX31865 to warm up. */ 55 | delay( 100 ); 56 | 57 | /* Configure: 58 | 59 | V_BIAS enabled 60 | Auto-conversion 61 | 1-shot disabled 62 | 3-wire enabled 63 | Fault detection: automatic delay 64 | Fault status: auto-clear 65 | 50 Hz filter 66 | Low threshold: 0x0000 67 | High threshold: 0x7fff 68 | */ 69 | rtd.configure( true, true, false, true, MAX31865_FAULT_DETECTION_NONE, 70 | true, true, 0x0000, 0x7fff ); 71 | } 72 | 73 | 74 | 75 | void loop() 76 | { 77 | rtd.read_all( ); 78 | 79 | if( rtd.status( ) == 0 ) 80 | { 81 | double temperature = rtd.temperature( ); 82 | Serial.print( " T = "); 83 | Serial.print( temperature, 1 ); 84 | Serial.println(" deg C" ); 85 | } 86 | else 87 | { 88 | Serial.print( "RTD fault register: " ); 89 | Serial.print( rtd.status( ) ); 90 | Serial.print( ": " ); 91 | if( rtd.status( ) & MAX31865_FAULT_HIGH_THRESHOLD ) 92 | { 93 | Serial.println( "RTD high threshold exceeded" ); 94 | } 95 | else if( rtd.status( ) & MAX31865_FAULT_LOW_THRESHOLD ) 96 | { 97 | Serial.println( "RTD low threshold exceeded" ); 98 | } 99 | else if( rtd.status( ) & MAX31865_FAULT_REFIN ) 100 | { 101 | Serial.println( "REFIN- > 0.85 x V_BIAS" ); 102 | } 103 | else if( rtd.status( ) & MAX31865_FAULT_REFIN_FORCE ) 104 | { 105 | Serial.println( "REFIN- < 0.85 x V_BIAS, FORCE- open" ); 106 | } 107 | else if( rtd.status( ) & MAX31865_FAULT_RTDIN_FORCE ) 108 | { 109 | Serial.println( "RTDIN- < 0.85 x V_BIAS, FORCE- open" ); 110 | } 111 | else if( rtd.status( ) & MAX31865_FAULT_VOLTAGE ) 112 | { 113 | Serial.println( "Overvoltage/undervoltage fault"); 114 | } 115 | else 116 | { 117 | Serial.println( "Unknown fault; check connection" ); 118 | } 119 | } 120 | 121 | delay( 3000 ); 122 | } 123 | 124 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | -------------------------------------------------------------------------------- /MAX31865.cpp: -------------------------------------------------------------------------------- 1 | /************************************************************************** 2 | * Arduino driver library for the MAX31865. 3 | * 4 | * Copyright (C) 2015 Ole Wolf 5 | * 6 | * 7 | * Wire the circuit as follows, assuming that level converters have been 8 | * added for the 3.3V signals: 9 | * 10 | * Arduino Uno --> MAX31865 11 | * ------------------------------------ 12 | * CS: any available pin --> CS 13 | * MOSI: pin 11 --> SDI (mandatory for hardware SPI) 14 | * MISO: pin 12 --> SDO (mandatory for hardware SPI) 15 | * SCK: pin 13 --> SCLK (mandatory for hardware SPI) 16 | * 17 | * 18 | * This program is free software: you can redistribute it and/or modify 19 | * it under the terms of the GNU General Public License as published by 20 | * the Free Software Foundation, either version 3 of the License, or 21 | * (at your option) any later version. 22 | * 23 | * This program is distributed in the hope that it will be useful, 24 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 25 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 26 | * GNU General Public License for more details. 27 | * 28 | * You should have received a copy of the GNU General Public License 29 | * along with this program. If not, see . 30 | **************************************************************************/ 31 | 32 | #include 33 | #include 34 | #include 35 | 36 | /** 37 | * The constructor for the MAX31865_RTD class registers the CS pin and 38 | * configures it as an output. 39 | * 40 | * @param [in] type type of RTD . 41 | * @param [in] cs_pin Arduino pin selected for the CS signal. 42 | * @param [in] rtd_rref reference resistor value. if omitted will be setup to default 43 | 400 for PT100 and 4000 for PT1000 44 | */ 45 | MAX31865_RTD::MAX31865_RTD( ptd_type type, uint8_t cs_pin, uint16_t rtd_rref ) 46 | { 47 | /* Set the type of PTD. */ 48 | this->type = type; 49 | 50 | /* CS pin for the SPI device. */ 51 | this->cs_pin = cs_pin; 52 | pinMode( this->cs_pin, OUTPUT ); 53 | 54 | /* Pull the CS pin high to avoid conflicts on SPI bus. */ 55 | digitalWrite( this->cs_pin, HIGH ); 56 | 57 | // reference resistor value set ? 58 | if (rtd_rref) 59 | this->configuration_rtd_rref = rtd_rref; 60 | else 61 | this->configuration_rtd_rref = type == RTD_PT100 ? RTD_RREF_PT100 : RTD_RREF_PT1000; 62 | } 63 | 64 | /** 65 | * Configure the MAX31865. The parameters correspond to Table 2 in the MAX31865 66 | * datasheet. The parameters are combined into a control bit-field that is stored 67 | * internally in the class for later reconfiguration, as are the fault threshold values. 68 | * 69 | * @param [in] v_bias Vbias enabled (@a true) or disabled (@a false). 70 | * @param [in] conversion_mode Conversion mode auto (@a true) or off (@a false). 71 | * @param [in] one_shot 1-shot measurement enabled (@a true) or disabled (@a false). 72 | * @param [in] three_wire 3-wire enabled (@a true) or 2-wire/4-wire (@a false). 73 | * @param [in] fault_detection Fault detection cycle control (see Table 3 in the MAX31865 74 | * datasheet). 75 | * @param [in] fault_clear Fault status auto-clear (@a true) or manual clear (@a false). 76 | * @param [in] filter_50hz 50 Hz filter enabled (@a true) or 60 Hz filter enabled 77 | * (@a false). 78 | * @param [in] low_threshold Low fault threshold. 79 | * @param [in] high_threshold High fault threshold. 80 | */ 81 | void MAX31865_RTD::configure( bool v_bias, bool conversion_mode, bool one_shot, 82 | bool three_wire, uint8_t fault_cycle, bool fault_clear, 83 | bool filter_50hz, uint16_t low_threshold, 84 | uint16_t high_threshold ) 85 | { 86 | uint8_t control_bits = 0; 87 | 88 | /* Assemble the control bit mask. */ 89 | control_bits |= ( v_bias ? 0x80 : 0 ); 90 | control_bits |= ( conversion_mode ? 0x40 : 0 ); 91 | control_bits |= ( one_shot ? 0x20 : 0 ); 92 | control_bits |= ( three_wire ? 0x10 : 0 ); 93 | control_bits |= fault_cycle & 0b00001100; 94 | control_bits |= ( fault_clear ? 0x02 : 0 ); 95 | control_bits |= ( filter_50hz ? 0x01 : 0 ); 96 | 97 | /* Store the control bits and the fault threshold limits for reconfiguration 98 | purposes. */ 99 | this->configuration_control_bits = control_bits; 100 | this->configuration_low_threshold = low_threshold; 101 | this->configuration_high_threshold = high_threshold; 102 | 103 | /* Perform an full reconfiguration */ 104 | reconfigure( true ); 105 | } 106 | 107 | /** 108 | * ReConfigure the MAX31865. The parameters correspond to Table 2 in the MAX31865 109 | * datasheet. The parameters use other control bit-field that is stored internally 110 | * in the class and change only new values 111 | * 112 | * @param [in] v_bias Vbias enabled (@a true) or disabled (@a false). 113 | * @param [in] conversion_mode Conversion mode auto (@a true) or off (@a false). 114 | * @param [in] one_shot 1-shot measurement enabled (@a true) or disabled (@a false). 115 | * @param [in] fault_detection Fault detection cycle control (see Table 3 in the MAX31865 116 | * datasheet). 117 | */ 118 | void MAX31865_RTD::configure( bool v_bias, bool conversion_mode, bool one_shot, uint8_t fault_cycle ) 119 | { 120 | /* Use the stored the control bits, and set new ones only */ 121 | this->configuration_control_bits &= ~ (0x80 | 0x40 | 0x20 | 0b00001100); 122 | 123 | this->configuration_control_bits |= ( v_bias ? 0x80 : 0 ); 124 | this->configuration_control_bits |= ( conversion_mode ? 0x40 : 0 ); 125 | this->configuration_control_bits |= ( one_shot ? 0x20 : 0 ); 126 | this->configuration_control_bits |= fault_cycle & 0b00001100; 127 | 128 | /* Perform light configuration */ 129 | reconfigure( false ); 130 | } 131 | 132 | /** 133 | * Reconfigure the MAX31865 by writing the stored control bits and the stored fault 134 | * threshold values back to the chip. 135 | * 136 | * @param [in] full true to send also threshold configuration 137 | */ 138 | void MAX31865_RTD::reconfigure( bool full ) 139 | { 140 | /* Write the threshold values. */ 141 | if (full) 142 | { 143 | uint16_t threshold ; 144 | 145 | digitalWrite( this->cs_pin, LOW ); 146 | SPI.transfer( 0x83 ); 147 | threshold = this->configuration_high_threshold ; 148 | SPI.transfer( ( threshold >> 8 ) & 0x00ff ); 149 | SPI.transfer( threshold & 0x00ff ); 150 | threshold = this->configuration_low_threshold ; 151 | SPI.transfer( ( threshold >> 8 ) & 0x00ff ); 152 | SPI.transfer( threshold & 0x00ff ); 153 | digitalWrite( this->cs_pin, HIGH ); 154 | } 155 | 156 | /* Write the configuration to the MAX31865. */ 157 | digitalWrite( this->cs_pin, LOW ); 158 | SPI.transfer( 0x80 ); 159 | SPI.transfer( this->configuration_control_bits ); 160 | digitalWrite( this->cs_pin, HIGH ); 161 | } 162 | 163 | /** 164 | * Apply the Callendar-Van Dusen equation to convert the RTD resistance 165 | * to temperature: 166 | * 167 | * \f[ 168 | * t=\frac{-A\pm \sqrt{A^2-4B\left(1-\frac{R_t}{R_0}\right)}}{2B} 169 | * \f], 170 | * 171 | * where 172 | * 173 | * \f$A\f$ and \f$B\f$ are the RTD coefficients, \f$R_t\f$ is the current 174 | * resistance of the RTD, and \f$R_0\f$ is the resistance of the RTD at 0 175 | * degrees Celcius. 176 | * 177 | * For more information on measuring with an RTD, see: 178 | * . 179 | * 180 | * @param [in] resistance The measured RTD resistance. 181 | * @return Temperature in degrees Celcius. 182 | */ 183 | double MAX31865_RTD::temperature() const 184 | { 185 | static const double a2 = 2.0 * RTD_B; 186 | static const double b_sq = RTD_A * RTD_A; 187 | 188 | const double rtd_resistance = 189 | ( this->type == RTD_PT100 ) ? RTD_RESISTANCE_PT100 : RTD_RESISTANCE_PT1000; 190 | 191 | double c = 1.0 - resistance( ) / rtd_resistance; 192 | double D = b_sq - 2.0 * a2 * c; 193 | double temperature_deg_C = ( -RTD_A + sqrt( D ) ) / a2; 194 | 195 | return( temperature_deg_C ); 196 | } 197 | 198 | /** 199 | * Read all settings and measurements from the MAX31865 and store them 200 | * internally in the class. 201 | * 202 | * @return Fault status byte 203 | */ 204 | uint8_t MAX31865_RTD::read_all() 205 | { 206 | uint16_t combined_bytes; 207 | 208 | /* Start the read operation. */ 209 | digitalWrite( this->cs_pin, LOW ); 210 | /* Tell the MAX31865 that we want to read, starting at register 0. */ 211 | SPI.transfer( 0x00 ); 212 | 213 | /* Read the MAX31865 registers in the following order: 214 | Configuration 215 | RTD 216 | High Fault Threshold 217 | Low Fault Threshold 218 | Fault Status */ 219 | 220 | this->measured_configuration = SPI.transfer( 0x00 ); 221 | 222 | combined_bytes = SPI.transfer( 0x00 ) << 8; 223 | combined_bytes |= SPI.transfer( 0x00 ); 224 | this->measured_resistance = combined_bytes >> 1; 225 | 226 | combined_bytes = SPI.transfer( 0x00 ) << 8; 227 | combined_bytes |= SPI.transfer( 0x00 ); 228 | this->measured_high_threshold = combined_bytes ; 229 | 230 | combined_bytes = SPI.transfer( 0x00 ) << 8; 231 | combined_bytes |= SPI.transfer( 0x00 ); 232 | this->measured_low_threshold = combined_bytes ; 233 | 234 | this->measured_status = SPI.transfer( 0x00 ); 235 | 236 | digitalWrite( this->cs_pin, HIGH ); 237 | 238 | /* Reset the configuration if the measured resistance is 239 | zero or a fault occurred. */ 240 | if( this->measured_resistance == 0 || this->measured_status != 0 ) 241 | reconfigure( true ); 242 | 243 | return( status() ); 244 | } 245 | 246 | /** 247 | * Read fault status 248 | * internally in the class. 249 | * 250 | * @return Fault status byte 251 | */ 252 | uint8_t MAX31865_RTD::fault_status() 253 | { 254 | uint8_t fault_status ; 255 | 256 | /* Start the read operation. */ 257 | digitalWrite( this->cs_pin, LOW ); 258 | /* Tell the MAX31865 that we want to read, starting at register 7. */ 259 | SPI.transfer( 0x07 ); 260 | fault_status = this->measured_status = SPI.transfer( 0x00 ); 261 | digitalWrite( this->cs_pin, HIGH ); 262 | return( fault_status ); 263 | } 264 | 265 | /** 266 | * Read configuration register 267 | * internally in the class. 268 | * 269 | * @return config register byte 270 | */ 271 | uint8_t MAX31865_RTD::config_register() 272 | { 273 | uint8_t config_register ; 274 | 275 | /* Start the read operation. */ 276 | digitalWrite( this->cs_pin, LOW ); 277 | /* Tell the MAX31865 that we want to read, starting at register 0. */ 278 | SPI.transfer( 0x00 ); 279 | config_register = this->measured_status = SPI.transfer( 0x00 ); 280 | digitalWrite( this->cs_pin, HIGH ); 281 | return( config_register ); 282 | } 283 | 284 | 285 | 286 | 287 | -------------------------------------------------------------------------------- /MAX31865.h: -------------------------------------------------------------------------------- 1 | /************************************************************************** 2 | * Arduino driver library for the MAX31865. 3 | * 4 | * Copyright (C) 2015 Ole Wolf 5 | * 6 | * 7 | * Wire the circuit as follows, assuming that level converters have been 8 | * added for the 3.3V signals: 9 | * 10 | * Arduino Uno --> MAX31865 11 | * ------------------------------------ 12 | * CS: any available pin --> CS 13 | * MOSI: pin 11 --> SDI (mandatory for hardware SPI) 14 | * MISO: pin 12 --> SDO (mandatory for hardware SPI) 15 | * SCK: pin 13 --> SCLK (mandatory for hardware SPI) 16 | * 17 | * 18 | * This program is free software: you can redistribute it and/or modify 19 | * it under the terms of the GNU General Public License as published by 20 | * the Free Software Foundation, either version 3 of the License, or 21 | * (at your option) any later version. 22 | * 23 | * This program is distributed in the hope that it will be useful, 24 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 25 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 26 | * GNU General Public License for more details. 27 | * 28 | * You should have received a copy of the GNU General Public License 29 | * along with this program. If not, see . 30 | **************************************************************************/ 31 | 32 | 33 | #ifndef _MAX31865_H 34 | #define _MAX31865_H 35 | 36 | #include 37 | 38 | 39 | #define MAX31865_FAULT_HIGH_THRESHOLD ( 1 << 7 ) 40 | #define MAX31865_FAULT_LOW_THRESHOLD ( 1 << 6 ) 41 | #define MAX31865_FAULT_REFIN ( 1 << 5 ) 42 | #define MAX31865_FAULT_REFIN_FORCE ( 1 << 4 ) 43 | #define MAX31865_FAULT_RTDIN_FORCE ( 1 << 3 ) 44 | #define MAX31865_FAULT_VOLTAGE ( 1 << 2 ) 45 | 46 | #define MAX31865_FAULT_DETECTION_NONE ( 0x00 << 2 ) 47 | #define MAX31865_FAULT_DETECTION_AUTO ( 0x01 << 2 ) 48 | #define MAX31865_FAULT_DETECTION_MANUAL_1 ( 0x02 << 2 ) 49 | #define MAX31865_FAULT_DETECTION_MANUAL_2 ( 0x03 << 2 ) 50 | 51 | 52 | 53 | /* RTD data, RTD current, and measurement reference 54 | voltage. The ITS-90 standard is used; other RTDs 55 | may have coefficients defined by the DIN 43760 or 56 | the U.S. Industrial (American) standard. */ 57 | #define RTD_A_ITS90 3.9080e-3 58 | #define RTD_A_USINDUSTRIAL 3.9692e-3 59 | #define RTD_A_DIN43760 3.9848e-3 60 | #define RTD_B_ITS90 -5.870e-7 61 | #define RTD_B_USINDUSTRIAL -5.8495e-7 62 | #define RTD_B_DIN43760 -5.8019e-7 63 | /* RTD coefficient C is required only for temperatures 64 | below 0 deg. C. The selected RTD coefficient set 65 | is specified below. */ 66 | #define SELECT_RTD_HELPER(x) x 67 | #define SELECT_RTD(x) SELECT_RTD_HELPER(x) 68 | #define RTD_A SELECT_RTD(RTD_A_ITS90) 69 | #define RTD_B SELECT_RTD(RTD_B_ITS90) 70 | /* 71 | * The reference resistor on the hardware; see the MAX31865 datasheet 72 | * for details. The values 400 and 4000 Ohm are recommended values for 73 | * the PT100 and PT1000. 74 | */ 75 | #define RTD_RREF_PT100 400 /* Ohm */ 76 | #define RTD_RREF_PT1000 4000 /* Ohm */ 77 | 78 | /* 79 | * The RTD resistance at 0 degrees Celcius. For the PT100, this is 100 Ohm; 80 | * for the PT1000, it is 1000 Ohm. 81 | */ 82 | #define RTD_RESISTANCE_PT100 100 /* Ohm */ 83 | #define RTD_RESISTANCE_PT1000 1000 /* Ohm */ 84 | 85 | #define RTD_ADC_RESOLUTION ( 1u << 15 ) /* 15 bits */ 86 | 87 | 88 | /* See the main (MAX31865.cpp) file for documentation of the class methods. */ 89 | class MAX31865_RTD 90 | { 91 | public: 92 | enum ptd_type { RTD_PT100, RTD_PT1000 }; 93 | 94 | MAX31865_RTD( ptd_type type, uint8_t cs_pin, uint16_t rtd_rref =0 ); 95 | void configure( bool v_bias, bool conversion_mode, bool one_shot, bool three_wire, 96 | uint8_t fault_cycle, bool fault_clear, bool filter_50hz, 97 | uint16_t low_threshold, uint16_t high_threshold ); 98 | void configure( bool v_bias, bool conversion_mode, bool one_shot, uint8_t fault_cycle ); 99 | uint8_t read_all( ); 100 | double temperature( ) const; 101 | uint8_t fault_status( ); 102 | uint8_t config_register( ); 103 | uint8_t status( ) const { return( measured_status ); } 104 | uint16_t low_threshold( ) const { return( measured_low_threshold ); } 105 | uint16_t high_threshold( ) const { return( measured_high_threshold ); } 106 | uint16_t raw_resistance( ) const { return( measured_resistance ); } 107 | double resistance( ) const 108 | { 109 | return( (double)raw_resistance( ) * configuration_rtd_rref / (double)RTD_ADC_RESOLUTION ); 110 | } 111 | ptd_type cfg_type() const { return ( type ); } 112 | uint16_t cfg_rref() const { return ( configuration_rtd_rref ); } 113 | 114 | private: 115 | /* Our configuration. */ 116 | uint8_t cs_pin; 117 | ptd_type type; 118 | uint8_t configuration_control_bits; 119 | uint16_t configuration_low_threshold; 120 | uint16_t configuration_high_threshold; 121 | uint16_t configuration_rtd_rref; 122 | void reconfigure( bool full ); 123 | 124 | /* Values read from the device. */ 125 | uint8_t measured_configuration; 126 | uint16_t measured_resistance; 127 | uint16_t measured_high_threshold; 128 | uint16_t measured_low_threshold; 129 | uint8_t measured_status; 130 | }; 131 | 132 | #endif /* _MAX31865_H */ 133 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | MAX31865 Arduino Library 2 | ======================== 3 | 4 | The files in this folder provide an Arduino driver for the MAX31865 RTD chip and example code that illustrates how to use it. 5 | 6 | Original code was written by olewolf, modified by Charles-Henri Hallard 7 | 8 | Code based on following datasheet http://datasheets.maximintegrated.com/en/ds/MAX31865.pdf 9 | 10 | ##Features 11 | List of features I added from the original library: 12 | 13 | - Added option to set Reference resistor at object instantiation 14 | - Corrected threshold (set/get) not consistent problem 15 | - added soft reconfiguration register with less option (to avoid SPI communication) and not setting again threshold 16 | - added method to get reference resistor value `cfg_ref()` 17 | - added method to get only fault status register `fault_status()` 18 | - added method to get only configuration register `config_register()` 19 | 20 | ###Installation 21 | Copy the content of this folder (zip file) library in your Arduino libraries folder in your sketchbook location, you should have now "your_sketchbook_folder/libraries/max31865" and this folder should contains the .cpp and .h files. 22 |
23 | To find your Arduino sketchbook location folder, in Arduino IDE, go to File>Preferences in the Arduino IDE. 24 |
25 | See [this tutorial][1] on Arduino libraries. 26 |
27 | 28 | ###Sample usage 29 | - [Read_Temperature][3] Basic reading temperature and serial display (original code author) 30 | - [Full_Test_Oled][6] A powerfull testing sketch, the one I use to test my boards, It has full display on I2C OLED 128x64 and on Serial. Each step is detailled, it can see if breakout is connected, communication are good, and MAX31865 breakout board is well configured and see PT100/PT1000. It mainly use all library feature and use MAX31865 in 1-Shot mode. 31 | - [Full_Test_Serial][7] same as above but without OLED display, serial only. 32 | 33 | ##Blog dedicated post 34 | you can find it on my blog [here][5] 35 | 36 | ##Why 37 | - When I created the MAX31865 breakout board, I needed a library to be able to read results. I then found this one which was working file. I just added on it the features I needed, thank to Original library author olewolf. 38 | 39 | ##License 40 | Same as original, 41 | 42 | This program is free software: you can redistribute it and/or modify 43 | it under the terms of the GNU General Public License as published by 44 | the Free Software Foundation, either version 3 of the License, or 45 | (at your option) any later version. 46 | 47 | This program is distributed in the hope that it will be useful, 48 | but WITHOUT ANY WARRANTY; without even the implied warranty of 49 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 50 | GNU General Public License for more details. 51 | 52 | You should have received a copy of the GNU General Public License 53 | along with this program. If not, see . 54 | 55 | ##Misc 56 | See news and other projects on my [blog][4] 57 | 58 | [1]: http://learn.adafruit.com/arduino-tips-tricks-and-techniques/arduino-libraries 59 | [2]: http://www.dsscircuits.com/index.php/articles/66-arduino-i2c-master-library 60 | [3]: https://github.com/hallard/arduino-max31865/blob/master/Examples/Read_Temperature/Read_Temperature.ino 61 | [4]: http://hallard.me 62 | [5]: http://hallard.me/max31865/ 63 | [6]: https://github.com/hallard/arduino-max31865/blob/master/Examples/Full_Test_Oled/Full_Test_Oled.ino 64 | [7]: https://github.com/hallard/arduino-max31865/blob/master/Examples/Full_Test_Serial/Full_Test_Serial.ino 65 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # Syntax Coloring Map For MAX31865 Library 3 | ####################################### 4 | 5 | ####################################### 6 | # Datatypes (KEYWORD1) 7 | ####################################### 8 | 9 | MAX31865_RTD KEYWORD1 10 | 11 | ####################################### 12 | # Methods and Functions (KEYWORD2) 13 | ####################################### 14 | 15 | configure KEYWORD2 16 | read_all KEYWORD2 17 | temperature KEYWORD2 18 | fault_status KEYWORD2 19 | config_register KEYWORD2 20 | status KEYWORD2 21 | low_threshold KEYWORD2 22 | high_threshold KEYWORD2 23 | raw_resistance KEYWORD2 24 | resistance KEYWORD2 25 | cfg_type KEYWORD2 26 | cfg_ref KEYWORD2 27 | 28 | ####################################### 29 | # Constants (LITERAL1) 30 | ####################################### 31 | 32 | MAX31865_FAULT_LOW_THRESHOLD LITERAL1 33 | MAX31865_FAULT_HIGH_THRESHOLD LITERAL1 34 | MAX31865_FAULT_REFIN LITERAL1 35 | MAX31865_FAULT_REFIN_FORCE LITERAL1 36 | MAX31865_FAULT_RTDIN_FORCE LITERAL1 37 | MAX31865_FAULT_VOLTAGE LITERAL1 38 | MAX31865_FAULT_DETECTION_NONE LITERAL1 39 | MAX31865_FAULT_DETECTION_AUTO LITERAL1 40 | MAX31865_FAULT_DETECTION_MANUAL_1 LITERAL1 41 | MAX31865_FAULT_DETECTION_MANUAL_2 LITERAL1 42 | RTD_RREF_PT100 43 | RTD_RREF_PT1000 44 | RTD_RESISTANCE_PT100 45 | RTD_RESISTANCE_PT1000 --------------------------------------------------------------------------------