summaryrefslogtreecommitdiffstats
path: root/watch-library/watch/watch_adc.h
diff options
context:
space:
mode:
authorJoey Castillo <jose.castillo@gmail.com>2021-08-23 08:11:49 -0600
committerJoey Castillo <jose.castillo@gmail.com>2021-08-23 08:11:49 -0600
commit67b749f3afe08bc8a14fa89e92019d142dafa74e (patch)
treedc46ba08c45a7aab96177a385dadc5a616a4e502 /watch-library/watch/watch_adc.h
parent42f0eac6d12bb354ce34f1cee42ad43f8a023282 (diff)
downloadSensor-Watch-67b749f3afe08bc8a14fa89e92019d142dafa74e.tar.gz
Sensor-Watch-67b749f3afe08bc8a14fa89e92019d142dafa74e.tar.bz2
Sensor-Watch-67b749f3afe08bc8a14fa89e92019d142dafa74e.zip
refactor: break out different areas of functionality
Diffstat (limited to 'watch-library/watch/watch_adc.h')
-rw-r--r--watch-library/watch/watch_adc.h35
1 files changed, 35 insertions, 0 deletions
diff --git a/watch-library/watch/watch_adc.h b/watch-library/watch/watch_adc.h
new file mode 100644
index 00000000..d4620365
--- /dev/null
+++ b/watch-library/watch/watch_adc.h
@@ -0,0 +1,35 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020 Joey Castillo
+ *
+ * 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:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * 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.
+ */
+////< @file watch_adc.h
+
+/** @addtogroup adc Analog Input
+ * @brief This section covers functions related to the SAM L22's analog-to-digital converter, as well as
+ * configuring and reading values from the three analog-capable pins on the 9-pin connector.
+ */
+/// @{
+/** @brief Enables the ADC peripheral, and configures the selected pin for analog input.
+ * @param pin One of pins A0, A1 or A2.
+ */
+void watch_enable_analog(const uint8_t pin);
+/// @}