LibDriver MCP9600
Loading...
Searching...
No Matches
driver_mcp9600.h File Reference

driver mcp9600 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>
Include dependency graph for driver_mcp9600.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  mcp9600_handle_s
 mcp9600 handle structure definition More...
struct  mcp9600_info_s
 mcp9600 information structure definition More...

Macros

#define DRIVER_MCP9600_LINK_INIT(HANDLE, STRUCTURE)
 initialize mcp9600_handle_t structure
#define DRIVER_MCP9600_LINK_IIC_INIT(HANDLE, FUC)
 link iic_init function
#define DRIVER_MCP9600_LINK_IIC_DEINIT(HANDLE, FUC)
 link iic_deinit function
#define DRIVER_MCP9600_LINK_IIC_READ_COMMAND(HANDLE, FUC)
 link iic_read_cmd function
#define DRIVER_MCP9600_LINK_IIC_WRITE_COMMAND(HANDLE, FUC)
 link iic_write_cmd function
#define DRIVER_MCP9600_LINK_IIC_DELAY_MS(HANDLE, FUC)
 link delay_ms function
#define DRIVER_MCP9600_LINK_DEBUG_PRINT(HANDLE, FUC)
 link debug_print function

Typedefs

typedef struct mcp9600_handle_s mcp9600_handle_t
 mcp9600 handle structure definition
typedef struct mcp9600_info_s mcp9600_info_t
 mcp9600 information structure definition

Enumerations

enum  mcp9600_address_t { MCP9600_ADDRESS_0 = 0xC0 , MCP9600_ADDRESS_1 = 0xC2 }
 mcp9600 address enumeration definition More...
enum  mcp9600_cold_junction_resolution_t { MCP9600_COLD_JUNCTION_RESOLUTION_0P0625 = 0x00 , MCP9600_COLD_JUNCTION_RESOLUTION_0P25 = 0x01 }
 mcp9600 cold junction resolution enumeration definition More...
enum  mcp9600_adc_resolution_t { MCP9600_ADC_RESOLUTION_18_BIT = 0x00 , MCP9600_ADC_RESOLUTION_16_BIT = 0x01 , MCP9600_ADC_RESOLUTION_14_BIT = 0x02 , MCP9600_ADC_RESOLUTION_12_BIT = 0x03 }
 mcp9600 adc resolution enumeration definition More...
enum  mcp9600_burst_mode_sample_t {
  MCP9600_BURST_MODE_SAMPLE_1 = 0x00 , MCP9600_BURST_MODE_SAMPLE_2 = 0x01 , MCP9600_BURST_MODE_SAMPLE_4 = 0x02 , MCP9600_BURST_MODE_SAMPLE_8 = 0x03 ,
  MCP9600_BURST_MODE_SAMPLE_16 = 0x04 , MCP9600_BURST_MODE_SAMPLE_32 = 0x05 , MCP9600_BURST_MODE_SAMPLE_64 = 0x06 , MCP9600_BURST_MODE_SAMPLE_128 = 0x07
}
 mcp9600 burst mode sample enumeration definition More...
enum  mcp9600_mode_t { MCP9600_MODE_NORMAL = 0x00 , MCP9600_MODE_SHUTDOWN = 0x01 , MCP9600_MODE_BURST = 0x02 }
 mcp9600 mode enumeration definition More...
enum  mcp9600_thermocouple_type_t {
  MCP9600_THERMOCOUPLE_TYPE_K = 0x00 , MCP9600_THERMOCOUPLE_TYPE_J = 0x01 , MCP9600_THERMOCOUPLE_TYPE_T = 0x02 , MCP9600_THERMOCOUPLE_TYPE_N = 0x03 ,
  MCP9600_THERMOCOUPLE_TYPE_S = 0x04 , MCP9600_THERMOCOUPLE_TYPE_E = 0x05 , MCP9600_THERMOCOUPLE_TYPE_B = 0x06 , MCP9600_THERMOCOUPLE_TYPE_R = 0x07
}
 mcp9600 thermocouple type enumeration definition More...
enum  mcp9600_filter_coefficient_t {
  MCP9600_FILTER_COEFFICIENT_0 = 0x00 , MCP9600_FILTER_COEFFICIENT_1 = 0x01 , MCP9600_FILTER_COEFFICIENT_2 = 0x02 , MCP9600_FILTER_COEFFICIENT_3 = 0x03 ,
  MCP9600_FILTER_COEFFICIENT_4 = 0x04 , MCP9600_FILTER_COEFFICIENT_5 = 0x05 , MCP9600_FILTER_COEFFICIENT_6 = 0x06 , MCP9600_FILTER_COEFFICIENT_7 = 0x07
}
 mcp9600 filter coefficient enumeration definition More...
enum  mcp9600_alert_t { MCP9600_ALERT_1 = 0x00 , MCP9600_ALERT_2 = 0x01 , MCP9600_ALERT_3 = 0x02 , MCP9600_ALERT_4 = 0x03 }
 mcp9600 alert enumeration definition More...
