Merge pull request #12 from hepingood/dev

feat: disable heater
libdriver · Jun 23, 2023 · 8718cb5 · 8718cb5
2 parents 12caca1 + c46ec14
commit 8718cb5
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 13 deletions.
diff --git a/doc/html/driver__sht31__basic_8h.html b/doc/html/driver__sht31__basic_8h.html
@@ -105,7 +105,7 @@
 <tr class="separator:gaf69fe6b787a6dd4a13618923a984e8e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga866367a598e5f9e3156f28d31dbdf9de"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga866367a598e5f9e3156f28d31dbdf9de">SHT31_BASIC_DEFAULT_REPEATABILITY</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#ggad29ab0ec4d85073571e2b48297e88504afa050184f8bba83b41c72128dc3452e5">SHT31_REPEATABILITY_HIGH</a></td></tr>
 <tr class="separator:ga866367a598e5f9e3156f28d31dbdf9de"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga627eb36da56605ca5517a33a79ca1543"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga627eb36da56605ca5517a33a79ca1543">SHT31_BASIC_DEFAULT_HEATER</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa826a5bd3ed938623629d1752bd09cd26">SHT31_BOOL_TRUE</a></td></tr>
+<tr class="memitem:ga627eb36da56605ca5517a33a79ca1543"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga627eb36da56605ca5517a33a79ca1543">SHT31_BASIC_DEFAULT_HEATER</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa0f4a30dba652a8d43f7acac7e8fa18a5">SHT31_BOOL_FALSE</a></td></tr>
 <tr class="separator:ga627eb36da56605ca5517a33a79ca1543"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>

diff --git a/doc/html/driver__sht31__basic_8h_source.html b/doc/html/driver__sht31__basic_8h_source.html
@@ -100,7 +100,7 @@
 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160; </div>
 <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__sht31__example__driver.html#gaf69fe6b787a6dd4a13618923a984e8e6">   57</a></span>&#160;<span class="preprocessor">#define SHT31_BASIC_DEFAULT_RATE                 SHT31_RATE_10HZ                 </span></div>
 <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="group__sht31__example__driver.html#ga866367a598e5f9e3156f28d31dbdf9de">   58</a></span>&#160;<span class="preprocessor">#define SHT31_BASIC_DEFAULT_REPEATABILITY        SHT31_REPEATABILITY_HIGH        </span></div>
-<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__sht31__example__driver.html#ga627eb36da56605ca5517a33a79ca1543">   59</a></span>&#160;<span class="preprocessor">#define SHT31_BASIC_DEFAULT_HEATER               SHT31_BOOL_TRUE                 </span></div>
+<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__sht31__example__driver.html#ga627eb36da56605ca5517a33a79ca1543">   59</a></span>&#160;<span class="preprocessor">#define SHT31_BASIC_DEFAULT_HEATER               SHT31_BOOL_FALSE                </span></div>
 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;uint8_t <a class="code" href="group__sht31__example__driver.html#ga8186b2dcb932a46392abd71ceb28ee22">sht31_basic_init</a>(<a class="code" href="group__sht31__base__driver.html#gac2f5eeef853716218a49755c930b4a6e">sht31_address_t</a> addr_pin);</div>
 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160; </div>
 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;uint8_t <a class="code" href="group__sht31__example__driver.html#ga62f0af1fffda72ce6b72ada83664d632">sht31_basic_read</a>(<span class="keywordtype">float</span> *temperature, <span class="keywordtype">float</span> *humidity);</div>

diff --git a/doc/html/driver__sht31__shot_8h.html b/doc/html/driver__sht31__shot_8h.html
@@ -105,7 +105,7 @@
 <tr class="separator:ga217a2d7cd41ff662f5ad3cd6edb05928"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga73f35f1fc7164e80fa874f68ffa3e118"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga73f35f1fc7164e80fa874f68ffa3e118">SHT31_SHOT_DEFAULT_REPEATABILITY</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#ggad29ab0ec4d85073571e2b48297e88504afa050184f8bba83b41c72128dc3452e5">SHT31_REPEATABILITY_HIGH</a></td></tr>
 <tr class="separator:ga73f35f1fc7164e80fa874f68ffa3e118"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga4801db7922aae5e11bc56b1efce188ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga4801db7922aae5e11bc56b1efce188ab">SHT31_SHOT_DEFAULT_HEATER</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa826a5bd3ed938623629d1752bd09cd26">SHT31_BOOL_TRUE</a></td></tr>
