NHS31xx SW API

Detailed Description

These 'defines' capture the diversity settings of the module. The displayed values refer to the default settings. To override the default settings, place the defines with their desired values in the board board_sel.h header file. The compiler will pick up your defines before parsing this file.

Macros

#define HUMID_CHIP_HTU21D   1
 
#define HUMID_CHIP_SHTC3   0
 
#define HUMID_I2C_HW   1
 
#define HUMID_I2C_BB   0
 
#define HUMID_POWER_PIN   6
 
#define HUMID_PULLUP_COUNT   0
 
#define HUMID_PULLUPS   NULL
 

Macro Definition Documentation

◆ HUMID_CHIP_HTU21D

#define HUMID_CHIP_HTU21D   1

Sensor chip selection for the HTU21D(F) RH/T SENSOR IC - Digital Relative Humidity sensor with Temperature output from TYCO ELECTRONICS. This option is mutually exclusive with HUMID_CHIP_SHTC3: exactly one must be non-zero. Set this to a non-zero value if the board has this sensor stuffed and if the firmware must address this sensor.

Note
only the functionality to read out the humidity is used.

◆ HUMID_CHIP_SHTC3

#define HUMID_CHIP_SHTC3   0

Sensor chip selection for the SHTC3 - Humidity and Temperature Sensor IC from SENSIRION This option is mutually exclusive with HUMID_CHIP_HTU21D: exactly one must be non-zero. Set this to a non-zero value if the board has this sensor stuffed and if the firmware must address this sensor.

Note
only the functionality to read out the humidity is used.

◆ HUMID_I2C_HW

#define HUMID_I2C_HW   1

Bus interface selection. This option is mutually exclusive with HUMID_I2C_BB: exactly one must be defined. When set to a non-zero value the I2C HW block will be used by this module for I2C communication.

◆ HUMID_I2C_BB

#define HUMID_I2C_BB   0

Bus interface selection. This option is mutually exclusive with HUMID_I2C_HW: exactly one must be defined. When set to a non-zero value the i2cbbm module will be used by this module for I2C communication.

Note
When this define is made, the module i2cbbm must also be included in the project.
When this define is made, the pins used for communication are to be defined in the i2cbbm module.

◆ HUMID_POWER_PIN

#define HUMID_POWER_PIN   6

The IOCON pin number that is used to power the humidity sensor. This pin on the NHS3100 is connected with the supply pin VDD on the humidity sensor.

◆ HUMID_PULLUP_COUNT

#define HUMID_PULLUP_COUNT   0

The number of GPIO's that are used as pull-up for the I2C lines. Must match the length of HUMID_PULLUPS.

Note
When HUMID_I2C_BB is defined, you can define I2CBBM_PULLUP_COUNT and I2CBBM_PULLUPS instead.

◆ HUMID_PULLUPS

#define HUMID_PULLUPS   NULL

The GPIO's used as pull-up for the I2C lines. Refers to an array of type uint32_t with size HUMID_PULLUP_COUNT.

Note
There is no need to list the GPIO's used for the clock and data lines here. If these pins have pull-up capabilities, it will be used regardless of what is listed here.
When HUMID_I2C_BB is defined, you can define I2CBBM_PULLUP_COUNT and I2CBBM_PULLUPS instead.