update readme.md

RobTillaart · Oct 25, 2023 · 17b02b6 · 17b02b6
1 parent e1eee42
commit 17b02b6
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 11 deletions.
diff --git a/DHTStable.h b/DHTStable.h
@@ -43,15 +43,15 @@ class DHTStable
   int read11(uint8_t pin);      //  DHT11 & DHT12
   int read(uint8_t pin);        //  DHT22
 
-  inline int read12(uint8_t pin)   { return read11(pin); }; // ok
-  inline int read21(uint8_t pin)   { return read(pin); };   // ok
-  inline int read22(uint8_t pin)   { return read(pin); };   // ok
-  inline int read33(uint8_t pin)   { return read(pin); };   // ok
-  inline int read44(uint8_t pin)   { return read(pin); };   // ok
-  inline int read2301(uint8_t pin) { return read(pin); };   // ok
-  inline int read2302(uint8_t pin) { return read(pin); };   // ok
-  inline int read2320(uint8_t pin) { return read(pin); };   // ok
-  inline int read2322(uint8_t pin) { return read(pin); };   // ok
+  inline int read12(uint8_t pin)   { return read11(pin); };  //  ok
+  inline int read21(uint8_t pin)   { return read(pin); };    //  ok
+  inline int read22(uint8_t pin)   { return read(pin); };    //  ok
+  inline int read33(uint8_t pin)   { return read(pin); };    //  ok
+  inline int read44(uint8_t pin)   { return read(pin); };    //  ok
+  inline int read2301(uint8_t pin) { return read(pin); };    //  ok
+  inline int read2302(uint8_t pin) { return read(pin); };    //  ok
+  inline int read2320(uint8_t pin) { return read(pin); };    //  ok
+  inline int read2322(uint8_t pin) { return read(pin); };    //  ok
 
   //  read values from cache, call read() to refresh!
   float getHumidity()    { return _humidity; };

diff --git a/README.md b/README.md
@@ -46,9 +46,41 @@ It is advised to upgrade to the DHTNEW library if one needs the new functionalit
 #include "DHTStable.h"
 ```
 
-See DHTStable.h file
 
-TODO
+
+#### Constructor
+
+- **dht()** Constructor
+
+
+#### Read functions per type
+
+- **int read11(uint8_t pin)**
+- **int read(uint8_t pin)**
+
+
+- **int read12(uint8_t pin)**
+- **int read21(uint8_t pin)**
+- **int read22(uint8_t pin)**
+- **int read33(uint8_t pin)**
+- **int read44(uint8_t pin)**
+- **int read2301(uint8_t pin)**
+- **int read2302(uint8_t pin)**
+- **int read2303(uint8_t pin)**
+- **int read2320(uint8_t pin)**
+- **int read2322(uint8_t pin)**
+
+
+- **float getHumidity()**
+- **float getTemperature()**
+
+
+#### Enable / disable interrupts
+
+- **bool getDisableIRQ()**
+- **void setDisableIRQ(bool b )**
+
+
 
 
 ## Operational