File xensiv_pas_gas.h

↰ Parent directory (src/corelib)

Definition (src/corelib/xensiv_pas_gas.h)

• Program Listing for File xensiv_pas_gas.h

Detailed Description

Description: This file contains the functions for interacting with the XENSIV™ PAS GAS sensor.

Copyright 2021-2022 Infineon Technologies AG SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Includes

• stdbool.h

• stddef.h

• stdint.h

• xensiv_pas_gas_platform.h (File xensiv_pas_gas_platform.h)

• xensiv_pas_gas_regs.h (File xensiv_pas_gas_regs.h)

Included By

• File xensiv_pas_gas.c

• File xensiv_pas_gas_a2l.h

• File xensiv_pas_gas_co2.h

• File xensiv_pas_gas_r290.h

• File xensiv_pas_gas_ino.hpp

• File xensiv_pas_gas_pal_ino.cpp

Classes

• Struct xensiv_pas_gas_s

Enums

• Enum xensiv_pas_gas_alarm_type_t

• Enum xensiv_pas_gas_boc_cfg_t

• Enum xensiv_pas_gas_cmd_t

• Enum xensiv_pas_gas_interface_t

• Enum xensiv_pas_gas_interrupt_function_t

• Enum xensiv_pas_gas_interrupt_type_t

• Enum xensiv_pas_gas_op_mode_t

Functions

• Function xensiv_pas_gas_clear_measurement_status(const xensiv_pas_gas_t *, uint8_t)

• Function xensiv_pas_gas_clear_status(const xensiv_pas_gas_t *, uint8_t)

• Function xensiv_pas_gas_cmd(const xensiv_pas_gas_t *, xensiv_pas_gas_cmd_t)

• Function xensiv_pas_gas_get_id(const xensiv_pas_gas_t *, xensiv_pas_gas_id_t *)

• Function xensiv_pas_gas_get_interrupt_config(const xensiv_pas_gas_t *, xensiv_pas_gas_interrupt_config_t *)

• Function xensiv_pas_gas_get_measurement_config(const xensiv_pas_gas_t *, xensiv_pas_gas_measurement_config_t *)

• Function xensiv_pas_gas_get_measurement_status(const xensiv_pas_gas_t *, xensiv_pas_gas_meas_status_t *)

• Function xensiv_pas_gas_get_reg(const xensiv_pas_gas_t *, uint8_t, uint8_t *, uint8_t)

• Function xensiv_pas_gas_get_result(const xensiv_pas_gas_t *, uint16_t *)

• Function xensiv_pas_gas_get_scratch_pad(const xensiv_pas_gas_t *, uint8_t *)

• Function xensiv_pas_gas_get_status(const xensiv_pas_gas_t *, xensiv_pas_gas_status_t *)

• Function xensiv_pas_gas_init

• Function xensiv_pas_gas_perform_forced_compensation(const xensiv_pas_gas_t *, uint16_t)

• Function xensiv_pas_gas_set_alarm_threshold(const xensiv_pas_gas_t *, uint16_t)

• Function xensiv_pas_gas_set_interrupt_config(const xensiv_pas_gas_t *, xensiv_pas_gas_interrupt_config_t)

• Function xensiv_pas_gas_set_measurement_config(const xensiv_pas_gas_t *, xensiv_pas_gas_measurement_config_t)

• Function xensiv_pas_gas_set_measurement_rate(const xensiv_pas_gas_t *, uint16_t)

• Function xensiv_pas_gas_set_offset_compensation(const xensiv_pas_gas_t *, uint16_t)

• Function xensiv_pas_gas_set_pressure_compensation(const xensiv_pas_gas_t *, uint16_t)

• Function xensiv_pas_gas_set_reg(const xensiv_pas_gas_t *, uint8_t, const uint8_t *, uint8_t)

• Function xensiv_pas_gas_set_scratch_pad(const xensiv_pas_gas_t *, uint8_t)

• Function xensiv_pas_gas_start_continuous_mode(const xensiv_pas_gas_t *, uint16_t)

• Function xensiv_pas_gas_start_single_mode(const xensiv_pas_gas_t *)

Defines

• Define XENSIV_PAS_GAS_ERR_COMM

• Define XENSIV_PAS_GAS_ERR_NOT_READY

• Define XENSIV_PAS_GAS_ERR_WRITE_TOO_LARGE

• Define XENSIV_PAS_GAS_I2C_ADDR

• Define XENSIV_PAS_GAS_ICCERR

• Define XENSIV_PAS_GAS_INVALID_PARAMETER

• Define XENSIV_PAS_GAS_INVALID_SENSOR_INTERFACE

• Define XENSIV_PAS_GAS_MEAS_RATE_MAX

• Define XENSIV_PAS_GAS_MEAS_RATE_MIN

• Define XENSIV_PAS_GAS_OK

• Define XENSIV_PAS_GAS_ORTMP

• Define XENSIV_PAS_GAS_ORVS

• Define XENSIV_PAS_GAS_READ_NRDY

Typedefs

• Typedef xensiv_pas_gas_fcs_fptr_t

• Typedef xensiv_pas_gas_read_fptr_t

• Typedef xensiv_pas_gas_t

• Typedef xensiv_pas_gas_write_fptr_t

Unions

• Union xensiv_pas_gas_id_t

• Union xensiv_pas_gas_interrupt_config_t

• Union xensiv_pas_gas_meas_status_t

• Union xensiv_pas_gas_measurement_config_t

• Union xensiv_pas_gas_status_t