From 595c3cb881c14a28d37a8a9a3e4aadc79285a673 Mon Sep 17 00:00:00 2001 From: joeycastillo Date: Sat, 5 Feb 2022 18:37:05 +0000 Subject: deploy: c74cacd34f68f2897fbd63e2ba90831f87cbad49 --- watch__adc_8h_source.html | 139 +++++++++++++++++++++++----------------------- 1 file changed, 69 insertions(+), 70 deletions(-) (limited to 'watch__adc_8h_source.html') diff --git a/watch__adc_8h_source.html b/watch__adc_8h_source.html index 1e7727c6..8365786c 100644 --- a/watch__adc_8h_source.html +++ b/watch__adc_8h_source.html @@ -2,8 +2,8 @@ - - + + Sensor Watch: watch-library/shared/watch/watch_adc.h Source File @@ -19,10 +19,9 @@
- - + @@ -31,21 +30,22 @@
-
Sensor Watch -  0.0.0 +
+
Sensor Watch 0.0.0
A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.
- + +/* @license-end */ +
-
-
watch_adc.h
+
watch_adc.h
-
1 /*
-
2  * MIT License
-
3  *
-
4  * Copyright (c) 2020 Joey Castillo
-
5  *
-
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
-
7  * of this software and associated documentation files (the "Software"), to deal
-
8  * in the Software without restriction, including without limitation the rights
-
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-
10  * copies of the Software, and to permit persons to whom the Software is
-
11  * furnished to do so, subject to the following conditions:
-
12  *
-
13  * The above copyright notice and this permission notice shall be included in all
-
14  * copies or substantial portions of the Software.
-
15  *
-
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-
22  * SOFTWARE.
-
23  */
-
24 #ifndef _WATCH_ADC_H_INCLUDED
-
25 #define _WATCH_ADC_H_INCLUDED
-
27 
-
28 #include "watch.h"
-
29 
-
36 
-
39 void watch_enable_adc(void);
-
40 
-
44 void watch_enable_analog_input(const uint8_t pin);
-
45 
-
52 uint16_t watch_get_analog_pin_level(const uint8_t pin);
-
53 
-
75 void watch_set_analog_num_samples(uint16_t samples);
-
76 
-
95 void watch_set_analog_sampling_length(uint8_t cycles);
-
96 
-
97 typedef enum {
-
98  ADC_REFERENCE_INTREF = 0,
-
99  ADC_REFERENCE_VCC_DIV1POINT6,
-
100  ADC_REFERENCE_VCC_DIV2,
-
101  ADC_REFERENCE_VCC,
-
102 } watch_adc_reference_voltage;
-
103 
-
104 
-
130 void watch_set_analog_reference_voltage(watch_adc_reference_voltage reference);
-
131 
-
142 uint16_t watch_get_vcc_voltage(void);
-
143 
-
147 void watch_disable_analog_input(const uint8_t pin);
-
148 
-
154 void watch_disable_adc(void);
-
155 
-
157 #endif
+
1/*
+
2 * MIT License
+
3 *
+
4 * Copyright (c) 2020 Joey Castillo
+
5 *
+
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
+
7 * of this software and associated documentation files (the "Software"), to deal
+
8 * in the Software without restriction, including without limitation the rights
+
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+
10 * copies of the Software, and to permit persons to whom the Software is
+
11 * furnished to do so, subject to the following conditions:
+
12 *
+
13 * The above copyright notice and this permission notice shall be included in all
+
14 * copies or substantial portions of the Software.
+
15 *
+
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+
22 * SOFTWARE.
+
23 */
+
24#ifndef _WATCH_ADC_H_INCLUDED
+
25#define _WATCH_ADC_H_INCLUDED
+
27
+
28#include "watch.h"
+
29
+
36
+
39void watch_enable_adc(void);
+
40
+
44void watch_enable_analog_input(const uint8_t pin);
+
45
+
52uint16_t watch_get_analog_pin_level(const uint8_t pin);
+
53
+
75void watch_set_analog_num_samples(uint16_t samples);
+
76
+
95void watch_set_analog_sampling_length(uint8_t cycles);
+
96
+
97typedef enum {
+
98 ADC_REFERENCE_INTREF = 0,
+
99 ADC_REFERENCE_VCC_DIV1POINT6,
+
100 ADC_REFERENCE_VCC_DIV2,
+
101 ADC_REFERENCE_VCC,
+
102} watch_adc_reference_voltage;
+
103
+
104
+
130void watch_set_analog_reference_voltage(watch_adc_reference_voltage reference);
+
131
+
142uint16_t watch_get_vcc_voltage(void);
+
143
+
147void watch_disable_analog_input(const uint8_t pin);
+
148
+
154void watch_disable_adc(void);
+
155
+
157#endif
watch_get_analog_pin_level
uint16_t watch_get_analog_pin_level(const uint8_t pin)
Reads an analog value from one of the pins.
watch_enable_analog_input
void watch_enable_analog_input(const uint8_t pin)
Configures the selected pin for analog input.
watch_get_vcc_voltage
uint16_t watch_get_vcc_voltage(void)
Returns the voltage of the VCC supply in millivolts (i.e. 3000 mV == 3.0 V). If running on a coin cel...
@@ -140,7 +139,7 @@ $(function() {
-Generated by doxygen 1.9.1 +Generated by doxygen 1.9.3
-- cgit v1.2.3