Component Library:Sensor Driver for NMH1000  v1.0
Platform agnostic sensor driver interfaces for NMH1000 sensor
nmh1000_regdef.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

union  NMH1000_STATUS_t
 
union  NMH1000_CONTROL_REG1_t
 
union  NMH1000_USER_ODR_t
 

Macros

#define NMH1000_STATUS_OUT_B_MASK   ((uint8_t) 0x01)
 
#define NMH1000_STATUS_OUT_B_SHIFT   ((uint8_t) 0)
 
#define NMH1000_STATUS_RST_STAT_MASK   ((uint8_t) 0x02)
 
#define NMH1000_STATUS_RST_STAT_SHIFT   ((uint8_t) 1)
 
#define NMH1000_STATUS_OPMODE_MASK   ((uint8_t) 0x08)
 
#define NMH1000_STATUS_OPMODE_SHIFT   ((uint8_t) 3)
 
#define NMH1000_STATUS_MDR_MASK   ((uint8_t) 0x20)
 
#define NMH1000_STATUS_MDR_SHIFT   ((uint8_t) 5)
 
#define NMH1000_STATUS_MDO_MASK   ((uint8_t) 0x40)
 
#define NMH1000_STATUS_MDO_SHIFT   ((uint8_t) 6)
 
#define NMH1000_STATUS_OUTPUT_MASK   ((uint8_t) 0x80)
 
#define NMH1000_STATUS_OUTPUT_SHIFT   ((uint8_t) 7)
 
#define NMH1000_STATUS_OUT_B_CLEARED   ((uint8_t) 0x00) /* OUT Cleared on previous cycle. */
 
#define NMH1000_STATUS_OUT_B_ASSERTED   ((uint8_t) 0x01) /* OUT asserted on previous cycle. */
 
#define NMH1000_STATUS_RST_STAT_RST_SEQ_COMPLETED   ((uint8_t) 0x00) /* Reset sequence complete and read operation */
 
#define NMH1000_STATUS_RST_STAT_RST_SEQ_NOT_COMPLETED   ((uint8_t) 0x02) /* Reset sequence not complete. Result of Reset. */
 
#define NMH1000_STATUS_OPMODE_STATE_MACHINE_FAULT   ((uint8_t) 0x00) /* ndicates VPP < VSTAND and the device in */
 
#define NMH1000_STATUS_OPMODE_USER_MODE   ((uint8_t) 0x08) /* Indicates VPP >= VSTAND and the device in I2C User */
 
#define NMH1000_STATUS_MDR_DATA_AVAILABLE   ((uint8_t) 0x00) /* $03 data available. */
 
#define NMH1000_STATUS_MDR_DATA_NOT_AVAILABLE   ((uint8_t) 0x20) /* $03 data not available. Result of Reset. */
 
#define NMH1000_STATUS_MDO_VALIDITY_IN_RANGE   ((uint8_t) 0x00) /* Register $03 value is within the range $00 to $1F. */
 
#define NMH1000_STATUS_MDO_VALIDITY_OUT_OF_RANGE   ((uint8_t) 0x40) /* Register $03 value is >$1F indicating out-of-range */
 
#define NMH1000_STATUS_OUTPUT_VOUT_DRIVEN_TO_VOL   ((uint8_t) 0x00) /* The state of VOUT is driven to VOL; Result of */
 
#define NMH1000_STATUS_OUTPUT_VOUT_DRIVEN_TO_VOH   ((uint8_t) 0x80) /* The state of VOUT is driven to VOH. */
 
#define NMH1000_CONTROL_REG1_RST_MASK   ((uint8_t) 0x01)
 
#define NMH1000_CONTROL_REG1_RST_SHIFT   ((uint8_t) 0)
 
#define NMH1000_CONTROL_REG1_ONE_SHORT_MASK   ((uint8_t) 0x04)
 
#define NMH1000_CONTROL_REG1_ONE_SHORT_SHIFT   ((uint8_t) 2)
 
#define NMH1000_CONTROL_REG1_AUTO_MODE_MASK   ((uint8_t) 0x08)
 
