analog_pin.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020, Richard Henrichsen
3  *
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * * Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * * Neither the name of the copyright holder nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef ANALOG_H
33 #define ANALOG_H
34 
36 #include "gpio.h"
37 #include "system.h"
38 
44 class AnalogPin
45 {
46 public:
56  void init(AnalogDigitalConverter *adc, GPIO_TypeDef *basePort, uint16_t pin, uint8_t adc_channel);
61  double read() const; // Returns a reading in volts
67  uint16_t read_raw() const;
68 
69 private:
72  uint8_t index_;
73 };
74 
75 #endif // ANALOG_H
double read() const
Get the last reading of the pin, in volts.
Definition: analog_pin.cpp:41
A driver for the analog-digital converters available on the microcontroller.
GPIO gpio_
Definition: analog_pin.h:70
General Purpose I/O.
Definition: stm32f4xx.h:1281
AnalogDigitalConverter * adc_
Definition: analog_pin.h:71
A class to represent a single pin configured for analog input.
Definition: analog_pin.h:44
void init(AnalogDigitalConverter *adc, GPIO_TypeDef *basePort, uint16_t pin, uint8_t adc_channel)
Initializes a pin to read analog values.
Definition: analog_pin.cpp:34
uint8_t index_
Definition: analog_pin.h:72
Definition: gpio.h:37
uint16_t read_raw() const
Get the most recent reading of the pin, directly from the ADC. See AnalogDigitalConverter.read for the details on interpreting this value.
Definition: analog_pin.cpp:46


rosflight_firmware
Author(s): Daniel Koch , James Jackson
autogenerated on Fri Oct 9 2020 03:17:15