aboutsummaryrefslogtreecommitdiffstats
path: root/temp.h
blob: ab28b842c98abe5fd3ac50c2b03c52216f6d9c17 (plain)
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
/**
 * @file temp.h
 * Provides support for the TMP006 temperature sensor.
 *
 * Copyright (C) 2019  Clyne Sullivan
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef TEMP_H_
#define TEMP_H_

/**
 * Attempts to initialize the TMP006 temperature sensor.
 * @return Zero on success, non-zero on failure
 */
int tempInit(void);

/**
 * Gets the object's voltage, which may be used in calculations to get the
 * object's temperature.
 * @return The object's voltage
 */
int16_t tempGetObjVoltage(void);

/**
 * Gets the current ambient temperature, in Celsius.
 * @return The ambient temperature
 */
int16_t tempGetDieTemperature(void);

#endif // TEMP_H_