#define NMH1000_CONTROL_REG1_AUTO_MODE_SHIFT   ((uint8_t) 3)
 
#define NMH1000_CONTROL_REG1_I2C_DIS_MASK   ((uint8_t) 0x10)
 
#define NMH1000_CONTROL_REG1_I2C_DIS_SHIFT   ((uint8_t) 4)
 
#define NMH1000_CONTROL_REG1_V_POL_MASK   ((uint8_t) 0x20)
 
#define NMH1000_CONTROL_REG1_V_POL_SHIFT   ((uint8_t) 5)
 
#define NMH1000_CONTROL_REG1_RST_NO_RESET   ((uint8_t) 0x00) /* No reset is forced. */
 
#define NMH1000_CONTROL_REG1_RST_RESET   ((uint8_t) 0x01) /* Internal device reset is be forced. */
 
#define NMH1000_CONTROL_REG1_ONE_SHORT_EN   ((uint8_t) 0x04) /* Trigger a One-Shot sequence. */
 
#define NMH1000_CONTROL_REG1_AUTO_MODE_HALT   ((uint8_t) 0x00) /* Halts or prevents Autonomous mode. */
 
#define NMH1000_CONTROL_REG1_AUTO_MODE_START   ((uint8_t) 0x08) /* Start the Autonomous mode. */
 
#define NMH1000_CONTROL_REG1_I2C_DIS_STANDALONE_MODE   ((uint8_t) 0x10) /* force the device into i2c standalone mode. */
 
#define NMH1000_CONTROL_REG1_V_POL_ASSERT_VOH_CLR_VOL   ((uint8_t) 0x00) /* Assert = VOH, Clear = VOL; Result of Reset */
 
#define NMH1000_CONTROL_REG1_V_POL_ASSERT_VOL_CLR_VOH   ((uint8_t) 0x20) /* Assert = VOL, Clear = VOH. */
 
#define NMH1000_USER_ODR_ODR_MASK   ((uint8_t) 0x07)
 
#define NMH1000_USER_ODR_ODR_SHIFT   ((uint8_t) 0)
 
#define NMH1000_USER_ODR_ODR_LSP   ((uint8_t) 0x00) /* Low sample rate selected */
 
#define NMH1000_USER_ODR_ODR_5X_LSP   ((uint8_t) 0x01) /* 5*Low sample rate selected */
 
#define NMH1000_USER_ODR_ODR_MSP   ((uint8_t) 0x02) /* Medium sample rate selected */
 
#define NMH1000_USER_ODR_ODR_HSP   ((uint8_t) 0x04) /* High sample rate selected */
 
#define NMH1000_USER_ODR_ODR_5X_HSP   ((uint8_t) 0x05) /* 5*High sample rate selected */
 
#define NMH1000_USER_ODR_ODR_10X_HSP   ((uint8_t) 0x06) /* 10*High sample rate selected */
 
#define NMH1000_USER_ODR_ODR_CONFIG_ERR   ((uint8_t) 0x07) /* Coniguration error */
 

Typedefs

typedef uint8_t NMH1000_RESERVED_REG_1_t
 
typedef uint8_t NMH1000_OUT_M_REG_t
 
typedef uint8_t NMH1000_USER_ASSERT_THRESH_t
 
typedef uint8_t NMH1000_USER_CLEAR_THRESH_t
 
typedef uint8_t NMH1000_RESERVED_REG_2_t
 
typedef uint8_t NMH1000_WHO_AM_I_t
 

Enumerations

enum  {
  NMH1000_STATUS = 0x00, NMH1000_CONTROL_REG1 = 0x01, NMH1000_RESERVED1 = 0x02, NMH1000_OUT_M_REG = 0x03,
  NMH1000_USER_ASSERT_THRESH = 0x04, NMH1000_USER_CLEAR_THRESH = 0x05, NMH1000_ODR = 0x06, NMH1000_RESERVED2 = 0x07,
  NMH1000_WHO_AM_I = 0x08, NMH1000_I2C_ADDR = 0x09
}
 The nmh1000_regdef.h file contains the register definitions for NMH1000 sensor. More...
 

