update readme.md (#6)

- update readme.md
- fix keywords.txt
- minor edits

Author: RobTillaart

CHANGELOG.md

@@ -6,11 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.1.3] - 2023-11-11
+- update readme.md
+- fix keywords.txt
+- minor edits
+
+
 ## [0.1.2] - 2022-11-16
 - add RP2040 in build-CI
 - add changelog.md
 
-
 ## [0.1.1] - 2022-04-20
 - updated documentation after tests with UNO.
 - added examples

MAX6675.cpp

@@ -1,12 +1,10 @@
 //
 //    FILE: MAX6675.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.2
+// VERSION: 0.1.3
 // PURPOSE: Arduino library for MAX6675 chip for K type thermocouple
 //    DATE: 2022-01-11
 //     URL: https://github.com/RobTillaart/MAX6675
-//
-// HISTORY: see changelog.md
 
 
 #include "MAX6675.h"
@@ -106,7 +104,7 @@ uint8_t MAX6675::read()
   //       15    SIGN
   uint16_t value = _read();
 
-  // needs a pull up on MISO pin to work properly!
+  //  needs a pull up on MISO pin to work properly!
   if (value == 0xFFFF)
   {
     _status = STATUS_NO_COMMUNICATION;
@@ -146,7 +144,7 @@ uint32_t MAX6675::_read(void)
   {
     //  split _swSPIdelay in equal dLow and dHigh
     //  dLow should be longer one when _swSPIdelay = odd.
-    uint16_t dHigh = _swSPIdelay/2;
+    uint16_t dHigh = _swSPIdelay / 2;
     uint16_t dLow = _swSPIdelay - dHigh;
     digitalWrite(_select, LOW);
     for (int8_t i = 15; i >= 0; i--)
@@ -165,5 +163,5 @@ uint32_t MAX6675::_read(void)
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

MAX6675.h

@@ -2,7 +2,7 @@
 //
 //    FILE: MAX6675.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.2
+// VERSION: 0.1.3
 // PURPOSE: Arduino library for MAX6675 chip for K type thermocouple
 //    DATE: 2022-01-12
 //     URL: https://github.com/RobTillaart/MAX6675
@@ -23,7 +23,7 @@
 #include "SPI.h"
 
 
-#define MAX6675_LIB_VERSION               (F("0.1.2"))
+#define MAX6675_LIB_VERSION               (F("0.1.3"))
 
 #define MAX6675_NO_TEMPERATURE            -999
 
@@ -109,5 +109,5 @@ class MAX6675
 };
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

README.md

@@ -2,8 +2,11 @@
 [![Arduino CI](https://github.com/RobTillaart/MAX6675/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 [![Arduino-lint](https://github.com/RobTillaart/MAX6675/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/MAX6675/actions/workflows/arduino-lint.yml)
 [![JSON check](https://github.com/RobTillaart/MAX6675/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/MAX6675/actions/workflows/jsoncheck.yml)
+[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/MAX6675.svg)](https://github.com/RobTillaart/MAX6675/issues)
+
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/MAX6675/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/MAX6675.svg?maxAge=3600)](https://github.com/RobTillaart/MAX6675/releases)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/MAX6675.svg)](https://registry.platformio.org/libraries/robtillaart/MAX6675)
 
 
 # MAX6675
@@ -31,7 +34,7 @@ Different TC's have a different Seebeck Coefficient (SC) expressed in µV/°C.
 See http://www.analog.com/library/analogDialogue/archives/44-10/thermocouple.html
 
 
-### Breakout
+#### Breakout
 
 The library is tested with a breakout board with following pins:
 
@@ -45,11 +48,17 @@ The library is tested with a breakout board with following pins:
              +---------------------+
 ```
 
+#### Related
+
+- https://github.com/RobTillaart/MAX6675
+- https://github.com/RobTillaart/MAX31850
+- https://github.com/RobTillaart/MAX31855_RT
+
 
 ## Hardware SPI vs software SPI
 
 
-### Pins
+#### Pins
 
 Default pin connections. ESP32 can overrule with **setGPIOpins()**.
 
@@ -61,7 +70,7 @@ Default pin connections. ESP32 can overrule with **setGPIOpins()**.
  | SELECT   | eg. 4 |    5        |   15        |  *can be others too.*
 
 
-### Performance 
+#### Performance 
 
 Performance read() function, timing in us.  
 - UNO @ 16 MHz
@@ -86,16 +95,19 @@ Tested with **MAX6675_test_HWSPI.ino**
 
 ## Interface
 
+```cpp
+#include "MAX6675.h"
+```
 
-### Constructor
+#### Constructor
 
 - **MAX6675()** create object.
 - **void begin(const uint8_t select)** set select pin => hardware SPI
 - **void begin(const uint8_t sclk, const uint8_t select, const uint8_t miso)** 
 set CLOCK, SELECT and MISO pin => software SPI
 
 
-### Hardware SPI
+#### Hardware SPI
 
 To be used only if one needs a specific speed.
 
@@ -106,7 +118,7 @@ Del is the time in micros added per bit. Even numbers keep the duty cycle of the
 - **uint16_t getSWSPIdelay()** get set value in micros.
 
 
-### ESP32 specific
+#### ESP32 specific
 
 - **void selectHSPI()** must be called before **begin()**
 - **void selectVSPI()** must be called before **begin()**
@@ -115,7 +127,7 @@ Del is the time in micros added per bit. Even numbers keep the duty cycle of the
 - **void setGPIOpins(uint8_t clk, uint8_t miso, uint8_t mosi, uint8_t select)**  to overrule ESP32 default hardware pins.
 
 
-### Reading
+#### Reading
 
 To make a temperature reading call **read()**.
 It returns the status of the read which is a value between 0..7
@@ -141,7 +153,7 @@ the value of **getTemperature()** can become incorrect. So it is important to ch
 the return value of **read()**.
 
 
-### Offset
+#### Offset
 
 The library supports a fixed offset to calibrate the thermocouple.
 For this the functions **float getOffset()** and **void setOffset(float offset)** are available.
@@ -153,7 +165,7 @@ A typical usage is to call **setOffset(273.15)** to get ° Kelvin.
 - the offset can cause negative temperatures.
 
 
-### Delta analysis
+#### Delta analysis
 
 As the **tc** object holds its last known temperature it is easy to determine the delta 
 with the last known temperature, e.g. for trend analysis.
@@ -170,7 +182,7 @@ with the last known temperature, e.g. for trend analysis.
 ```
 
 
-### Last time read
+#### Last time read
 
 The **tc** object keeps track of the last time **read()** is called in the function **uint32_t lastRead()**.
 The time is tracked in **millis()**. This makes it easy to read the sensor at certain intervals.
@@ -192,7 +204,7 @@ if (millis() - tc.lastRead() >= interval)
 ```
 
 
-### GetRawData 
+#### GetRawData 
 
 The function **uint32_t getRawData()** allows you to get all the 32 bits raw data from the board, 
 after the standard **uint8_t tc.read()** call.
@@ -249,7 +261,26 @@ See examples
 
 ## Future
 
+#### Must
+
+#### Should
+
 - update and verify documentation (as it is copied from MAX31855 lib)
 - keep interface in sync with MAX31855 if possible.
-- 
+
+#### Could
+
+- create example to distinguish between MAX6675 and MAX31855
+  - https://github.com/RobTillaart/MAX6675/issues/5
+
+#### Wont
+ 
+
+## Support
+
+If you appreciate my libraries, you can support the development and maintenance.
+Improve the quality of the libraries by providing issues and Pull Requests, or
+donate through PayPal or GitHub sponsors.
+
+Thank you,
 

documents/Capture.PNG

@@ -35,7 +35,9 @@ setGPIOpins	KEYWORD2
 
 
 # Constants (LITERAL1)
-MAX31855_VERSION	LITERAL1
+MAX6675_LIB_VERSION	LITERAL1
+
+MAX6675_NO_TEMPERATURE	LITERAL1
 
 STATUS_OK	LITERAL1
 STATUS_ERROR	LITERAL1

keywords.txt

@@ -15,9 +15,9 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/MAX6675"
   },
-  "version": "0.1.2",
+  "version": "0.1.3",
   "license": "MIT",
-  "frameworks": "arduino",
+  "frameworks": "*",
   "platforms": "*",
   "headers": "MAX6675.h"
 }

library.json

@@ -1,5 +1,5 @@
 name=MAX6675
-version=0.1.2
+version=0.1.3
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library for MAX6675 chip for K type thermocouple.