-
-
Notifications
You must be signed in to change notification settings - Fork 66
/
ds18b20.h
150 lines (137 loc) · 5 KB
/
ds18b20.h
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
/*
* The MIT License (MIT)
*
* Copyright (c) 2014-2018, Erik Moqvist
*
* 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.
*
* This file is part of the Simba project.
*/
#ifndef __DRIVERS_DS18B20_H__
#define __DRIVERS_DS18B20_H__
#include "simba.h"
/* DS18B20 one wire family code. */
#define DS18B20_FAMILY_CODE 0x28
struct ds18b20_driver_t {
struct owi_driver_t *owi_p;
struct ds18b20_driver_t *next_p;
};
/**
* Initialize the DS18B20 driver module. This function must be called
* before calling any other function in this module.
*
* The module will only be initialized once even if this function is
* called multiple times.
*
* @return zero(0) or negative error code.
*/
int ds18b20_module_init(void);
/**
* Initialize given driver object. The driver object will communicate
* with all DS18B20 sensors on given OWI bus.
*
* @param[out] self_p Driver object to be initialized.
* @param[in] owi_p One-Wire (OWI) driver.
*
* @return zero(0) or negative error code.
*/
int ds18b20_init(struct ds18b20_driver_t *self_p,
struct owi_driver_t *owi_p);
/**
* Start a temperature convertion on all sensors. The converted
* temperature can later be read with ``ds18b20_read*()``.
*
* @param[in] self_p Initialized driver object.
*
* @return zero(0) or negative error code.
*/
int ds18b20_convert(struct ds18b20_driver_t *self_p);
/**
* Read the most recently converted temperature from given sensor.
*
* @param[in] self_p Initialized driver object.
* @param[in] id_p Sensor identity.
* @param[out] temperature_p Measured temperature.
*
* @return zero(0) or negative error code.
*/
int ds18b20_read(struct ds18b20_driver_t *self_p,
const uint8_t *id_p,
float *temperature_p);
/**
* Read the most recently converted temperature from given sensor as a
* fixed point number.
*
* @param[in] self_p Initialized driver object.
* @param[in] id_p Sensor identity.
* @param[out] temperature_p Measured temperature in Q4 fixed point
* format, or unit 0.0625 degrees Celsius
* (the raw value read from the sensor).
*
* @return zero(0) or negative error code.
*/
int ds18b20_read_fixed_point(struct ds18b20_driver_t *self_p,
const uint8_t *id_p,
int *temperature_p);
/**
* Read the most recently converted temperature from given sensor as a
* string.
*
* @param[in] self_p Initialized driver object.
* @param[in] id_p Sensor identity.
* @param[out] temperature_p Measured temperature as a string.
*
* @return ``temperature_p`` on success, NULL otherwise.
*/
char *ds18b20_read_string(struct ds18b20_driver_t *self_p,
const uint8_t *id_p,
char *temperature_p);
/**
* Read the most recently converted temperature from given
* sensor. Call ``ds18b20_convert()`` to read the temperature from the
* sensor and update the cached value.
*
* @param[in] self_p Initialized driver object.
* @param[in] id_p Sensor identity.
* @param[out] temperature_p Measured temperature in 0.0625 degrees
* Celsius (the raw value read from the
* sensor).
*
* @return zero(0) or negative error code.
*/
int ds18b20_get_temperature(struct ds18b20_driver_t *self_p,
const uint8_t *id_p,
int *temperature_p)
__attribute__ ((deprecated("Use ds18b20_read_fixed_point() instead.")));
/**
* Get temperature for given sensor identity formatted as a string.
*
* @param[in] self_p Initialized driver object.
* @param[in] id_p Sensor identity.
* @param[out] temperature_p Measured formatted temperature.
*
* @return ``temperature_p`` on success, NULL otherwise.
*/
char *ds18b20_get_temperature_str(struct ds18b20_driver_t *self_p,
const uint8_t *id_p,
char *temperature_p)
__attribute__ ((deprecated("Use ds18b20_read_string() instead.")));
#endif