Macro Definition Documentation

◆ NMH1000_CONTROL_REG1_AUTO_MODE_HALT

#define NMH1000_CONTROL_REG1_AUTO_MODE_HALT   ((uint8_t) 0x00) /* Halts or prevents Autonomous mode. */

Definition at line 191 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_AUTO_MODE_MASK

#define NMH1000_CONTROL_REG1_AUTO_MODE_MASK   ((uint8_t) 0x08)

Definition at line 175 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_AUTO_MODE_SHIFT

#define NMH1000_CONTROL_REG1_AUTO_MODE_SHIFT   ((uint8_t) 3)

Definition at line 176 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_AUTO_MODE_START

#define NMH1000_CONTROL_REG1_AUTO_MODE_START   ((uint8_t) 0x08) /* Start the Autonomous mode. */

Definition at line 192 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_I2C_DIS_MASK

#define NMH1000_CONTROL_REG1_I2C_DIS_MASK   ((uint8_t) 0x10)

Definition at line 178 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_I2C_DIS_SHIFT

#define NMH1000_CONTROL_REG1_I2C_DIS_SHIFT   ((uint8_t) 4)

Definition at line 179 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_I2C_DIS_STANDALONE_MODE

#define NMH1000_CONTROL_REG1_I2C_DIS_STANDALONE_MODE   ((uint8_t) 0x10) /* force the device into i2c standalone mode. */

Definition at line 193 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_ONE_SHORT_EN

#define NMH1000_CONTROL_REG1_ONE_SHORT_EN   ((uint8_t) 0x04) /* Trigger a One-Shot sequence. */

Definition at line 190 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_ONE_SHORT_MASK

#define NMH1000_CONTROL_REG1_ONE_SHORT_MASK   ((uint8_t) 0x04)

Definition at line 172 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_ONE_SHORT_SHIFT

#define NMH1000_CONTROL_REG1_ONE_SHORT_SHIFT   ((uint8_t) 2)

Definition at line 173 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_RST_MASK

#define NMH1000_CONTROL_REG1_RST_MASK   ((uint8_t) 0x01)

Definition at line 169 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_RST_NO_RESET

#define NMH1000_CONTROL_REG1_RST_NO_RESET   ((uint8_t) 0x00) /* No reset is forced. */

Definition at line 188 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_RST_RESET

#define NMH1000_CONTROL_REG1_RST_RESET   ((uint8_t) 0x01) /* Internal device reset is be forced. */

Definition at line 189 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_RST_SHIFT

#define NMH1000_CONTROL_REG1_RST_SHIFT   ((uint8_t) 0)

Definition at line 170 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_V_POL_ASSERT_VOH_CLR_VOL

#define NMH1000_CONTROL_REG1_V_POL_ASSERT_VOH_CLR_VOL   ((uint8_t) 0x00) /* Assert = VOH, Clear = VOL; Result of Reset */

Definition at line 194 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_V_POL_ASSERT_VOL_CLR_VOH

#define NMH1000_CONTROL_REG1_V_POL_ASSERT_VOL_CLR_VOH   ((uint8_t) 0x20) /* Assert = VOL, Clear = VOH. */

Definition at line 195 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_V_POL_MASK

#define NMH1000_CONTROL_REG1_V_POL_MASK   ((uint8_t) 0x20)

Definition at line 181 of file nmh1000_regdef.h.

◆ NMH1000_CONTROL_REG1_V_POL_SHIFT

#define NMH1000_CONTROL_REG1_V_POL_SHIFT   ((uint8_t) 5)

Definition at line 182 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_MDO_MASK

#define NMH1000_STATUS_MDO_MASK   ((uint8_t) 0x40)

Definition at line 101 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_MDO_SHIFT

#define NMH1000_STATUS_MDO_SHIFT   ((uint8_t) 6)

Definition at line 102 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_MDO_VALIDITY_IN_RANGE

#define NMH1000_STATUS_MDO_VALIDITY_IN_RANGE   ((uint8_t) 0x00) /* Register $03 value is within the range $00 to $1F. */

