This file contains API for HW Monitor Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Data Structures
struct	hwmonitor_t
	HW Monitor Click context object. More...

struct	hwmonitor_cfg_t
	HW Monitor Click configuration object. More...

struct	hwmonitor_config_t
	HW Monitor Click configuration object. More...

Macros
#define	HWMONITOR_REG_CONFIGURATION 0x00
	HW Monitor description register.

#define	HWMONITOR_REG_INT_STATUS_1 0x01

#define	HWMONITOR_REG_INT_STATUS_2 0x02

#define	HWMONITOR_REG_INT_MASK_1 0x03

#define	HWMONITOR_REG_INT_MASK_2 0x04

#define	HWMONITOR_REG_FAN_DIVISOR 0x05

#define	HWMONITOR_REG_OS_T_RES_CONFIG 0x06

#define	HWMONITOR_REG_CONVERSION_RATE 0x07

#define	HWMONITOR_REG_CHANNEL_DISABLE 0x08

#define	HWMONITOR_REG_RAM_IN_0 0x20

#define	HWMONITOR_REG_RAM_IN_1 0x21

#define	HWMONITOR_REG_RAM_IN_2 0x22

#define	HWMONITOR_REG_RAM_IN_3 0x23

#define	HWMONITOR_REG_RAM_IN_4 0x24

#define	HWMONITOR_REG_RAM_IN_5 0x25

#define	HWMONITOR_REG_RAM_IN_6 0x26

#define	HWMONITOR_REG_RAM_TEMPERATURE 0x27

#define	HWMONITOR_REG_RAM_FAN_1 0x28

#define	HWMONITOR_REG_RAM_FAN_2 0x29

#define	HWMONITOR_REG_RAM_LIM_IN_0_H 0x2A

#define	HWMONITOR_REG_RAM_LIM_IN_0_L 0x2B

#define	HWMONITOR_REG_RAM_LIM_IN_1_H 0x2C

#define	HWMONITOR_REG_RAM_LIM_IN_1_L 0x2D

#define	HWMONITOR_REG_RAM_LIM_IN_2_H 0x2E

#define	HWMONITOR_REG_RAM_LIM_IN_2_L 0x2F

#define	HWMONITOR_REG_RAM_LIM_IN_3_H 0x30

#define	HWMONITOR_REG_RAM_LIM_IN_3_L 0x31

#define	HWMONITOR_REG_RAM_LIM_IN_4_H 0x32

#define	HWMONITOR_REG_RAM_LIM_IN_4_L 0x33

#define	HWMONITOR_REG_RAM_LIM_IN_5_H 0x34

#define	HWMONITOR_REG_RAM_LIM_IN_5_L 0x35

#define	HWMONITOR_REG_RAM_LIM_IN_6_H 0x36

#define	HWMONITOR_REG_RAM_LIM_IN_6_L 0x37

#define	HWMONITOR_REG_RAM_LIM_HOT_H 0x38

#define	HWMONITOR_REG_RAM_LIM_HOT_L 0x39

#define	HWMONITOR_REG_RAM_LIM_TEMP_H 0x3A

#define	HWMONITOR_REG_RAM_LIM_TEMP_L 0x3B

#define	HWMONITOR_REG_RAM_CURRENT_LIM_FUN_1 0x3C

#define	HWMONITOR_REG_RAM_CURRENT_LIM_FUN_2 0x3D

#define	HWMONITOR_REG_RAM_MANUFACTURE_ID 0x3E

#define	HWMONITOR_REG_RAM_REVISION_ID 0x3F

#define	HWMONITOR_SET_CONFIG_START_DIS 0x00
	HW Monitor description HWMONITOR_REG_CONFIGURATION register value.

#define	HWMONITOR_SET_CONFIG_START_EN 0x01

#define	HWMONITOR_SET_CONFIG_INT_DIS 0x00

#define	HWMONITOR_SET_CONFIG_INT_EN 0x01

#define	HWMONITOR_SET_CONFIG_INT_OPEN_DRAIN 0x00

#define	HWMONITOR_SET_CONFIG_INT_ACT_LOW 0x01

#define	HWMONITOR_SET_CONFIG_INT_CLR_DIS 0x00

#define	HWMONITOR_SET_CONFIG_INT_CLR_EN 0x01

#define	HWMONITOR_SET_CONFIG_CHA_NCLR_GPI 0x00

#define	HWMONITOR_SET_CONFIG_CHA_GPI 0x01

#define	HWMONITOR_SET_CONFIG_GPO_LOW 0x00

#define	HWMONITOR_SET_CONFIG_GPO_HIGH 0x01

#define	HWMONITOR_SET_CONFIG_PWR_ON 0x00

#define	HWMONITOR_SET_CONFIG_PWR_DIS 0x01

#define	HWMONITOR_SET_FAN1_MODE_COUNT 0x00
	HW Monitor description HWMONITOR_REG_FAN_DIVISOR register value.

#define	HWMONITOR_SET_FAN1_MODE_SENS_INPUT 0x01

#define	HWMONITOR_SET_FAN2_MODE_COUNT 0x00

#define	HWMONITOR_SET_FAN2_MODE_SENS_INPUT 0x02

#define	HWMONITOR_SET_FAN1_CTRL_SPEED_DIV1 0x00

#define	HWMONITOR_SET_FAN1_CTRL_SPEED_DIV2 0x04

#define	HWMONITOR_SET_FAN1_CTRL_SPEED_DIV4 0x08

