CHS series（UPS, UPR, UGS, UGR） is a Humidity sensor IC (5%RH to 95%RH) made by TDK. This posting will provide the OSS-ECAL(Open Source Software for Electronic Components Abstraction Layer) for CHS series.
MCU interface : ADC
CAUTION:The original language of this resource is Japanese. The translations are provided as a convenience and may be machine-translated, and we make no warranties as to the accuracy or adequacy of the translations. Please refer to the latest version of the Datasheet prior to actual design, etc.
CHS series(UPS, UPR, UGS, UGR)
General description
TDK supplies high-precision humidity sensor elements made of our proprietary high-polymer materials and circuit-integrated humidity sensor assemblies based on our proprietary circuit design technology. The humidity sensor element is a high-sensitivity, high-precision, resistance-change type humidity sensor element made of our originally developed polymer material. It features high accuracy of ±5%RH, high sensitivity, compact size, high response, and low hysteresis characteristics. The humidity sensor assembly is a compact product with an integrated circuit, and its DC power supply drive and DC voltage output make it easy to use and control. The screw-mount type can be easily installed at the detection point. It features a wide humidity detection range (5 to 95(%)RH), high humidity detection accuracy (±3%RH to ±7%RH), and low hysteresis characteristics. It can be used for a wide range of applications such as printers, refrigerators (humidity control for outside storage/vegetable compartment), air conditioners (humidity control inside the room), and air conditioning equipment for plant factories.
Feature
- A wide range of humidity from 5 to 95(%)RH can be measured
- High accuracy. In particular, the nominal accuracy of CHS-UPR and -UPS is ±3(%)RH or less
- Temperature characteristics are flat over a wide range
- There is almost no hysteresis in moisture sensitivity characteristics
- Compact, can be installed in any location, and offers excellent cost performance
- Low current consumption
- DC.1V output displays 100(%)RH, and the relative humidity can be read directly by the voltmeter
- All-in-one construction integrates all necessary circuits and operates by simply connecting a power supply (5 V)
Application
- Refrigerator (condensation prevention)
- Air conditioning (indoor humidity control)
- PPC, LBP (image quality control)
- Industrial electronic humidity meters, air conditioning equipment for plant factories, etc.
OSS-ECAL specification
API Function
etSTS oCHS( etCMD cmd, float32* rlt )
The oCHS function is an API function that executes CHS series(UPS, UPR, UGS, UGR) processing according to the command in the argument.
| Return value | etSTS | OSS-ECAL status code | |
| eSTS_FIN | Completed successfully | ||
| eSTS_ERR_MIN | Minimum Humidity error (rlt is minimum Humidity) | ||
| eSTS_ERR_MAX | Maximum Humidity error (rlt is maximum Humidity) | ||
| eSTS_ERR_HAL_ADC | HAL ADC Error | ||
| eSTS_ERR_COMMAND_CODE | Command selection error | ||
| eSTS_ERR_OTHERS_RUN | Other components are executing the process | ||
| eSTS_ERR_HAL_OTHERS_RUN | Other application is running HAL | ||
| eSTS_ERR_ADC_OBJECT | AD conversion object selection error | ||
| Parameter IN | etCMD cmd | OSS-ECAL command code | |
| eCMD_START | Command to start AD conversion. | ||
| eCMD_READ | Command that reads the AD conversion value, converts the AD conversion value to a characteristic Humidity, and stores the Humidity in rlt. AD conversion value to Humidity conversion equation Voltage value = (AD conversion value × VDD) / ( 2AD bit ) Humidity = ((voltage value – voltage offset value) / gain) + Humidity offset value (Min, Max Limit) | ||
| eCMD_START_READ | Command that starts AD conversion, waits for AD conversion to finish, reads out the AD conversion value, converts the AD conversion value to a characteristic Humidity, and stores the Humidity in rlt. AD conversion value to Humidity conversion equation Voltage value = (AD conversion value × VDD) / ( 2AD bit ) Humidity = ((voltage value – voltage offset value) / gain) + Humidity offset value (Min, Max Limit) | ||
| Parameter OUT | float32* rlt | Humidity 5.0 to 95.0 [%RH] |
Command Correspondence Table by HAL
| Arduino | Arduino | eCMD_START_READ |
| ARM | Mbed | eCMD_START_READ |
| Debian Project | Debian(Linux) | eCMD_START_READ |
| Infineon | ModusToolbox | eCMD_START_READ |
| NXP | MCUXpresso MXRT1051B_1052B | eCMD_START eCMD_READ eCMD_START_READ |
| Renesas | SSP | eCMD_START eCMD_READ eCMD_START_READ |
| STM | STM32Cube FW_F4 | eCMD_START eCMD_READ eCMD_START_READ |
etSTS oCHS_START(void)
The oCHS_START function is an API function to start AD conversion of the CHS series(UPS, UPR, UGS, UGR).
| Return value | etSTS | OSS-ECAL status code | |
| eSTS_FIN | Completed successfully | ||
| eSTS_ERR_HAL_ADC | HAL ADC Error | ||
| eSTS_ERR_OTHERS_RUN | Other components are executing the process | ||
| eSTS_ERR_HAL_OTHERS_RUN | Other application is running HAL | ||
| eSTS_ERR_ADC_OBJECT | AD conversion object selection error |
Function Correspondence Table by HAL
| Arduino | Arduino | – |
| ARM | Mbed | – |
| Debian Project | Debian(Linux) | – |
| Infineon | ModusToolbox | – |
| NXP | MCUXpresso MXRT1051B_1052B | X |
| Renesas | SSP | X |
| STM | STM32Cube FW_F4 | X |
etSTS oCHS_READ( float32* rlt )
The oCHS_READ function is an API function that checks for the end of AD conversion of the CHS series(UPS, UPR, UGS, UGR), reads the AD conversion value, converts the AD conversion value to a characteristic Humidity, and stores the Humidity in rlt.
AD conversion value to Humidity conversion equation
Voltage value = (AD conversion value × VDD) / ( 2AD bit )
Humidity = ((voltage value – voltage offset value) / gain) + Humidity offset value (Min, Max Limit)
| Return value | etSTS | OSS-ECAL status code | |
| eSTS_FIN | Completed successfully | ||
| eSTS_ERR_MIN | Minimum Humidity error (rlt is minimum Humidity) | ||
| eSTS_ERR_MAX | Maximum Humidity error (rlt is maximum Humidity) | ||
| eSTS_ERR_HAL_ADC | HAL ADC Error | ||
| eSTS_ERR_TIMEOUT | ADC Timeout error (AUTOSAR only) | ||
| eSTS_ERR_OTHERS_RUN | Other components are executing the process | ||
| eSTS_ERR_ADC_OBJECT | AD conversion object selection error | ||
| Parameter OUT | float32* rlt | Humidity 5.0 to 95.0 [%RH] |
Function Correspondence Table by HAL
| Arduino | Arduino | – | |
| ARM | Mbed | – | |
| Debian Project | Debian(Linux) | – | |
| Infineon | ModusToolbox | – | |
| NXP | MCUXpresso MXRT1051B_1052B | X | |
| Renesas | SSP | X | |
| STM | STM32Cube FW_F4 | X | Time-out time HAL_MAX_DELAY |
etSTS oCHS_START_READ( float32* rlt )
The oCHS_START_READ function is an API function that starts an AD conversion of the CHS series(UPS, UPR, UGS, UGR), waits for the AD conversion to finish, reads the AD conversion value, converts the AD conversion value to a Humidity characteristic, and stores the Humidity in rlt.
AD conversion value to Humidity conversion equation
Voltage value = (AD conversion value × VDD) / ( 2AD bit )
Humidity = ((voltage value – voltage offset value) / gain) + Humidity offset value (Min, Max Limit)
| Return value | etSTS | OSS-ECAL status code | |
| eSTS_FIN | Completed successfully | ||
| eSTS_ERR_MIN | Minimum Humidity error (rlt is minimum Humidity) | ||
| eSTS_ERR_MAX | Maximum Humidity error (rlt is maximum Humidity) | ||
| eSTS_ERR_HAL_ADC | HAL ADC Error | ||
| eSTS_ERR_OTHERS_RUN | Other components are executing the process | ||
| eSTS_ERR_HAL_OTHERS_RUN | Other application is running HAL | ||
| eSTS_ERR_ADC_OBJECT | AD conversion object selection error | ||
| Parameter OUT | float32* rlt | Humidity 5.0 to 95.0 [%RH] |
Function Correspondence Table by HAL
| Arduino | Arduino | X | |
| ARM | Mbed | X | |
| Debian Project | Debian(Linux) | X | |
| Infineon | ModusToolbox | X | |
| NXP | MCUXpresso MXRT1051B_1052B | X | |
| Renesas | SSP | X | |
| STM | STM32Cube FW_F4 | X | Time-out time HAL_MAX_DELAY |
Files
| Folder* | File | Summary |
|---|---|---|
| CHS_HALNAME_VERSION/sample | sample.c (.cpp) | Sample Application Program |
| sample.h | Sample Application Header | |
| CHS_HALNAME_VERSION | oCHS.c (.cpp) | OSS-ECAL Program for CHS series(UPS, UPR, UGS, UGR) |
| oCHS.h | OSS-ECAL Header for CHS series(UPS, UPR, UGS, UGR) | |
| CHS_ARDUINO.ino | Sample application programs for Arduino | |
| oss_ecal.h | OSS-ECAL Common Header (Ver 01.00.00 or later) | |
| user_setting.c (.cpp) | Const and Table of User setting | |
| user_setting.h | Header of User setting | |
| readme.md | Readme | |
| OSS-ECAL Terms of Use.txt | OSS-ECAL Terms of Use |
* For HALNAME, please refer to HAL Support.
HAL Support List
| MCU/Board manufacturer | HAL | MCU* | Development environment* | HALNAME |
|---|---|---|---|---|
| Arduino | Arduino 1.8.6 | ATmega2560 ATmega328P | Mega 2560 Rev3 Arduino Pro Mini 3.3V | ARDUINO |
| ARM | Mbed 6.17.0 | STM32F401RE | STM32 Nucleo-64 boards | MBED |
| Infineon | ModusToolbox HAL Cat1 2.4.3 | CYBLE-416045-02 | CY8CPROTO-063-BLE PSoC 6 BLE Prototyping Kit | ModusToolbox |
| NXP | MCUXpresso SDK iMXRT1051B_1052B ksdk2_0 | MIMXRT1052DVL6A | IMXRT1050-EVKB | iMXRT1051B1052B |
| Renesas | SSP 2.4.0 | R7FS7G27H3A01CFC | S7G2 SK | SSP |
| STM | STM32Cube FW_F4 V1.27.1 | STM32F401RE | STM32 Nucleo-64 boards | STM32F4 |
| Debian Project | Debian(Linux) v2022.04 | TI AM335x | BeagleBone Black – Rev C | Linux |
* MCU and development environment at the time of development. Even if the same HAL is used, different MCUs and development environments may not work together.
OSS-ECAL Download
Please login before downloading. To register as a new user, please click here.
This OSS-ECAL is a sample version and can be downloaded without user registration, but please accept the OSS-ECAL Terms of Use before downloading.
| HAL | Download OSS-ECAL Ver |
|---|---|
| Arduino 1.8.6 | |
| Mbed 6.17.0 | |
| ModusToolbox HAL Cat1 2.4.3 | |
| MCUXpresso SDK iMXRT1051B_1052B ksdk2_0 | |
| SSP 2.4.0 | |
| STM32Cube FW_F4 V1.27.1 | |
| Debian(Linux) v2022.04 |
If you are unable to download the File, please contact us and let us know the model number and HAL type. We will send you the file as an email attachment.
Built-in How to
How to incorporate OSS-ECAL into user programs
How to incorporate multiple OSS-ECALs in a user program (same MCU function)
How to incorporate multiple OSS-ECALs in a user program (different MCU function)
How to incorporate multiple identical electronic components into a user program
How to reduce the impact on user programs by replacing electronic components