+<tr class="memitem:ga4801db7922aae5e11bc56b1efce188ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga4801db7922aae5e11bc56b1efce188ab">SHT31_SHOT_DEFAULT_HEATER</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa0f4a30dba652a8d43f7acac7e8fa18a5">SHT31_BOOL_FALSE</a></td></tr>
 <tr class="separator:ga4801db7922aae5e11bc56b1efce188ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>

diff --git a/doc/html/driver__sht31__shot_8h_source.html b/doc/html/driver__sht31__shot_8h_source.html
@@ -100,7 +100,7 @@
 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160; </div>
 <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="group__sht31__example__driver.html#ga217a2d7cd41ff662f5ad3cd6edb05928">   55</a></span>&#160;<span class="preprocessor">#define SHT31_SHOT_DEFAULT_CLOCK_STRETCHING     SHT31_BOOL_TRUE                 </span></div>
 <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="group__sht31__example__driver.html#ga73f35f1fc7164e80fa874f68ffa3e118">   56</a></span>&#160;<span class="preprocessor">#define SHT31_SHOT_DEFAULT_REPEATABILITY        SHT31_REPEATABILITY_HIGH        </span></div>
-<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__sht31__example__driver.html#ga4801db7922aae5e11bc56b1efce188ab">   57</a></span>&#160;<span class="preprocessor">#define SHT31_SHOT_DEFAULT_HEATER               SHT31_BOOL_TRUE                 </span></div>
+<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__sht31__example__driver.html#ga4801db7922aae5e11bc56b1efce188ab">   57</a></span>&#160;<span class="preprocessor">#define SHT31_SHOT_DEFAULT_HEATER               SHT31_BOOL_FALSE                </span></div>
 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;uint8_t <a class="code" href="group__sht31__example__driver.html#gacc0379b6589e59735c28b5d3e12c8f45">sht31_shot_init</a>(<a class="code" href="group__sht31__base__driver.html#gac2f5eeef853716218a49755c930b4a6e">sht31_address_t</a> addr_pin);</div>
 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;uint8_t <a class="code" href="group__sht31__example__driver.html#gaad991885dd385ba4bdb3eaf5b28ddbb6">sht31_shot_read</a>(<span class="keywordtype">float</span> *temperature, <span class="keywordtype">float</span> *humidity);</div>

diff --git a/doc/html/group__sht31__example__driver.html b/doc/html/group__sht31__example__driver.html
@@ -102,14 +102,14 @@
 <tr class="separator:gaf69fe6b787a6dd4a13618923a984e8e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga866367a598e5f9e3156f28d31dbdf9de"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga866367a598e5f9e3156f28d31dbdf9de">SHT31_BASIC_DEFAULT_REPEATABILITY</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#ggad29ab0ec4d85073571e2b48297e88504afa050184f8bba83b41c72128dc3452e5">SHT31_REPEATABILITY_HIGH</a></td></tr>
 <tr class="separator:ga866367a598e5f9e3156f28d31dbdf9de"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga627eb36da56605ca5517a33a79ca1543"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga627eb36da56605ca5517a33a79ca1543">SHT31_BASIC_DEFAULT_HEATER</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa826a5bd3ed938623629d1752bd09cd26">SHT31_BOOL_TRUE</a></td></tr>
+<tr class="memitem:ga627eb36da56605ca5517a33a79ca1543"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga627eb36da56605ca5517a33a79ca1543">SHT31_BASIC_DEFAULT_HEATER</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa0f4a30dba652a8d43f7acac7e8fa18a5">SHT31_BOOL_FALSE</a></td></tr>
 <tr class="separator:ga627eb36da56605ca5517a33a79ca1543"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga217a2d7cd41ff662f5ad3cd6edb05928"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga217a2d7cd41ff662f5ad3cd6edb05928">SHT31_SHOT_DEFAULT_CLOCK_STRETCHING</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa826a5bd3ed938623629d1752bd09cd26">SHT31_BOOL_TRUE</a></td></tr>
 <tr class="memdesc:ga217a2d7cd41ff662f5ad3cd6edb05928"><td class="mdescLeft">&#160;</td><td class="mdescRight">sht31 shot example default definition  <a href="group__sht31__example__driver.html#ga217a2d7cd41ff662f5ad3cd6edb05928">More...</a><br /></td></tr>
 <tr class="separator:ga217a2d7cd41ff662f5ad3cd6edb05928"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga73f35f1fc7164e80fa874f68ffa3e118"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga73f35f1fc7164e80fa874f68ffa3e118">SHT31_SHOT_DEFAULT_REPEATABILITY</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#ggad29ab0ec4d85073571e2b48297e88504afa050184f8bba83b41c72128dc3452e5">SHT31_REPEATABILITY_HIGH</a></td></tr>
 <tr class="separator:ga73f35f1fc7164e80fa874f68ffa3e118"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga4801db7922aae5e11bc56b1efce188ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga4801db7922aae5e11bc56b1efce188ab">SHT31_SHOT_DEFAULT_HEATER</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa826a5bd3ed938623629d1752bd09cd26">SHT31_BOOL_TRUE</a></td></tr>
