Register definitions for the AMS CCS811 digital gas sensor. More...

Detailed Description

Register definitions for the AMS CCS811 digital gas sensor.

Author: Gunar Schorcht gunar.nosp@m.@sch.nosp@m.orcht.nosp@m..net

Definition in file ccs811_regs.h.

Macros
#define	CCS811_HW_ID (0x81)
	CCS811 hardware ID.

CCS811 register addresses
#define	CCS811_REG_STATUS (0x00)

#define	CCS811_REG_MEAS_MODE (0x01)

#define	CCS811_REG_ALG_RESULT_DATA (0x02)

#define	CCS811_REG_RAW_DATA (0x03)

#define	CCS811_REG_ENV_DATA (0x05)

#define	CCS811_REG_NTC (0x06)

#define	CCS811_REG_THRESHOLDS (0x10)

#define	CCS811_REG_BASELINE (0x11)

#define	CCS811_REG_HW_ID (0x20)

#define	CCS811_REG_HW_VER (0x21)

#define	CCS811_REG_FW_BOOT_VER (0x23)

#define	CCS811_REG_FW_APP_VER (0x24)

#define	CCS811_REG_ERROR_ID (0xe0)

#define	CCS811_REG_APP_ERASE (0xf1)

#define	CCS811_REG_APP_DATA (0xf2)

#define	CCS811_REG_APP_VERIFY (0xf3)

#define	CCS811_REG_APP_START (0xf4)

#define	CCS811_REG_SW_RESET (0xff)

Status register bits (#CCS811_REG_STATUS)
#define	CCS811_STATUS_ERROR (0x01)
	error occurred, details in CCS811_REG_ERROR

#define	CCS811_STATUS_DATA_RDY (0x08)
	new data sample available in ALG_RESULT_DATA

#define	CCS811_STATUS_APP_VALID (0x10)
	valid application firmware loaded

#define	CCS811_STATUS_FW_MODE (0x80)
	firmware is in application mode

Error register bits (#CCS811_REG_ERROR_ID)
#define	CCS811_ERR_WRITE_REG_INV (0x01)
	invalid register address on write

#define	CCS811_ERR_READ_REG_INV (0x02)
	invalid register address on read

#define	CCS811_ERR_MEASMODE_INV (0x04)
	invalid requested measurement mode

#define	CCS811_ERR_MAX_RESISTANCE (0x08)
	maximum sensor resistance exceeded

#define	CCS811_ERR_HEATER_FAULT (0x10)
	heater current not in range

#define	CCS811_ERR_HEATER_SUPPLY (0x20)
	heater voltage not applied correctly

Macro Definition Documentation

◆ CCS811_ERR_HEATER_FAULT

#define CCS811_ERR_HEATER_FAULT (0x10)

heater current not in range

Definition at line 69 of file ccs811_regs.h.

◆ CCS811_ERR_HEATER_SUPPLY

#define CCS811_ERR_HEATER_SUPPLY (0x20)

heater voltage not applied correctly

Definition at line 70 of file ccs811_regs.h.

◆ CCS811_ERR_MAX_RESISTANCE

#define CCS811_ERR_MAX_RESISTANCE (0x08)

maximum sensor resistance exceeded

Definition at line 68 of file ccs811_regs.h.

◆ CCS811_ERR_MEASMODE_INV

#define CCS811_ERR_MEASMODE_INV (0x04)

invalid requested measurement mode

Definition at line 67 of file ccs811_regs.h.

◆ CCS811_ERR_READ_REG_INV

#define CCS811_ERR_READ_REG_INV (0x02)

invalid register address on read

Definition at line 66 of file ccs811_regs.h.

◆ CCS811_ERR_WRITE_REG_INV

#define CCS811_ERR_WRITE_REG_INV (0x01)

invalid register address on write

Definition at line 65 of file ccs811_regs.h.

◆ CCS811_HW_ID

#define CCS811_HW_ID (0x81)

CCS811 hardware ID.

Definition at line 74 of file ccs811_regs.h.

◆ CCS811_REG_ALG_RESULT_DATA

#define CCS811_REG_ALG_RESULT_DATA (0x02)

Definition at line 30 of file ccs811_regs.h.

◆ CCS811_REG_APP_DATA

#define CCS811_REG_APP_DATA (0xf2)

Definition at line 45 of file ccs811_regs.h.

◆ CCS811_REG_APP_ERASE

#define CCS811_REG_APP_ERASE (0xf1)

Definition at line 44 of file ccs811_regs.h.

◆ CCS811_REG_APP_START

#define CCS811_REG_APP_START (0xf4)

Definition at line 47 of file ccs811_regs.h.

◆ CCS811_REG_APP_VERIFY

#define CCS811_REG_APP_VERIFY (0xf3)

Definition at line 46 of file ccs811_regs.h.

◆ CCS811_REG_BASELINE

#define CCS811_REG_BASELINE (0x11)

Definition at line 35 of file ccs811_regs.h.

◆ CCS811_REG_ENV_DATA

#define CCS811_REG_ENV_DATA (0x05)

Definition at line 32 of file ccs811_regs.h.

◆ CCS811_REG_ERROR_ID

#define CCS811_REG_ERROR_ID (0xe0)

Definition at line 42 of file ccs811_regs.h.

◆ CCS811_REG_FW_APP_VER

#define CCS811_REG_FW_APP_VER (0x24)

Definition at line 40 of file ccs811_regs.h.

◆ CCS811_REG_FW_BOOT_VER

#define CCS811_REG_FW_BOOT_VER (0x23)

Definition at line 39 of file ccs811_regs.h.

◆ CCS811_REG_HW_ID

#define CCS811_REG_HW_ID (0x20)

Definition at line 37 of file ccs811_regs.h.

◆ CCS811_REG_HW_VER

#define CCS811_REG_HW_VER (0x21)

Definition at line 38 of file ccs811_regs.h.

◆ CCS811_REG_MEAS_MODE

#define CCS811_REG_MEAS_MODE (0x01)

Definition at line 29 of file ccs811_regs.h.

◆ CCS811_REG_NTC

#define CCS811_REG_NTC (0x06)

Definition at line 33 of file ccs811_regs.h.

◆ CCS811_REG_RAW_DATA

#define CCS811_REG_RAW_DATA (0x03)

Definition at line 31 of file ccs811_regs.h.

◆ CCS811_REG_STATUS

#define CCS811_REG_STATUS (0x00)

Definition at line 28 of file ccs811_regs.h.

◆ CCS811_REG_SW_RESET

#define CCS811_REG_SW_RESET (0xff)

Definition at line 48 of file ccs811_regs.h.

◆ CCS811_REG_THRESHOLDS

#define CCS811_REG_THRESHOLDS (0x10)

Definition at line 34 of file ccs811_regs.h.

◆ CCS811_STATUS_APP_VALID

#define CCS811_STATUS_APP_VALID (0x10)

valid application firmware loaded

Definition at line 57 of file ccs811_regs.h.

◆ CCS811_STATUS_DATA_RDY

#define CCS811_STATUS_DATA_RDY (0x08)

new data sample available in ALG_RESULT_DATA

Definition at line 56 of file ccs811_regs.h.

◆ CCS811_STATUS_ERROR

#define CCS811_STATUS_ERROR (0x01)

error occurred, details in CCS811_REG_ERROR

Definition at line 55 of file ccs811_regs.h.

◆ CCS811_STATUS_FW_MODE

#define CCS811_STATUS_FW_MODE (0x80)

firmware is in application mode

Definition at line 58 of file ccs811_regs.h.