Configuration

Configuration API of sensor.

Collaboration diagram for Configuration:

Configuration API of sensor.

bme68x_get_meas_dur

uint32_t bme68x_get_meas_dur(const uint8_t op_mode, struct bme68x_conf *conf, struct bme68x_dev *dev);

This API is used to get the remaining duration that can be used for heating.

Parameters

[in]	op_mode	: Desired operation mode.
[in]	conf	: Desired sensor configuration.
[in]	dev	: Structure instance of bme68x_dev

Returns

Measurement duration calculated in microseconds

bme68x_set_conf

int8_t bme68x_set_conf(struct bme68x_conf *conf, struct bme68x_dev *dev);

This API is used to set the oversampling, filter and odr configuration

Parameters

[in]	conf	: Desired sensor configuration.
[in,out]	dev	: Structure instance of bme68x_dev.

Returns

Result of API execution status

Return values

0	-> Success
<	0 -> Fail

bme68x_get_conf

int8_t bme68x_get_conf(struct bme68x_conf *conf, struct bme68x_dev *dev);

This API is used to get the oversampling, filter and odr configuration

Parameters

[out]	conf	: Present sensor configuration.
[in,out]	dev	: Structure instance of bme68x_dev.

Returns

Result of API execution status

Return values

0	-> Success
<	0 -> Fail

bme68x_set_heatr_conf

int8_t bme68x_set_heatr_conf(uint8_t op_mode, const struct bme68x_heatr_conf *conf, struct bme68x_dev *dev);

This API is used to set the gas configuration of the sensor.

Parameters

[in]	op_mode	: Expected operation mode of the sensor.
[in]	conf	: Desired heating configuration.
[in,out]	dev	: Structure instance of bme68x_dev.

Returns

Result of API execution status

Return values

0	-> Success
<	0 -> Fail

bme68x_get_heatr_conf

int8_t bme68x_get_heatr_conf(const struct bme68x_heatr_conf *conf, struct bme68x_dev *dev);

This API is used to get the gas configuration of the sensor.

Parameters

[out]	conf	: Current configurations of the gas sensor.
[in,out]	dev	: Structure instance of bme68x_dev.

Returns

Result of API execution status

Return values

0	-> Success
<	0 -> Fail