enum  mcp9600_alert_status_t { MCP9600_ALERT_STATUS_LESS = 0x00 , MCP9600_ALERT_STATUS_OVER = 0x01 }
 mcp9600 alert status enumeration definition More...
enum  mcp9600_input_range_t { MCP9600_INPUT_RANGE_EXCEEDS = 0x01 , MCP9600_INPUT_RANGE_WITHIN = 0x00 }
 mcp9600 input range enumeration definition More...
enum  mcp9600_bool_t { MCP9600_BOOL_FALSE = 0x00 , MCP9600_BOOL_TRUE = 0x01 }
 mcp9600 bool enumeration definition More...
enum  mcp9600_temperature_maintain_detect_t { MCP9600_TEMPERATURE_MAINTAIN_DETECT_COLD_JUNCTION = 0x01 , MCP9600_TEMPERATURE_MAINTAIN_DETECT_HOT_JUNCTION = 0x00 }
 mcp9600 temperature maintain detect enumeration definition More...
enum  mcp9600_detect_edge_t { MCP9600_DETECT_EDGE_RISING = 0x00 , MCP9600_DETECT_EDGE_FALLING = 0x01 }
 mcp9600 detect edge enumeration definition More...
enum  mcp9600_active_level_t { MCP9600_ACTIVE_LEVEL_LOW = 0x00 , MCP9600_ACTIVE_LEVEL_HIGH = 0x01 }
 mcp9600 active level enumeration definition More...
enum  mcp9600_interrupt_mode_t { MCP9600_INTERRUPT_MODE_COMPARATOR = 0x00 , MCP9600_INTERRUPT_MODE_INTERRUPT = 0x01 }
 mcp9600 interrupt mode enumeration definition More...

Functions

uint8_t mcp9600_info (mcp9600_info_t *info)
 get chip information
uint8_t mcp9600_set_addr_pin (mcp9600_handle_t *handle, mcp9600_address_t addr_pin)
 set the iic address pin
uint8_t mcp9600_get_addr_pin (mcp9600_handle_t *handle, mcp9600_address_t *addr_pin)
 get the iic address pin
uint8_t mcp9600_init (mcp9600_handle_t *handle)
 initialize the chip
uint8_t mcp9600_deinit (mcp9600_handle_t *handle)
 close the chip
uint8_t mcp9600_start_continuous_read (mcp9600_handle_t *handle)
 start reading data
uint8_t mcp9600_stop_continuous_read (mcp9600_handle_t *handle)
 stop reading data
uint8_t mcp9600_continuous_read (mcp9600_handle_t *handle, int16_t *hot_raw, float *hot_s, int16_t *delta_raw, float *delta_s, int16_t *cold_raw, float *cold_s)
 read data continuously
uint8_t mcp9600_single_read (mcp9600_handle_t *handle, int16_t *hot_raw, float *hot_s, int16_t *delta_raw, float *delta_s, int16_t *cold_raw, float *cold_s)
 read data once
uint8_t mcp9600_get_hot_junction_temperature (mcp9600_handle_t *handle, int16_t *raw, float *s)
 get the hot junction temperature
uint8_t mcp9600_get_junction_thermocouple_delta (mcp9600_handle_t *handle, int16_t *raw, float *s)
 get the junction thermocouple delta
uint8_t mcp9600_get_cold_junction_temperature (mcp9600_handle_t *handle, int16_t *raw, float *s)
 get the cold junction temperature
uint8_t mcp9600_get_raw_adc (mcp9600_handle_t *handle, int32_t *raw, double *uv)
 get the raw adc
uint8_t mcp9600_set_filter_coefficient (mcp9600_handle_t *handle, mcp9600_filter_coefficient_t coefficient)
 set the filter coefficient
uint8_t mcp9600_get_filter_coefficient (mcp9600_handle_t *handle, mcp9600_filter_coefficient_t *coefficient)
 get the filter coefficient
uint8_t mcp9600_set_thermocouple_type (mcp9600_handle_t *handle, mcp9600_thermocouple_type_t type)
 set the thermocouple type
uint8_t mcp9600_get_thermocouple_type (mcp9600_handle_t *handle, mcp9600_thermocouple_type_t *type)
 get the thermocouple type
uint8_t mcp9600_get_status_burst_complete_flag (mcp9600_handle_t *handle, mcp9600_bool_t *status)
 get the burst complete status flag
uint8_t mcp9600_clear_status_burst_complete_flag (mcp9600_handle_t *handle)
 clear the burst complete status flag
uint8_t mcp9600_get_status_temperature_update_flag (mcp9600_handle_t *handle, mcp9600_bool_t *status)
 get the temperature update status flag
uint8_t mcp9600_clear_status_temperature_update_flag (mcp9600_handle_t *handle)
 clear the temperature update status flag
