Skip to content

Commit

Permalink
Merge pull request #20 from libdriver/dev
Browse files Browse the repository at this point in the history 
doc: fix doc errors
  • Loading branch information
@libdriver
libdriver authored Aug 10, 2024
2 parents c973658 + 026591f commit d8ad4dc
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 13 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 1.0.2 (2024-08-10)

## Bug Fixes

- fix doc errors

## 1.0.1 (2024-04-15)

## Bug Fixes
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -228,4 +228,4 @@ SOFTWARE.
### Contact Us
Please sent an e-mail to lishifenging@outlook.com.
Please send an e-mail to lishifenging@outlook.com.
12 changes: 6 additions & 6 deletions doc/html/driver__sps30_8c_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1790,7 +1790,7 @@
<div class="line"><a name="l02024"></a><span class="lineno"> 2024</span>&#160; {</div>
<div class="line"><a name="l02025"></a><span class="lineno"> 2025</span>&#160; handle-&gt;<a class="code" href="structsps30__handle__s.html#a769d5b3a6c14790a0e126e8fe70b384b">debug_print</a>(<span class="stringliteral">&quot;sps30: uart init failed.\n&quot;</span>); <span class="comment">/* uart init failed */</span></div>
<div class="line"><a name="l02026"></a><span class="lineno"> 2026</span>&#160; </div>
<div class="line"><a name="l02027"></a><span class="lineno"> 2027</span>&#160; <span class="keywordflow">return</span> 3; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02027"></a><span class="lineno"> 2027</span>&#160; <span class="keywordflow">return</span> 1; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02028"></a><span class="lineno"> 2028</span>&#160; }</div>
<div class="line"><a name="l02029"></a><span class="lineno"> 2029</span>&#160; input_buf[0] = 0x7E; <span class="comment">/* set start */</span></div>
<div class="line"><a name="l02030"></a><span class="lineno"> 2030</span>&#160; input_buf[1] = 0x00; <span class="comment">/* set addr */</span></div>
Expand All @@ -1805,29 +1805,29 @@
<div class="line"><a name="l02039"></a><span class="lineno"> 2039</span>&#160; handle-&gt;<a class="code" href="structsps30__handle__s.html#a769d5b3a6c14790a0e126e8fe70b384b">debug_print</a>(<span class="stringliteral">&quot;sps30: write read failed.\n&quot;</span>); <span class="comment">/* write read failed */</span></div>
<div class="line"><a name="l02040"></a><span class="lineno"> 2040</span>&#160; (void)handle-&gt;<a class="code" href="structsps30__handle__s.html#a57faa7438fdabb6134dabb8b386707a8">uart_deinit</a>(); <span class="comment">/* uart deinit */</span></div>
<div class="line"><a name="l02041"></a><span class="lineno"> 2041</span>&#160; </div>
<div class="line"><a name="l02042"></a><span class="lineno"> 2042</span>&#160; <span class="keywordflow">return</span> 1; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02042"></a><span class="lineno"> 2042</span>&#160; <span class="keywordflow">return</span> 4; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02043"></a><span class="lineno"> 2043</span>&#160; }</div>
<div class="line"><a name="l02044"></a><span class="lineno"> 2044</span>&#160; <span class="keywordflow">if</span> (out_buf[5] != a_sps30_generate_crc(handle, (uint8_t *)&amp;out_buf[1], 4)) <span class="comment">/* check crc */</span></div>
<div class="line"><a name="l02045"></a><span class="lineno"> 2045</span>&#160; {</div>
<div class="line"><a name="l02046"></a><span class="lineno"> 2046</span>&#160; handle-&gt;<a class="code" href="structsps30__handle__s.html#a769d5b3a6c14790a0e126e8fe70b384b">debug_print</a>(<span class="stringliteral">&quot;sps30: crc check error.\n&quot;</span>); <span class="comment">/* crc check error */</span></div>
<div class="line"><a name="l02047"></a><span class="lineno"> 2047</span>&#160; (void)handle-&gt;<a class="code" href="structsps30__handle__s.html#a57faa7438fdabb6134dabb8b386707a8">uart_deinit</a>(); <span class="comment">/* uart deinit */</span></div>
<div class="line"><a name="l02048"></a><span class="lineno"> 2048</span>&#160; </div>
<div class="line"><a name="l02049"></a><span class="lineno"> 2049</span>&#160; <span class="keywordflow">return</span> 1; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02049"></a><span class="lineno"> 2049</span>&#160; <span class="keywordflow">return</span> 4; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02050"></a><span class="lineno"> 2050</span>&#160; }</div>
<div class="line"><a name="l02051"></a><span class="lineno"> 2051</span>&#160; <span class="keywordflow">if</span> (a_sps30_uart_error(handle, out_buf[3]) != 0) <span class="comment">/* check status */</span></div>
<div class="line"><a name="l02052"></a><span class="lineno"> 2052</span>&#160; {</div>
<div class="line"><a name="l02053"></a><span class="lineno"> 2053</span>&#160; (void)handle-&gt;<a class="code" href="structsps30__handle__s.html#a57faa7438fdabb6134dabb8b386707a8">uart_deinit</a>(); <span class="comment">/* uart deinit */</span></div>
<div class="line"><a name="l02054"></a><span class="lineno"> 2054</span>&#160; </div>
<div class="line"><a name="l02055"></a><span class="lineno"> 2055</span>&#160; <span class="keywordflow">return</span> 1; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02055"></a><span class="lineno"> 2055</span>&#160; <span class="keywordflow">return</span> 4; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02056"></a><span class="lineno"> 2056</span>&#160; }</div>
<div class="line"><a name="l02057"></a><span class="lineno"> 2057</span>&#160; }</div>
<div class="line"><a name="l02058"></a><span class="lineno"> 2058</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l02059"></a><span class="lineno"> 2059</span>&#160; {</div>
<div class="line"><a name="l02060"></a><span class="lineno"> 2060</span>&#160; <span class="keywordflow">if</span> (handle-&gt;<a class="code" href="structsps30__handle__s.html#a8826dd07625f8d90859ce9bd09628d61">iic_init</a>() != 0) <span class="comment">/* iic init */</span></div>
<div class="line"><a name="l02061"></a><span class="lineno"> 2061</span>&#160; {</div>
<div class="line"><a name="l02062"></a><span class="lineno"> 2062</span>&#160; handle-&gt;<a class="code" href="structsps30__handle__s.html#a769d5b3a6c14790a0e126e8fe70b384b">debug_print</a>(<span class="stringliteral">&quot;sps30: iic init failed.\n&quot;</span>); <span class="comment">/* iic init failed */</span></div>
<div class="line"><a name="l02063"></a><span class="lineno"> 2063</span>&#160; </div>
<div class="line"><a name="l02064"></a><span class="lineno"> 2064</span>&#160; <span class="keywordflow">return</span> 3; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02063"></a><span class="lineno"> 2063</span>&#160; </div>
<div class="line"><a name="l02064"></a><span class="lineno"> 2064</span>&#160; <span class="keywordflow">return</span> 1; <span class="comment">/* return error */</span></div>
<div class="line"><a name="l02065"></a><span class="lineno"> 2065</span>&#160; }</div>
<div class="line"><a name="l02066"></a><span class="lineno"> 2066</span>&#160; res = a_sps30_iic_write(handle, <a class="code" href="driver__sps30_8c.html#aff9991e8d0c9fb153243931c85a2d3c2">SPS30_ADDRESS</a>, <a class="code" href="driver__sps30_8c.html#ac37ca4352b0ec4007a87c8917b5dac30">SPS30_IIC_COMMAND_RESET</a>, NULL, 0, 100); <span class="comment">/* reset command */</span></div>
<div class="line"><a name="l02067"></a><span class="lineno"> 2067</span>&#160; <span class="keywordflow">if</span> (res != 0) <span class="comment">/* check result */</span></div>
Expand Down
12 changes: 6 additions & 6 deletions src/driver_sps30.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2024,7 +2024,7 @@ uint8_t sps30_init(sps30_handle_t *handle)
{
handle->debug_print("sps30: uart init failed.\n"); /* uart init failed */

return 3; /* return error */
return 1; /* return error */
}
input_buf[0] = 0x7E; /* set start */
input_buf[1] = 0x00; /* set addr */
Expand All @@ -2039,29 +2039,29 @@ uint8_t sps30_init(sps30_handle_t *handle)
handle->debug_print("sps30: write read failed.\n"); /* write read failed */
(void)handle->uart_deinit(); /* uart deinit */

return 1; /* return error */
return 4; /* return error */
}
if (out_buf[5] != a_sps30_generate_crc(handle, (uint8_t *)&out_buf[1], 4)) /* check crc */
{
handle->debug_print("sps30: crc check error.\n"); /* crc check error */
(void)handle->uart_deinit(); /* uart deinit */

return 1; /* return error */
return 4; /* return error */
}
if (a_sps30_uart_error(handle, out_buf[3]) != 0) /* check status */
{
(void)handle->uart_deinit(); /* uart deinit */

return 1; /* return error */
return 4; /* return error */
}
}
else
{
if (handle->iic_init() != 0) /* iic init */
{
handle->debug_print("sps30: iic init failed.\n"); /* iic init failed */

return 3; /* return error */
return 1; /* return error */
}
res = a_sps30_iic_write(handle, SPS30_ADDRESS, SPS30_IIC_COMMAND_RESET, NULL, 0, 100); /* reset command */
if (res != 0) /* check result */
Expand Down

0 comments on commit d8ad4dc

Please sign in to comment.