+<tr class="memitem:ga4801db7922aae5e11bc56b1efce188ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sht31__example__driver.html#ga4801db7922aae5e11bc56b1efce188ab">SHT31_SHOT_DEFAULT_HEATER</a>&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa0f4a30dba652a8d43f7acac7e8fa18a5">SHT31_BOOL_FALSE</a></td></tr>
 <tr class="separator:ga4801db7922aae5e11bc56b1efce188ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
@@ -143,11 +143,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga627eb36da56605ca5517a33
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">#define SHT31_BASIC_DEFAULT_HEATER&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa826a5bd3ed938623629d1752bd09cd26">SHT31_BOOL_TRUE</a></td>
+          <td class="memname">#define SHT31_BASIC_DEFAULT_HEATER&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa0f4a30dba652a8d43f7acac7e8fa18a5">SHT31_BOOL_FALSE</a></td>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>enable heater </p>
+<p>disable heater </p>
 
 <p class="definition">Definition at line <a class="el" href="driver__sht31__basic_8h_source.html#l00059">59</a> of file <a class="el" href="driver__sht31__basic_8h_source.html">driver_sht31_basic.h</a>.</p>
 
@@ -215,11 +215,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4801db7922aae5e11bc56b1
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">#define SHT31_SHOT_DEFAULT_HEATER&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa826a5bd3ed938623629d1752bd09cd26">SHT31_BOOL_TRUE</a></td>
+          <td class="memname">#define SHT31_SHOT_DEFAULT_HEATER&#160;&#160;&#160;<a class="el" href="group__sht31__base__driver.html#gga277d62f13f4574104cba1c49a7da889fa0f4a30dba652a8d43f7acac7e8fa18a5">SHT31_BOOL_FALSE</a></td>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>enable heater </p>
+<p>disable heater </p>
 
 <p class="definition">Definition at line <a class="el" href="driver__sht31__shot_8h_source.html#l00057">57</a> of file <a class="el" href="driver__sht31__shot_8h_source.html">driver_sht31_shot.h</a>.</p>
 

diff --git a/example/driver_sht31_basic.h b/example/driver_sht31_basic.h
@@ -56,7 +56,7 @@ extern "C"{
  */
 #define SHT31_BASIC_DEFAULT_RATE                 SHT31_RATE_10HZ                 /**< rate 100Hz */
 #define SHT31_BASIC_DEFAULT_REPEATABILITY        SHT31_REPEATABILITY_HIGH        /**< set high */
-#define SHT31_BASIC_DEFAULT_HEATER               SHT31_BOOL_TRUE                 /**< enable heater */
+#define SHT31_BASIC_DEFAULT_HEATER               SHT31_BOOL_FALSE                /**< disable heater */
 
 /**
  * @brief     basic example init

diff --git a/example/driver_sht31_shot.h b/example/driver_sht31_shot.h
@@ -54,7 +54,7 @@ extern "C"{
  */
 #define SHT31_SHOT_DEFAULT_CLOCK_STRETCHING     SHT31_BOOL_TRUE                 /**< enable clock stretching */
 #define SHT31_SHOT_DEFAULT_REPEATABILITY        SHT31_REPEATABILITY_HIGH        /**< set high */
-#define SHT31_SHOT_DEFAULT_HEATER               SHT31_BOOL_TRUE                 /**< enable heater */
+#define SHT31_SHOT_DEFAULT_HEATER               SHT31_BOOL_FALSE                /**< disable heater */
 
 /**
  * @brief     shot example init

diff --git a/project/stm32f407/README.md b/project/stm32f407/README.md
@@ -14,7 +14,7 @@ IIC Pin: SCL/SDA PB8/PB9.
 
 #### 2.1 Integrated Development Environment
 
-LidDriver provides both Keil and IAR integrated development environment projects.
+LibDriver provides both Keil and IAR integrated development environment projects.
 
 MDK is the Keil ARM project and your Keil version must be 5 or higher.Keil ARM project needs STMicroelectronics STM32F4 Series Device Family Pack and you can download from https://www.keil.com/dd2/stmicroelectronics/stm32f407zgtx.