-
Notifications
You must be signed in to change notification settings - Fork 38
/
drv_one_wire.h
616 lines (593 loc) · 22.4 KB
/
drv_one_wire.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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
/****************************************************************************
**
** Copyright (C) ${COPYRIGHT_YEAR} MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** 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,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES 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 drv_one_wire.h
* @brief API for One Wire driver.
*/
#ifndef _DRV_ONE_WIRE_H_
#define _DRV_ONE_WIRE_H_
#ifdef __cplusplus
extern "C"{
#endif
#include "hal_one_wire.h"
#include "drv_name.h"
/**
* @brief One Wire Driver return values.
*/
typedef enum {
ONE_WIRE_SUCCESS = 0, /*!< Success. */
ONE_WIRE_ERROR = (-1) /*!< Error. */
} one_wire_error_t;
/**
* @brief Structure for storing One Wire device address.
* @details Unique One Wire address used for device addressing.
*/
typedef struct {
uint8_t address[8]; /*!< One Wire address buffer. */
} one_wire_rom_address_t;
/**
* @brief One Wire Driver initialization configuration structure.
*
* @details
* - data_pin value - to be configured as desired.
* - state value - NOTE must not be altered (it is supposed to be set automatically in Low Level Layer).
*/
typedef struct {
pin_name_t data_pin; /*!< One Wire pin - user is to configure it as desired. */
bool state; /*!< State of a pin. NOTE must not be altered. */
} one_wire_t;
/*!
* @addtogroup pergroup Microcontroller Peripherals
* @{
*/
/*!
* @addtogroup drvgroup Driver Layer
* @{
*/
/**
* WARNING
* @brief Important information in regards to CUSTOM One Wire timing.
* @details One Wire library is currently utilizing recommended
* "Maxim Integrated" One Wire timing sequences.
* If, by any chance, end-user needs custom timing
* sequences, "weak" functions shall be overwritten by end-user functions.
* Declaration of those functions can be found at following location:
* "\mikrosdk-2.0\hal\lib\include\hal_one_wire.h"
*
* Declarations:
* void one_wire_timing_value_a( void );
* void one_wire_timing_value_b( void );
* void one_wire_timing_value_c( void );
* void one_wire_timing_value_d( void );
* void one_wire_timing_value_e( void );
* void one_wire_timing_value_f( void );
* void one_wire_timing_value_h( void );
* void one_wire_timing_value_i( void );
* void one_wire_timing_value_j( void );
*
* @b Example
* @code
*
* // Configure custom timing "a" sequence value (delay).
* one_wire_timing_value_h() {
* asm nop; // To give an example...
* }
*
* @endcode
*
* Implementation example:
*
* @code
*
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
*
* // Send reset sequence on One Wire bus.
* // This funtion will now utilize custom timing
* // defined at the top of this code.
* one_wire_reset( &one_wire );
*
* @endcode
*/
/*!
* @addtogroup drvonewiregroup One Wire Master Driver
* @brief One Wire Master Driver API Reference.
* @details One Wire Master Driver API header.
* Contains all enums, structures and
* function declarations available for
* One Wire Master module.
* @{
*/
/**
* @brief Opens One Wire Driver object.
* @details Opens One Wire driver object on selected pin.
* Enables appropriate PORT clock, configures pin to have digital output functionality,
* makes sure that HIGH voltage state is applied on pin before any One Wire actions.
* @param[in,out] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
* @return The function can return one of the values defined by
* err_t, which is dependant on the architecture and ported low level layer.
* @pre Make sure that \p driver structure has been adequately
* populated beforehand.
* @note It is recommended to check return value for error.
*
* @b Example
* @code
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
err_t one_wire_open( one_wire_t *obj );
/**
* @brief Configures One Wire Driver configuration structure.
* @details Configures One Wire configuration structure to default initialization values.
* Take into consideration that this is just
* structure variable initial values setting.
* User must redefine only one value - data_pin.
* @param[in,out] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
*
* @b Default @b values:
* Function | Default value |
* --------------------|---------------------------------------|
* Data pin | 0xFFFFFFFF (invalid pin) |
* state | Pin state, do not alter. |
* @return Nothing.
* @pre The user is expected to call this function before #one_wire_open.
*
* @b Example
* @code
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
void one_wire_configure_default( one_wire_t *obj );
/**
* @brief Resets One Wire bus.
* @details Host shall send reset sequence and devices shall go into reset state.
* @param[in,out] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
* @return The function can return one of the values defined by
* #one_wire_err_t, which is size dependant on the architecture.
* @pre Before calling this function,
* the user is expected to call #one_wire_open function.
* @warning The following example describes how the function is used.
* Take into consideration that different hardware might not have the same pins.
* Make sure to accommodate pin name based on your hardware specifics.
*
* @b Example
* @code
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
*
* // Send reset sequence on One Wire bus.
* if ( ONE_WIRE_SUCCESS != one_wire_reset( &one_wire ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
err_t one_wire_reset( one_wire_t *obj );
/**
* @brief Reads device's ROM information.
* @details Allows the host to read eight-bit family code,
* 48-bit serial number, and eight-bit CRC.
*
* @important THIS FUNCTION IS TO BE ISSUED ONLY IF WE ARE DEALING WITH
* ONE DEVICE ONLY. THIS FUNCTION AUTOMATICALLY RESETS ONE WIRE BUS.
* @param[in] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
* @param[out] *device_rom_address Buffer for One Wire device ROM information.
* @return The function can return one of the values defined by
* #one_wire_err_t, which is size dependant on the architecture.
* @warning The following example describes how the function is used.
* Take into consideration that different hardware might not have the same pins.
* Make sure to accommodate pin name based on your hardware specifics.
*
* @b Example
* @code
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
*
* // Read "Family Code" (1 byte), serial number (6 bytes) and CRC (1 byte).
* if ( ONE_WIRE_SUCCESS != one_wire_read_rom( &one_wire_object_1, &one_wire_device_list ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
err_t one_wire_read_rom( one_wire_t *obj, one_wire_rom_address_t *device_rom_address );
/**
* @brief Access device's level functions without transmitting ROM information.
* @details Allows the host to access device functions without
* providing the 64-bit ROM identification number.
*
* @important THIS FUNCTION IS TO BE ISSUED ONLY IF WE ARE DEALING WITH
* ONE DEVICE ONLY. THIS FUNCTION AUTOMATICALLY RESETS ONE WIRE BUS.
* @param[in] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
* @return The function can return one of the values defined by
* #one_wire_err_t, which is size dependant on the architecture.
* @warning The following example describes how the function is used.
* Take into consideration that different hardware might not have the same pins.
* Make sure to accommodate pin name based on your hardware specifics.
*
* @b Example
* @code
* // Convert temperature command sequence for Thermo 19 Click.
* uint8_t cmd_convert_temperature = 0x44;
*
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // One Wire ROM address variable.
* one_wire_rom_address_t one_wire_device_list;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
*
* // Skip sending ROM information of a device
* // (this device is the only one on One Wire bus).
* one_wire_skip_rom( &one_wire_object_1 );
*
* // Start temperature conversion of a device.
* if ( ONE_WIRE_SUCCESS != one_wire_write_byte( &one_wire_object_1, &cmd_convert_temperature, 1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
err_t one_wire_skip_rom( one_wire_t *obj );
/**
* @brief Select a specific One Wire capable device on bus.
* @details Select a One Wire device with specific ID.
*
* @param[in] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
* @param[in] device_rom_address Buffer for One Wire device ROM information.
* @return The function can return one of the values defined by
* #one_wire_err_t, which is size dependant on the architecture.
* @pre Before calling this function,
* the user is expected to call #one_wire_open function.
* @warning The following example describes how the function is used.
* Take into consideration that different hardware might not have the same pins.
* Make sure to accommodate pin name based on your hardware specifics.
*
* @b Example
* @code
* // Convert temperature command sequence for Thermo 19 Click.
* uint8_t cmd_convert_temperature = 0x44;
*
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // One Wire ROM address variable.
* one_wire_rom_address_t one_wire_device_list;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
*
* // Try to match potential device on bus.
* one_wire_match( &one_wire, &one_wire_device_list );
*
* // Start temperature conversion of a device.
* if ( ONE_WIRE_SUCCESS != one_wire_write_byte( &one_wire_object_1, &cmd_convert_temperature, 1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
err_t one_wire_match_rom( one_wire_t *obj, one_wire_rom_address_t *device_rom_address );
/**
* @brief Search One Wire capable device on bus.
* @details Search and list 1st device that is One Wire capable.
*
* @param[in] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
* @param[out] *one_wire_device_list Buffer for One Wire device ROM information.
* @return The function can return one of the values defined by
* #one_wire_err_t, which is size dependant on the architecture.
* @pre Before calling this function,
* the user is expected to call #one_wire_open function.
* @warning The following example describes how the function is used.
* Take into consideration that different hardware might not have the same pins.
* Make sure to accommodate pin name based on your hardware specifics.
*
* @b Example
* @code
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // One Wire ROM address variable.
* one_wire_rom_address_t one_wire_device_1;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
*
* // Find 1st device on One Wire bus.
* if ( ONE_WIRE_SUCCESS != one_wire_search_first_device( &one_wire_object_1, &one_wire_device_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
err_t one_wire_search_first_device( one_wire_t *obj, one_wire_rom_address_t *one_wire_device_list );
/**
* @brief Search One Wire capable devices on bus.
* @details Search devices that are One Wire capable.
*
* @param[in] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
* @param[out] *one_wire_device_list Buffer for One Wire device ROM information.
* @return The function can return one of the values defined by
* #one_wire_err_t, which is size dependant on the architecture.
* @pre Before calling this function,
* the user is expected to call #one_wire_open function.
* @warning The following example describes how the function is used.
* Take into consideration that different hardware might not have the same pins.
* Make sure to accommodate pin name based on your hardware specifics.
*
* @b Example
* @code
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // One Wire ROM address variables.
* one_wire_rom_address_t one_wire_device_1;
* one_wire_rom_address_t one_wire_device_2;
* one_wire_rom_address_t one_wire_device_3;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
*
* // Find 1st device on One Wire bus.
* one_wire_search_first_device( &one_wire_object_1, &one_wire_device_1 );
*
* // Find 2nd device on One Wire bus.
* one_wire_search_next_device( &one_wire_object_1, &one_wire_device_2 );
*
* // Find 3rd device on One Wire bus.
* if ( ONE_WIRE_SUCCESS != one_wire_search_next_device( &one_wire_object_1, &one_wire_device_3 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
err_t one_wire_search_next_device( one_wire_t *obj, one_wire_rom_address_t *one_wire_device_list );
/**
* @brief Writes byte to One Wire bus.
* @details Writes byte to One Wire bus.
* @param[in] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
* @param[in] *write_data_buffer Data transmit buffer.
* @param[in] write_data_length Number of bytes to write from data transmit buffer.
* @return The function can return one of the values defined by
* #one_wire_err_t, which is size dependant on the architecture.
* @pre Before calling this function,
* the user is expected to call #one_wire_open function.
*
* @b Example
* @code
* // Command to write on bus.
* uint8_t cmd_write_command = 0x44;
*
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // One Wire ROM address variable.
* one_wire_rom_address_t one_wire_device_list;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
*
* // Skip sending ROM information of a device
* // (this device is the only one on One Wire bus).
* one_wire_skip_rom( &one_wire_object_1 );
*
* // Start temperature conversion of a device.
* if ( ONE_WIRE_SUCCESS != one_wire_write_byte( &one_wire_object_1, &cmd_write_command, 1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
err_t one_wire_write_byte( one_wire_t *obj, uint8_t *write_data_buffer, size_t write_data_length );
/**
* @brief Reads byte from One Wire bus.
* @details Reads byte from One Wire bus.
* @param[in] *obj One Wire driver object.
* See #one_wire_t structure definition for detailed explanation.
* @param[out] *read_data_buffer Data receive buffer.
* @param[in] read_data_length Number of bytes to be read.
* @return The function can return one of the values defined by
* #one_wire_err_t, which is size dependant on the architecture.
* @pre Before calling this function,
* the user is expected to call #one_wire_open function.
*
* @b Example
* @code
* // Command to write on bus.
* uint8_t cmd_write_command = 0x44;
*
* // Variable for storing temperature conversion status.
* uint8_t conversion_status = 0;
*
* // One Wire driver initialization configuration structure.
* static one_wire_t one_wire_object_1;
*
* // One Wire ROM address variable.
* one_wire_rom_address_t one_wire_device_list;
*
* // Configure default One Wire properties.
* one_wire_configure_default( &one_wire_object_1 );
*
* // Specify desired One Wire pin.
* one_wire_object_1.data_pin = MIKROBUS_1_PWM;
*
* // Allocate resources for One Wire protocol.
* if ( ONE_WIRE_SUCCESS != one_wire_open( &one_wire_object_1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
*
* // Skip sending ROM information of a device
* // (this device is the only one on One Wire bus).
* one_wire_skip_rom( &one_wire_object_1 );
*
* // Start temperature conversion of a device.
* one_wire_write_byte( &one_wire_object_1, &cmd_write_command, 1 );
*
* // Check temperature conversion status.
* if ( ONE_WIRE_SUCCESS != one_wire_read_byte( &one_wire_pin_1, &conversion_status, 1 ) ) {
* // Error handling strategy.
* return ONE_WIRE_ERROR; // To give an example...
* }
* @endcode
*/
err_t one_wire_read_byte( one_wire_t *obj, uint8_t *read_data_buffer, size_t read_data_length );
/*! @} */ // drvonewiregroup
/*! @} */ // drvgroup
/*! @} */ // pergroup
#ifdef __cplusplus
}
#endif
#endif // _DRV_ONE_WIRE_H_
// ------------------------------------------------------------------------- END