CHSシリーズ（UPS, UPR, UGS, UGR）は、TDK製の湿度センサ IC（5～95％RH）です。CHSシリーズのOSS-ECAL（電子部品抽象化レイヤのオープンソースソフトウェア：Open Source Software for Electronic Components Abstraction Layer）を提供致します。
MCUインタフェース：ADC
ご注意：実際の設計などの前には、必ず最新版Datasheetをご参照くださいますようお願いいたします。
CHSシリーズ（UPS, UPR, UGS, UGR）
概要
TDKは湿度センサとして、独自開発の高分子材料による高精度湿度センサ素子と、独自回路設計技術により回路一体型の湿度センサアッセンブル品を供給しております。 湿度センサ素子は独自開発の高分子材料を採用した、高感度・高精度の抵抗変化型湿度センサ素子です。±5%RHの高精度、高感度、小型、高応答、低ヒステリシス特性を特徴としています。 湿度センサアッセンブル品は回路一体型の小型製品で、DC電源駆動/DC電圧出力の為、使用・制御が容易です。ネジ止めタイプは、検知箇所への設置が容易に可能です。広い湿度検知範囲(5～95(%)RH)、高湿度検知精度(±3%RH～±7%RH)、低ヒステリシス特性が特徴です。 プリンター、冷蔵庫(庫外/野菜室湿度管理)、エアコン(室内湿度管理)、植物工場用空調設備など幅広い用途にご使用頂けます。
特徴
- 5～95(%)RHと広い湿度範囲を測定いただけます
- 高精度です。特にCHS-UPR、-UPSの公称精度は、±3(%)RH以下です
- 温度特性が広範囲にわたり、フラットです
- 感湿特性にヒステリシスがほとんどありません。
- 小型で設置場所を選ばず、コストパフォーマンスに優れています
- 低消費電流です
- DC.1V出力で100(%)RHを表示し、電圧計で相対湿度が直読できます
- 必要な回路をすべて一体化したオールインワン構造で、電源(5V)を接続するだけで作動します
用途
- 冷蔵庫（結露予防）
- エアコン（室内湿度管理）
- PPC、LBP（画質管理）
- 産業用電子湿度測定器、植物工場用空調設備など
OSS-ECAL仕様
API関数
etSTS oCHS( etCMD cmd, float32* rlt )
oCHS関数は、引数のコマンドによってCHSシリーズ（UPS, UPR, UGS, UGR）の処理を実行するAPI関数です。
| 戻り値 | etSTS | OSS-ECALステータスコード | |
| eSTS_FIN | 正常終了 | ||
| eSTS_ERR_MIN | 最小湿度エラー（rltは最小湿度） | ||
| eSTS_ERR_MAX | 最大湿度エラー（rltは最大湿度） | ||
| eSTS_ERR_HAL_ADC | HAL ADCエラー | ||
| eSTS_ERR_COMMAND_CODE | コマンド選択エラー | ||
| eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
| eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
| eSTS_ERR_ADC_OBJECT | AD変換オブジェクト選択エラー | ||
| 引数 IN | etCMD cmd | OSS-ECALコマンドコード | |
| eCMD_START | AD変換をスタートするコマンド | ||
| eCMD_READ | AD変換値を読込み、AD変換値を湿度に変換するコマンド AD変換値から湿度変換式 電圧値=(AD変換値×VDD)/(2AD bit) 湿度＝((電圧値-電圧オフセット値)/ゲイン係数)+湿度オフセット値 (Min, Max Limit) | ||
| eCMD_START_READ | AD変換をスタートし、AD変換値を読込み、AD変換値を湿度に変換するコマンド AD変換値から湿度変換式 電圧値=(AD変換値×VDD)/(2AD bit) 湿度＝((電圧値-電圧オフセット値)/ゲイン係数)+湿度オフセット値 (Min, Max Limit) | ||
| 引数 OUT | float32* rlt | 湿度 5.0 to 95.0 [%RH] |
HAL別コマンド対応表
| Arduino | eCMD_START_READ |
| ARM Mbed | eCMD_START_READ |
| Debian(Linux) | eCMD_START_READ |
| Infineon ModusToolbox | eCMD_START_READ |
| NXP MCUXpresso iMXRT1051B_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)
oCHS_START関数は、CHSシリーズ（UPS, UPR, UGS, UGR）のAD変換を開始するAPI関数です。
| 戻り値 | etSTS | OSS-ECALステータスコード | |
| eSTS_FIN | 正常終了 | ||
| eSTS_ERR_HAL_ADC | HAL ADCエラー | ||
| eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
| eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
| eSTS_ERR_ADC_OBJECT | AD変換オブジェクト選択エラー |
HAL別関数対応表
| Arduino | – |
| ARM Mbed | – |
| Debian(Linux) | – |
| Infineon ModusToolbox | – |
| NXP MCUXpresso iMXRT1051B_1052B | X |
| Renesas SSP | X |
| STM STM32Cube FW_F4 | X |
etSTS oCHS_READ( float32* rlt )
oCHS_READ関数は、CHSシリーズ（UPS, UPR, UGS, UGR）のAD変換の終了を確認し、AD変換値を読み込み、そのAD変換値を湿度に特性変換して、その湿度をrltに保存するAPI関数です。
AD変換値から湿度変換式
電圧値=(AD変換値×VDD)/(2AD bit)
湿度＝((電圧値-電圧オフセット値)/ゲイン係数)+湿度オフセット値 (Min, Max Limit)
| 戻り値 | etSTS | OSS-ECALステータスコード | |
| eSTS_FIN | 正常終了 | ||
| eSTS_ERR_MIN | 最小湿度エラー（rltは最小湿度） | ||
| eSTS_ERR_MAX | 最大湿度エラー（rltは最大湿度） | ||
| eSTS_ERR_HAL_ADC | HAL ADCエラー | ||
| eSTS_ERR_TIMEOUT | ADC Timeoutエラー（AUTOSARのみ） | ||
| eSTS_ERR_OTHERS_RUN | 他コンポーネント実行中エラー | ||
| eSTS_ERR_ADC_OBJECT | AD変換オブジェクト選択エラー | ||
| 引数 OUT | float32* rlt | 湿度 5.0 to 95.0 [%RH] |
HAL別関数対応表
| Arduino | – | |
| ARM Mbed | – | |
| Debian(Linux) | – | |
| Infineon ModusToolbox | – | |
| NXP MCUXpresso iMXRT1051B_1052B | X | |
| Renesas SSP | X | |
| STM STM32Cube FW_F4 | X | Time-out時間 HAL_MAX_DELAY |
etSTS oCHS_START_READ( float32* rlt )
oCHS_START_READ関数は、CHSシリーズ（UPS, UPR, UGS, UGR）のAD変換を開始し、AD変換の終了を待ち、AD変換値を読み込み、そのAD変換値を湿度に特性変換して、その湿度をrltに保存するAPI関数です。
AD変換値から湿度変換式
電圧値=(AD変換値×VDD)/(2AD bit)
湿度＝((電圧値-電圧オフセット値)/ゲイン係数)+湿度オフセット値 (Min, Max Limit)
| 戻り値 | etSTS | OSS-ECALステータスコード | |
| eSTS_FIN | 正常終了 | ||
| eSTS_ERR_MIN | 最小湿度エラー（rltは最小湿度） | ||
| eSTS_ERR_MAX | 最大湿度エラー（rltは最大湿度） | ||
| eSTS_ERR_HAL_ADC | HAL ADCエラー | ||
| eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
| eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
| eSTS_ERR_ADC_OBJECT | AD変換オブジェクト選択エラー | ||
| 引数 OUT | float32* rlt | 湿度 5.0 to 95.0 [%RH] |
HAL別関数対応表
| Arduino | X | |
| ARM Mbed | X | |
| Debian(Linux) | X | |
| Infineon ModusToolbox | X | |
| NXP MCUXpresso iMXRT1051B_1052B | X | |
| Renesas SSP | X | |
| STM STM32Cube FW_F4 | X | Time-out時間 HAL_MAX_DELAY |
File構成
| フォルダ* | ファイル | 概要 |
|---|---|---|
| CHS_HALNAME_VERSION/sample | sample.c (.cpp) | サンプル・アプリケーション・プログラム |
| sample.h | サンプル・アプリケーション・ヘッダ | |
| CHS_HALNAME_VERSION | oCHS.c (.cpp) | CHSシリーズ（UPS, UPR, UGS, UGR）用OSS-ECALプログラム |
| oCHS.h | CHSシリーズ（UPS, UPR, UGS, UGR）用OSS-ECALヘッダ | |
| CHS_ARDUINO.ino | Arduino用サンプル・アプリケーション・プログラム | |
| oss_ecal.h | OSS-ECAL 共通ヘッダ (Ver 01.00.00以降) | |
| user_setting.c (.cpp) | ユーザ設定定数・テーブル | |
| user_setting.h | ユーザ設定ヘッダ | |
| readme.md | Readme | |
| OSS-ECAL Terms of Use.txt | OSS-ECAL利用条件 |
* HALNAMEはHAL対応表を参照してください。
HAL対応表
| HAL | MCU* | 開発環境* | HALNAME |
|---|---|---|---|
| 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(Linux) v2022.04 | TI AM335x | BeagleBone Black – Rev C | Linux |
* 開発時のMCUおよび開発環境。
同じHALであってもMCUや開発環境が異なると動作が合わない場合があります。
OSS-ECAL ダウンロード
OSS-ECALのダウンロードは、英語版OSS-ECALサイトからお願いいたします。なお、ダウンロードを行う際は、英語版OSS-ECALサイトにログインしてから操作してください。
組込み方法
ユーザプログラムに複数のOSS-ECAL（同じMCU機能の電子部品）を組み込む方法
ユーザプログラムに複数のOSS-ECAL（異なるMCU機能の電子部品）を組み込む方法
注意事項
サンプル版OSS-ECALは、優先順位の異なるThread（Task）や割込みで用いることを前提としていません。下記の例のような使い方はしないでください。
例）同じADCグループに各センサーが割り当てられ、優先順位が異なる処理でOSS-ECAL APIを実行すると、正しい値を取得できない場合があります。
ADC Gr0 Ch0 温度センサ AD22100A 100ms周期 Thread（優先順位低）で温度取込み
ADC Gr0 Ch1 圧力センサ MPX5999D イベント割込み（優先順位高）で圧力取込み