#define	HWMONITOR_SET_FAN1_CTRL_SPEED_DIV8 0x0C

#define	HWMONITOR_SET_FAN2_CTRL_SPEED_DIV1 0x00

#define	HWMONITOR_SET_FAN2_CTRL_SPEED_DIV2 0x10

#define	HWMONITOR_SET_FAN2_CTRL_SPEED_DIV4 0x20

#define	HWMONITOR_SET_FAN2_CTRL_SPEED_DIV8 0x30

#define	HWMONITOR_SET_MODE_OS_DISABLE 0x00

#define	HWMONITOR_SET_MODE_OS_ENABLE 0x01

#define	HWMONITOR_SET_MODE_RST_DISABLE 0x00

#define	HWMONITOR_SET_MODE_RST_ENABLE 0x01

#define	HWMONITOR_SET_TEMP_RES_8_bit 0x00
	HW Monitor description temperature resolution control data.

#define	HWMONITOR_SET_TEMP_RES_11_bit 0x01

#define	HWMONITOR_TEMP_RES_11_bit_BIT_MASK 0x08

#define	HWMONITOR_SET_ALL_CH_ENABLE 0x00
	HW Monitor description HWMONITOR_REG_CHANNEL_DISABLE register value.

#define	HWMONITOR_SET_ALL_CH_DISABLE 0xFF

#define	HWMONITOR_MANUFACTURERS_ID 0x01
	HW Monitor description device ID data.

#define	HWMONITOR_STEPPING_DIE_REVISION_ID 0x08

#define	HWMONITOR_IN_0 0
	HW Monitor channel selection setting.

#define	HWMONITOR_IN_1 1

#define	HWMONITOR_IN_2 2

#define	HWMONITOR_IN_3 3

#define	HWMONITOR_IN_4 4

#define	HWMONITOR_IN_5 5

#define	HWMONITOR_IN_6 6

#define	HWMONITOR_FAN_1 0

#define	HWMONITOR_FAN_2 1

#define	HWMONITOR_DEVICE_ADDRESS_0 0x28
	HW Monitor device address setting.

#define	HWMONITOR_DEVICE_ADDRESS_1 0x29

#define	HWMONITOR_DEVICE_ADDRESS_2 0x2A

#define	HWMONITOR_DEVICE_ADDRESS_3 0x2B

#define	HWMONITOR_DEVICE_ADDRESS_4 0x2C

#define	HWMONITOR_DEVICE_ADDRESS_5 0x2D

#define	HWMONITOR_DEVICE_ADDRESS_6 0x2E

#define	HWMONITOR_DEVICE_ADDRESS_7 0x2F

#define	HWMONITOR_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	hwmonitor_return_value_t { HWMONITOR_OK = 0 , HWMONITOR_ERROR = -1 }
	HW Monitor Click return value data. More...

Functions
void	hwmonitor_cfg_setup (hwmonitor_cfg_t *cfg)
	HW Monitor configuration object setup function.

err_t	hwmonitor_init (hwmonitor_t ctx, hwmonitor_cfg_t cfg)
	HW Monitor initialization function.

err_t	hwmonitor_default_cfg (hwmonitor_t *ctx)
	HW Monitor default configuration function.

err_t	hwmonitor_generic_write (hwmonitor_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	HW Monitor I2C writing function.

err_t	hwmonitor_generic_read (hwmonitor_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	HW Monitor I2C reading function.

void	hwmonitor_reset (hwmonitor_t *ctx)
	HW Monitor reset function.

err_t	hwmonitor_get_config (hwmonitor_t ctx, hwmonitor_config_t config)
	HW Monitor gets configuration function.

err_t	hwmonitor_set_config (hwmonitor_t *ctx, hwmonitor_config_t config)
	HW Monitor set the configuration function.

err_t	hwmonitor_get_device_id (hwmonitor_t ctx, uint8_t manufacture_id, uint8_t *revision_id)
	HW Monitor gets device ID function.

err_t	hwmonitor_set_temp_res (hwmonitor_t *ctx, uint8_t temp_res)
	HW Monitor set temperature resolution function.

err_t	hwmonitor_set_ch_out (hwmonitor_t *ctx, uint8_t ch_out)
	HW Monitor set voltage/temperature channel function.

err_t	hwmonitor_get_temperature (hwmonitor_t ctx, float temperature)
	HW Monitor gets temperature function.

err_t	hwmonitor_get_analog_inputs (hwmonitor_t ctx, uint8_t in_pos, float voltage)
	HW Monitor gets analog inputs voltage function.

err_t	hwmonitor_get_fan_output (hwmonitor_t ctx, uint8_t fan_pos, uint8_t fan_output)
	HW Monitor gets FAN output function.

err_t	hwmonitor_set_analog_in_limit (hwmonitor_t *ctx, uint8_t in_pos, uint16_t upper_limit, uint16_t lower_limit)
	HW Monitor set analog inputs voltage limits function.

uint8_t	hwmonitor_get_int_pin (hwmonitor_t *ctx)
	HW Monitor gets interrupt function.

Detailed Description

This file contains API for HW Monitor Click Driver.

Enumeration Type Documentation

◆ hwmonitor_return_value_t

enum hwmonitor_return_value_t

HW Monitor Click return value data.

Predefined enum values for driver return values.

Enumerator
HWMONITOR_OK
HWMONITOR_ERROR

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ hwmonitor_return_value_t