-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
186 lines (184 loc) · 10.5 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PH4502C-Sensor: PH4502C Library Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">PH4502C-Sensor
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">PH4502C Library Overview </div></div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><ul><li class="level2"><a href="#autotoc_md0">Features</a></li>
<li class="level2"><a href="#autotoc_md1">Installation</a><ul><li class="level3"><a href="#autotoc_md2">Installation on Arduino IDE</a></li>
<li class="level3"><a href="#autotoc_md3">Installation on PlatformIO</a></li>
</ul>
</li>
<li class="level2"><a href="#autotoc_md4">Getting Started</a></li>
<li class="level2"><a href="#autotoc_md5">Documentation</a></li>
<li class="level2"><a href="#autotoc_md6">Contributing</a></li>
<li class="level2"><a href="#autotoc_md7">License</a></li>
</ul>
</ul>
</div>
<div class="textblock"><p>This Arduino library provides a convenient and easy-to-use interface for the PH4502C sensor, allowing you to effortlessly integrate it into your Arduino projects. The PH4502C sensor is a high-precision pH sensor capable of accurately measuring pH levels in various applications.</p>
<p align="center"></p>
<p><img src="ph4502c-sensor.png" alt="" width="450" align="center" class="inline"/> </p>
<h2><a class="anchor" id="autotoc_md0"></a>
Features</h2>
<ul>
<li>Simple and intuitive API for interacting with the PH4502 sensor.</li>
<li>Supports pH measurement with high precision and accuracy. Automatic temperature compensation for more accurate readings.</li>
<li>Flexible calibration options to ensure optimal performance.</li>
<li>Lightweight and efficient implementation for resource-constrained Arduino boards.</li>
</ul>
<h2><a class="anchor" id="autotoc_md1"></a>
Installation</h2>
<p>To use the PH4502 Sensor Arduino Library, follow these steps:</p>
<h3><a class="anchor" id="autotoc_md2"></a>
Installation on Arduino IDE</h3>
<p>Just type "PH4502C-Sensor" on the Library Manager of the Arduino IDE.</p>
<p><img src="screenshot-1.png" alt="" width="300" class="inline"/> </p>
<p>Alternatively you can follow the steps below:</p>
<ol type="1">
<li><p class="startli">Download the library by clicking on the "Download" button or clone it using Git:</p>
<div class="fragment"><div class="line">git clone https://github.com/nthnn/PH4502C-Sensor.git</div>
</div><!-- fragment --></li>
<li><p class="startli">Place the downloaded library folder into the Arduino libraries directory on your computer. In Windows, the default location is usually:</p>
<div class="fragment"><div class="line">[Arduino Documents Folder]/libraries/</div>
</div><!-- fragment --></li>
<li>Launch the Arduino IDE. Then, click on "Sketch" and then navigate to Include Library. You should see the newly added "PH4502-Sensor" option. Click on it to include the library in your sketch.</li>
</ol>
<p>Now you are ready to use the PH4502 Sensor Library in your Arduino projects.</p>
<h3><a class="anchor" id="autotoc_md3"></a>
Installation on PlatformIO</h3>
<p>Type "PH4502C-Sensor" on the PlatformIO library registry, and click "Add Project." And that's it!</p>
<p><img src="screenshot-2.png" alt="" width="400" class="inline"/> </p>
<h2><a class="anchor" id="autotoc_md4"></a>
Getting Started</h2>
<p>To begin using the PH4502 Sensor Library, follow these simple steps:</p>
<ol type="1">
<li>Connect your PH4502C sensor to your Arduino board. Make sure to connect the appropriate VCC, GND, and data pins based on your Arduino model and pin configuration.</li>
<li><p class="startli">In your Arduino sketch, include the PH4502C Sensor Library by adding the following line at the top of your code:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="ph4502c__sensor_8h.html">ph4502c_sensor.h</a>></span></div>
<div class="ttc" id="aph4502c__sensor_8h_html"><div class="ttname"><a href="ph4502c__sensor_8h.html">ph4502c_sensor.h</a></div><div class="ttdoc">Arduino Library for PH4502C Sensor.</div></div>
</div><!-- fragment --><p class="startli">Create an instance of the <code><a class="el" href="classPH4502C__Sensor.html" title="Class for interfacing with the PH4502C pH sensor.">PH4502C_Sensor</a></code> class:</p>
<div class="fragment"><div class="line">PH4502Sensor ph4502c(A0, A1);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Analog Pin 0 - pH level pin</span></div>
<div class="line"><span class="comment">// Analog Pin 1 - temperature pin</span></div>
</div><!-- fragment --><p class="startli">Initialize the sensor in the <code>setup()</code> function of your sketch:</p>
<p class="startli"><code>cpp void setup() { // Initialize the sensor ph4502c.init(); } </code></p>
<p class="startli">Read the pH value from the sensor using the readpH() function:</p>
<p class="startli">```cpp void loop() { // Read pH value float pHValue = ph4502c.read_ph_level();</p>
<p class="startli">// Do something with the pH value // Delay before next reading delay(1000); } ```</p>
<p class="startli">Optionally, you can calibrate the sensor for better accuracy. Refer to the library [documentation](docs) for more information on calibration.</p>
</li>
</ol>
<h2><a class="anchor" id="autotoc_md5"></a>
Documentation</h2>
<p>For detailed information on the library functions, classes, and usage examples, please refer to the [PH4502 Sensor Library Documentation](docs).</p>
<h2><a class="anchor" id="autotoc_md6"></a>
Contributing</h2>
<p>Contributions to this library are welcome! If you encounter any issues, have suggestions for improvements, or would like to add new features, please feel free to submit a pull request or open an issue on the GitHub repository.</p>
<p>Before submitting a pull request, please ensure that your code follows the existing coding style and that relevant tests have been added or updated.</p>
<h2><a class="anchor" id="autotoc_md7"></a>
License</h2>
<p>Copyright 2023 - Nathanne Isip</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p><code>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</code> </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>