hal_one_wire.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 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.
**
****************************************************************************/
#ifndef _HAL_ONE_WIRE_H_
#define _HAL_ONE_WIRE_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "hal_target.h"
 
typedef struct {
    uint8_t address[8]; 
} hal_one_wire_rom_address_t;
 
typedef struct {
    hal_pin_name_t data_pin; 
    bool state; 
} hal_one_wire_t;
 
typedef enum {
    HAL_ONE_WIRE_SUCCESS = 0, 
    HAL_ONE_WIRE_ERROR = (-1) 
} hal_one_wire_err_t;
 
err_t hal_one_wire_open( hal_one_wire_t *obj );
 
void hal_one_wire_configure_default( hal_one_wire_t *obj );
 
err_t hal_one_wire_reset( hal_one_wire_t *obj );
 
err_t hal_one_wire_read_rom( hal_one_wire_t *obj, hal_one_wire_rom_address_t *device_rom_address );
 
err_t hal_one_wire_skip_rom( hal_one_wire_t *obj );
 
err_t hal_one_wire_match_rom( hal_one_wire_t *obj, hal_one_wire_rom_address_t *device_rom_address );
 
err_t hal_one_wire_search_first_device( hal_one_wire_t *obj, hal_one_wire_rom_address_t *one_wire_device_list );
 
err_t hal_one_wire_search_next_device( hal_one_wire_t *obj, hal_one_wire_rom_address_t *one_wire_device_list );
 
err_t hal_one_wire_write_byte( hal_one_wire_t *obj, uint8_t *write_data_buffer, size_t write_data_length );
 
err_t hal_one_wire_read_byte( hal_one_wire_t *obj, uint8_t *read_data_buffer, size_t read_data_length );
 
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 );
 
 // halonewiregroup
 // halgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _HAL_ONE_WIRE_H_
// ------------------------------------------------------------------------- END