Definition at line 124 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_MDO_VALIDITY_OUT_OF_RANGE

#define NMH1000_STATUS_MDO_VALIDITY_OUT_OF_RANGE   ((uint8_t) 0x40) /* Register $03 value is >$1F indicating out-of-range */

Definition at line 125 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_MDR_DATA_AVAILABLE

#define NMH1000_STATUS_MDR_DATA_AVAILABLE   ((uint8_t) 0x00) /* $03 data available. */

Definition at line 122 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_MDR_DATA_NOT_AVAILABLE

#define NMH1000_STATUS_MDR_DATA_NOT_AVAILABLE   ((uint8_t) 0x20) /* $03 data not available. Result of Reset. */

Definition at line 123 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_MDR_MASK

#define NMH1000_STATUS_MDR_MASK   ((uint8_t) 0x20)

Definition at line 98 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_MDR_SHIFT

#define NMH1000_STATUS_MDR_SHIFT   ((uint8_t) 5)

Definition at line 99 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OPMODE_MASK

#define NMH1000_STATUS_OPMODE_MASK   ((uint8_t) 0x08)

Definition at line 95 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OPMODE_SHIFT

#define NMH1000_STATUS_OPMODE_SHIFT   ((uint8_t) 3)

Definition at line 96 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OPMODE_STATE_MACHINE_FAULT

#define NMH1000_STATUS_OPMODE_STATE_MACHINE_FAULT   ((uint8_t) 0x00) /* ndicates VPP < VSTAND and the device in */

Definition at line 116 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OPMODE_USER_MODE

#define NMH1000_STATUS_OPMODE_USER_MODE   ((uint8_t) 0x08) /* Indicates VPP >= VSTAND and the device in I2C User */

Definition at line 120 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OUT_B_ASSERTED

#define NMH1000_STATUS_OUT_B_ASSERTED   ((uint8_t) 0x01) /* OUT asserted on previous cycle. */

Definition at line 112 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OUT_B_CLEARED

#define NMH1000_STATUS_OUT_B_CLEARED   ((uint8_t) 0x00) /* OUT Cleared on previous cycle. */

Definition at line 111 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OUT_B_MASK

#define NMH1000_STATUS_OUT_B_MASK   ((uint8_t) 0x01)

Definition at line 89 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OUT_B_SHIFT

#define NMH1000_STATUS_OUT_B_SHIFT   ((uint8_t) 0)

Definition at line 90 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OUTPUT_MASK

#define NMH1000_STATUS_OUTPUT_MASK   ((uint8_t) 0x80)

Definition at line 104 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OUTPUT_SHIFT

#define NMH1000_STATUS_OUTPUT_SHIFT   ((uint8_t) 7)

Definition at line 105 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OUTPUT_VOUT_DRIVEN_TO_VOH

#define NMH1000_STATUS_OUTPUT_VOUT_DRIVEN_TO_VOH   ((uint8_t) 0x80) /* The state of VOUT is driven to VOH. */

Definition at line 129 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_OUTPUT_VOUT_DRIVEN_TO_VOL

#define NMH1000_STATUS_OUTPUT_VOUT_DRIVEN_TO_VOL   ((uint8_t) 0x00) /* The state of VOUT is driven to VOL; Result of */

Definition at line 127 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_RST_STAT_MASK

#define NMH1000_STATUS_RST_STAT_MASK   ((uint8_t) 0x02)

Definition at line 92 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_RST_STAT_RST_SEQ_COMPLETED

#define NMH1000_STATUS_RST_STAT_RST_SEQ_COMPLETED   ((uint8_t) 0x00) /* Reset sequence complete and read operation */

Definition at line 113 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_RST_STAT_RST_SEQ_NOT_COMPLETED

#define NMH1000_STATUS_RST_STAT_RST_SEQ_NOT_COMPLETED   ((uint8_t) 0x02) /* Reset sequence not complete. Result of Reset. */

Definition at line 115 of file nmh1000_regdef.h.

