HDC1080

OSS-ECAL status code
OSS-ECAL command code
Configuration register (Pointer 0x02) settings
Receive data　from HDC1080

etCMD
eCMD_WRITE_CFG

Feature :
Command to write cfg value to Configuration Register (Pointer Register 0x02).

Process :
1. Calculate the Measurement time.
2. Write cfg value to Configuration Register (Pointer Register 0x02).

Command API function :
etSTS oHDC1080_WRITE_CFG( uint16 cfg )

Return value :
eSTS_FIN
eSTS_ERR_HAL_I2C
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_I2C_OBJECT

NOTE :
For cfg settings, please refer to the Datasheet “Configuration Register Description”.
Measurement time is rounded up to the next time.
Temperature 11bit 3.65ms, 14bit 6.35ms
Humidity 8bit 2.50ms, 11bit 3.65ms, 14bit 6.5ms

eCMD_READ_TEMP

Feature :
Command to read the value of Temperature Register, convert it to Temperature, and save it to rlt.temperature.

Process :
1. Write 0x00 to Pointer Register.
2. Wait until the Measurement time has elapsed (return value eSTS_EXE while waiting).
3. Read the value of Temperature Register.
4. Convert Temperature Register value to Temperature.
Temperature = (Temperature Register value/Temperature Gain) + Temperature Offset Value (Min, Max Limit)
5. Store Temperature in rlt.temperature.

Command API function :
etSTS oHDC1080_READ_TEMP( stHDC1080_O* rlt )

Return value:
eSTS_FIN
eSTS_EXE
eSTS_ERR_HAL_I2C
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_I2C_OBJECT
eSTS_ERR_MIN
eSTS_ERR_MAX

NOTE :
The Measurement time is calculated from the Thread period that calls this API function, so set the Thread period to THREAD_OSS_ECAL_PERIOD[ms].

eCMD_READ_HUMI

Feature :
Command to read the value of Humidity Register values, convert it to Humidity, and save it to rlt.humidity.

Process :
1. Write 0x01 to Pointer Register.
2. Wait until the Measurement time has elapsed (return value eSTS_EXE while waiting).
3. Read the value of Humidity Register.
4. Convert Humidity Register value to Humidity.
Humidity = Humidity Register value/Humidity Gain (Min, Max Limit)
5. Store Humidity in rlt.humidity.

Command API function :
etSTS oHDC1080_READ_HUMI( stHDC1080_O* rlt )

Return value :
eSTS_FIN
eSTS_EXE
eSTS_ERR_HAL_I2C
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_I2C_OBJECT
eSTS_ERR_MIN
eSTS_ERR_MAX

NOTE :
The Measurement time is calculated from the Thread period that calls this API function, so set the Thread period to THREAD_OSS_ECAL_PERIOD[ms].

eCMD_READ_TEMP_HUMI

Feature :
Command to read the Humidity Register and Temperature Register values, convert them to temperature and humidity, and save them to rlt.temperature and rlt.humidity.

Process :
1. Write 0x00 to Pointer Register.
2. Wait until the Measurement time has elapsed (return value eSTS_EXE while waiting).
3. Reads the value of Temperature Register (Pointer 0x00) and Humidity Register (Pointer 0x01).
4. Converts Temperature Register readings to Temperature.
Temperature = (Temperature Register value/Temperature Gain) + Temperature Offset Value (Min, Max Limit)
5. Convert Humidity Register value to Humidity.
Humidity = Humidity Register value/Humidity Gain (Min, Max Limit)
6. Store Temperature in rlt.temperature.
7. Store Humidity in rlt.humidity.

Command API function :
etSTS oHDC1080_READ_TEMP_HUMI( stHDC1080_O* rlt )

Return value :
eSTS_FIN
eSTS_EXE
eSTS_ERR_HAL_I2C
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_I2C_OBJECT
eSTS_ERR_MIN
eSTS_ERR_MAX

NOTE :
The Measurement time is calculated from the Thread period that calls this API function, so set the Thread period to THREAD_OSS_ECAL_PERIOD[ms].

eCMD_READ_SERI_ID

Feature :
Command to read the Serial ID value and save it to rlt.serialID.

Process :
1. Write 0xFB to Pointer Register.
2. Read Serial ID ( First ).
3. Write 0xFC to Pointer Register.
4. Read Serial ID ( Mid ).
5. Write 0xFD to Pointer Register.
6. Read Serial ID ( Last ).
7. Store Serial ID in rlt.serialID.

Command API function :
etSTS oHDC1080_READ_SERI_ID( stHDC1080_O* rlt )

Return value:
eSTS_FIN
eSTS_ERR_HAL_I2C
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_I2C_OBJECT

Note :

eCMD_READ_CFG

Feature :
Command to read the Configuration Register and save it to rlt.config.

Process :
1. Write 0x02 to Pointer Register.
2. Read Configuration Register.
3. Store the value read in rlt.config.

Command API function :
etSTS oHDC1080_READ_CFG( stHDC1080_O* rlt )

Return value :
eSTS_FIN
eSTS_ERR_HAL_I2C
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_I2C_OBJECT

Note :
See Datasheet “Configuration Register Description”.

eCMD_DIAG_DEVI_ID

Feature :
Command that returns the comparison result between the DeviceID Register value and 0x1050 as a return value.

Process :
1. Write 0xFF to Pointer Register.
2. Read DeviceID Register.
3. Returns the result of comparing the read value with 0x1050 as the return value.
True … eSTS_FIN
False … eSTS_ERR_DIAG

Command API function :
etSTS oHDC1080_DIAG_DEVI_ID( void )

Return value :
eSTS_FIN
eSTS_ERR_DIAG
eSTS_ERR_HAL_I2C
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_I2C_OBJECT

Note :

eCMD_DIAG_MANU_ID

Feature :
Command that returns the comparison result between the ManufacturerID Register value and 0x5449 as a return value.

Process :
1. Write 0xFE to Pointer Register.
2. Read ManufacturerID Register.
3. Returns the result of comparing the read value with 0x5449 as the return value.
True … eSTS_FIN
False … eSTS_ERR_DIAG

Command API function :
etSTS oHDC1080_DIAG_MANU_ID( void )

Return value:
eSTS_FIN
eSTS_ERR_DIAG
eSTS_ERR_HAL_I2C
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_I2C_OBJECT

Note:

stHDC1080_O
float32 temperature
float32 humidity
uint16 config
uint64 serialID

HDC1080 Register 0x00 Temperature to float TEMPERATURE[degrees Celsius]
HDC1080 Register 0x01 Humidity to float HUMIDITY[%RH]
HDC1080 Register 0x02 Configuration
HDC1080 Register 0xFB~0xFD Serial ID (First, Mid, Last)