uint8_t mcp9600_get_status_input_range (mcp9600_handle_t *handle, mcp9600_input_range_t *range)
 get the input range status
uint8_t mcp9600_get_alert_status (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_alert_status_t *status)
 get the alert status
uint8_t mcp9600_set_cold_junction_resolution (mcp9600_handle_t *handle, mcp9600_cold_junction_resolution_t resolution)
 set the cold junction resolution
uint8_t mcp9600_get_cold_junction_resolution (mcp9600_handle_t *handle, mcp9600_cold_junction_resolution_t *resolution)
 get the cold junction resolution
uint8_t mcp9600_set_adc_resolution (mcp9600_handle_t *handle, mcp9600_adc_resolution_t resolution)
 set the adc resolution
uint8_t mcp9600_get_adc_resolution (mcp9600_handle_t *handle, mcp9600_adc_resolution_t *resolution)
 get the adc resolution
uint8_t mcp9600_set_burst_mode_sample (mcp9600_handle_t *handle, mcp9600_burst_mode_sample_t sample)
 set the burst mode sample
uint8_t mcp9600_get_burst_mode_sample (mcp9600_handle_t *handle, mcp9600_burst_mode_sample_t *sample)
 get the burst mode sample
uint8_t mcp9600_set_mode (mcp9600_handle_t *handle, mcp9600_mode_t mode)
 set the mode
uint8_t mcp9600_get_mode (mcp9600_handle_t *handle, mcp9600_mode_t *mode)
 get the mode
uint8_t mcp9600_alert_limit_convert_to_register (mcp9600_handle_t *handle, float c, int16_t *reg)
 convert the alert limit to the register raw data
uint8_t mcp9600_alert_limit_convert_to_data (mcp9600_handle_t *handle, int16_t reg, float *c)
 convert the register raw data to the alert limit
uint8_t mcp9600_set_alert_limit (mcp9600_handle_t *handle, mcp9600_alert_t alert, int16_t reg)
 set the alert limit
uint8_t mcp9600_get_alert_limit (mcp9600_handle_t *handle, mcp9600_alert_t alert, int16_t *reg)
 get the alert limit
uint8_t mcp9600_alert_hysteresis_convert_to_register (mcp9600_handle_t *handle, float c, uint8_t *reg)
 convert the alert hysteresis to the register raw data
uint8_t mcp9600_alert_hysteresis_convert_to_data (mcp9600_handle_t *handle, uint8_t reg, float *c)
 convert the register raw data to the alert hysteresis
uint8_t mcp9600_set_alert_hysteresis (mcp9600_handle_t *handle, mcp9600_alert_t alert, uint8_t reg)
 set the alert hysteresis
uint8_t mcp9600_get_alert_hysteresis (mcp9600_handle_t *handle, mcp9600_alert_t alert, uint8_t *reg)
 get the alert hysteresis
uint8_t mcp9600_clear_interrupt (mcp9600_handle_t *handle, mcp9600_alert_t alert)
 clear the interrupt flag
uint8_t mcp9600_get_interrupt (mcp9600_handle_t *handle, mcp9600_alert_t alert, uint8_t *status)
 get the interrupt flag
uint8_t mcp9600_set_temperature_maintain_detect (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_temperature_maintain_detect_t maintain_detect)
 set the temperature maintain detect
uint8_t mcp9600_get_temperature_maintain_detect (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_temperature_maintain_detect_t *maintain_detect)
 get the temperature maintain detect
uint8_t mcp9600_set_detect_edge (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_detect_edge_t edge)
 set the detect edge
uint8_t mcp9600_get_detect_edge (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_detect_edge_t *edge)
 get the detect edge
uint8_t mcp9600_set_active_level (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_active_level_t level)
 set the active level
uint8_t mcp9600_get_active_level (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_active_level_t *level)
 get the active level
uint8_t mcp9600_set_interrupt_mode (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_interrupt_mode_t mode)
 set the interrupt mode
uint8_t mcp9600_get_interrupt_mode (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_interrupt_mode_t *mode)
 get the interrupt mode
uint8_t mcp9600_set_alert_output (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_bool_t enable)
 set the alert output
uint8_t mcp9600_get_alert_output (mcp9600_handle_t *handle, mcp9600_alert_t alert, mcp9600_bool_t *enable)
 get the alert output
uint8_t mcp9600_get_device_id_revision (mcp9600_handle_t *handle, uint8_t *id, uint8_t *revision)
 get the device id and revision
uint8_t mcp9600_set_reg (mcp9600_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
 set the chip register
uint8_t mcp9600_get_reg (mcp9600_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
 get the chip register

Detailed Description

driver mcp9600 header file

Copyright (c) 2015 - present LibDriver All rights reserved

The MIT License (MIT)

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.

Version
1.0.0
Author
Shifeng Li
Date
2021-09-12

history

Date Version Author Description
2021/09/12 1.0 Shifeng Li first upload

Definition in file driver_mcp9600.h.