◆ NMH1000_STATUS_RST_STAT_SHIFT

#define NMH1000_STATUS_RST_STAT_SHIFT   ((uint8_t) 1)

Definition at line 93 of file nmh1000_regdef.h.

◆ NMH1000_USER_ODR_ODR_10X_HSP

#define NMH1000_USER_ODR_ODR_10X_HSP   ((uint8_t) 0x06) /* 10*High sample rate selected */

Definition at line 266 of file nmh1000_regdef.h.

◆ NMH1000_USER_ODR_ODR_5X_HSP

#define NMH1000_USER_ODR_ODR_5X_HSP   ((uint8_t) 0x05) /* 5*High sample rate selected */

Definition at line 265 of file nmh1000_regdef.h.

◆ NMH1000_USER_ODR_ODR_5X_LSP

#define NMH1000_USER_ODR_ODR_5X_LSP   ((uint8_t) 0x01) /* 5*Low sample rate selected */

Definition at line 262 of file nmh1000_regdef.h.

◆ NMH1000_USER_ODR_ODR_CONFIG_ERR

#define NMH1000_USER_ODR_ODR_CONFIG_ERR   ((uint8_t) 0x07) /* Coniguration error */

Definition at line 267 of file nmh1000_regdef.h.

◆ NMH1000_USER_ODR_ODR_HSP

#define NMH1000_USER_ODR_ODR_HSP   ((uint8_t) 0x04) /* High sample rate selected */

Definition at line 264 of file nmh1000_regdef.h.

◆ NMH1000_USER_ODR_ODR_LSP

#define NMH1000_USER_ODR_ODR_LSP   ((uint8_t) 0x00) /* Low sample rate selected */

Definition at line 261 of file nmh1000_regdef.h.

◆ NMH1000_USER_ODR_ODR_MASK

#define NMH1000_USER_ODR_ODR_MASK   ((uint8_t) 0x07)

Definition at line 254 of file nmh1000_regdef.h.

◆ NMH1000_USER_ODR_ODR_MSP

#define NMH1000_USER_ODR_ODR_MSP   ((uint8_t) 0x02) /* Medium sample rate selected */

Definition at line 263 of file nmh1000_regdef.h.

◆ NMH1000_USER_ODR_ODR_SHIFT

#define NMH1000_USER_ODR_ODR_SHIFT   ((uint8_t) 0)

Definition at line 255 of file nmh1000_regdef.h.

Typedef Documentation

◆ NMH1000_OUT_M_REG_t

typedef uint8_t NMH1000_OUT_M_REG_t

Definition at line 216 of file nmh1000_regdef.h.

◆ NMH1000_RESERVED_REG_1_t

typedef uint8_t NMH1000_RESERVED_REG_1_t

Definition at line 207 of file nmh1000_regdef.h.

◆ NMH1000_RESERVED_REG_2_t

typedef uint8_t NMH1000_RESERVED_REG_2_t

Definition at line 278 of file nmh1000_regdef.h.

◆ NMH1000_USER_ASSERT_THRESH_t

Definition at line 225 of file nmh1000_regdef.h.

◆ NMH1000_USER_CLEAR_THRESH_t

typedef uint8_t NMH1000_USER_CLEAR_THRESH_t

Definition at line 234 of file nmh1000_regdef.h.

◆ NMH1000_WHO_AM_I_t

typedef uint8_t NMH1000_WHO_AM_I_t

Definition at line 287 of file nmh1000_regdef.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

The nmh1000_regdef.h file contains the register definitions for NMH1000 sensor.

File: nmh1000_regdef.hThe NMH1000 Sensor Internal Map.

Enumerator
NMH1000_STATUS 
NMH1000_CONTROL_REG1 
NMH1000_RESERVED1 
NMH1000_OUT_M_REG 
NMH1000_USER_ASSERT_THRESH 
NMH1000_USER_CLEAR_THRESH 
NMH1000_ODR 
NMH1000_RESERVED2 
NMH1000_WHO_AM_I 
NMH1000_I2C_ADDR 

Definition at line 41 of file nmh1000_regdef.h.