HDC1080は、Texas Instruments製の温度および湿度センサIC(-40~+125℃、0.0~100.0%RH)です。HDC1080のOSS-ECAL(電子部品抽象化レイヤのオープンソースソフトウェア:Open Source Software for Electronic Components Abstraction Layer)を提供致します。
MCUインタフェース:I2C
ご注意:このリソースの元の言語は英語です。 翻訳は概要を便宜的に提供するもので、機械翻訳を使用していることがあり、私たちは翻訳の正確性および妥当性につきましては一切保証いたしません。 また、実際の設計などの前には、必ず最新版Datasheetをご参照くださいますようお願いいたします。
HDC1080
概要
HDC1080は温度センサーを内蔵したデジタル湿度センサーで、非常に低い消費電力で優れた測定精度を提供します。HDC1080は幅広い電源範囲で動作し、一般的なアプリケーションの幅広い範囲で、競合ソリューションに代わる低コスト、低消費電力を実現します。湿度および温度センサーは工場校正済みです。
特徴
- 相対湿度精度 ±2% (typical)
- 温度制度 ±0.2°C (typical)
- 高湿度下での優れた安定性
- 14ビット測定分解能
- 100 nA スリープモード電流
- 平均供給電流:
710nA@1sps、11ビットRH測定
1.3μA@1sps、11ビットRHおよび温度測定 - 電源電圧 2.7 V~5.5 V
- 小型3mm x 3mmのデバイス・フットプリント
- I2Cインタフェース
用途
- HVAC
- スマートサーモスタットとルームモニター
- 白物家電
- プリンター
- ハンドヘルドメーター
- Medical Devices
- ワイヤレスセンサー (TIDA: 00374, 00484, 00524)
OSS-ECAL仕様
API関数
etSTS oHDC1080( etCMD cmd, uint16 cfg, stHDC1080_O* rlt )
oHDC1080関数は、引数のコマンドcmdによってHDC1080の処理を実行するAPI関数です。
備考:
計測時間は次の通り。(1ms未満の小数点は切り上げ)
温度:11bit変換 3.65ms, 14bit変換 6.35ms
湿度:8bit変換 2.50ms, 11bit変換 3.65ms, 14bit変換 6.5ms
計測時間の計測は、本API関数をコールするThread周期から計算するので、THREAD_OSS_ECAL_PERIOD[ms]にThread周期を設定してください。
戻り値 | etSTS | OSS-ECALステータスコード | |
eSTS_FIN | 正常終了 | ||
eSTS_EXE | 実行中 | ||
eSTS_ERR_MIN | 最小温度エラー(rlt.temperatureは最小温度) または 最小湿度エラー(rlt.humidityは最小湿度) | ||
eSTS_ERR_MAX | 最大温度エラー(rlt.temperatureは最大温度) または 最大湿度エラー(rlt.humidityは最大湿度) | ||
eSTS_ERR_COMMAND_CODE | コマンド選択エラー | ||
eSTS_ERR_DIAG | 次のコマンドで比較結果NGの場合 eCMD_DIAG_DEVI_ID eCMD_DIAG_MANU_ID | ||
eSTS_ERR_I2C_OBJECT | I2Cオブジェクト選択エラー | ||
eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
eSTS_ERR_HAL_I2C | HAL I2Cエラー | ||
引数 IN | etCMD cmd | OSS-ECALコマンドコード | |
eCMD_WRITE_CFG | cfgの値をConfiguration Register (Pointer Register 0x02) に書き込むコマンド 1. 温度および湿度の変換bit数から計測時間を計算する 2. Configuration Register (Pointer Register 0x02) にcfgの値を書き込む | ||
eCMD_READ_TEMP | Temperature Registerの値を読み込み、その値を温度に変換し、その温度をrlt.temperatureに保存するコマンド 1. Pointer Registerに0x00を書き込む 2. 計測時間が経過するまで待機する 待機中は戻り値eSTS_EXE 3. Temperature Registerの値を読み込む 4. Temperature Registerの読み出し値を温度に変換する 温度=(読み出し値/ゲイン係数)+温度オフセット値 (Min, Max Limit) 5. rlt.temperatureに温度を保存する | ||
eCMD_READ_HUMI | Humidity Registerの値を読み込み、その値を湿度に変換し、その湿度をrlt.humidityに保存するコマンド 1. Pointer Registerに0x01を書き込む 2. 計測時間が経過するまで待機する 待機中は戻り値eSTS_EXE 3. Humidity Registerの値を読み込む 4. Humidity Registerの読み込んだ値を湿度に変換する 湿度=読み込んだ値/ゲイン係数 (Min, Max Limit) 5. rlt.humidityに湿度を保存する | ||
eCMD_READ_TEMP_HUMI | Humidity RegisterおよびTemperature Registerの値を読み込み、その値を温度および湿度に変換し、その温度および湿度をrlt.temperature および rlt.humidityに保存するコマンド 1. Pointer Registerに0x00を書き込む 2. 計測時間が経過するまで待機する 待機中は戻り値eSTS_EXE 3. Temperature Registerの値とHumidity Registerの値を読み込む 4. Temperature Registerの読み込んだ値を温度に変換する 温度=(読み込んだ値/ゲイン係数)+温度オフセット値 (Min, Max Limit) 5. Humidity Registerの読み込んだ値を湿度に変換する 湿度=読み込んだ値/ゲイン係数 (Min, Max Limit) 6. rlt.temperatureに温度を保存する 7. rlt.humidityに湿度を保存する | ||
eCMD_READ_SERI_ID | Serial IDの値を読み込み、その値をrlt.serialIDに保存するコマンド 1. Pointer Registerに0xFBを書き込む 2. Serial ID ( First )を読み込む 3. Pointer Registerに0xFCを書き込む 4. Serial ID ( Mid )を読み込む 5. Pointer Registerに0xFDを書き込む 6. Serial ID ( Last )を読み込む 7. rlt.serialIDに読み出した値を保存する | ||
eCMD_READ_CFG | Configuration Registerの値を読み込み、その値をrlt.configに保存するコマンド 1. Pointer Registerに0x02を書き込む 2. Configuration Registerを読み込む 3. rlt.configに読み出した値を保存する | ||
eCMD_DIAG_DEVI_ID | DeviceID Registerの値を読み込み、その値と0x1050の比較結果を戻り値として返すコマンド 1. Pointer Registerに0xFFを書き込む 2. DeviceID Registerを読み込む 3. 読み出した値と0x1050の比較結果を戻り値として返す True … eSTS_FIN False … eSTS_ERR_DIAG | ||
eCMD_DIAG_MANU_ID | ManufacturerID Registerの値を読み込み、その値と0x5449の比較結果を戻り値として返すコマンド 1. Pointer Registerに0xFEを書き込む 2. ManufacturerID Register を読み込む 3. 読み出した値と0x5449の比較結果を戻り値として返す True … eSTS_FIN False … eSTS_ERR_DIAG | ||
uint16 cfg | Configuration register (Pointer 0x02) 設定データ | cfgの設定は、Datasheet “Configuration Register Description”を参照してください | |
引数 OUT | stHDC1080_O* rlt | HDC1080からの受信データ | |
float32 temperature | 温度 [°C] | ||
float32 humidity | 湿度 [%RH] | ||
uint16 config | Register 0x02の値 | ||
uint64 serialID | Register 0xFB to 0xFDの値 |
etSTS oHDC1080_WRITE_CFG( uint16 cfg )
oHDC1080_WRITE_CFG関数は、HDC1080のConfiguration Register (Pointer Register 0x02) に書き込むAPI関数です。
1. 温度および湿度の変換bit数から計測時間を計算する
2. Configuration Register (Pointer Register 0x02) にcfgの値を書き込む
備考:
計測時間は次の通り。(1ms未満の小数点は切り上げ)
温度:11bit変換 3.65ms, 14bit変換 6.35ms
湿度:8bit変換 2.50ms, 11bit変換 3.65ms, 14bit変換 6.5ms
計測時間の計測は、本API関数をコールするThread周期から計算するので、THREAD_OSS_ECAL_PERIOD[ms]にThread周期を設定してください。
戻り値 | etSTS | OSS-ECALステータスコード | |
eSTS_FIN | 正常終了 | ||
eSTS_EXE | 実行中 | ||
eSTS_ERR_I2C_OBJECT | I2Cオブジェクト選択エラー | ||
eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
eSTS_ERR_HAL_I2C | HAL I2Cエラー | ||
引数 IN | uint16 cfg | Configuration register (Pointer 0x02) 設定データ | cfgの設定は、Datasheet “Configuration Register Description”を参照してください |
etSTS oHDC1080_READ_TEMP( stHDC1080_O* rlt )
oHDC1080_READ_TEMP関数は、HDC1080のTemperature Registerの値を読み込み、その値を温度に変換し、その温度をrlt.temperatureに保存するAPI関数です。
- Pointer Registerに0x00を書き込む
- 計測時間が経過するまで待機する
待機中は戻り値eSTS_EXE - Temperature Registerの値を読み込む
- Temperature Registerの読み出し値を温度に変換する
温度=(読み出し値/ゲイン係数)+温度オフセット値
(Min, Max Limit) - rlt.temperatureに温度を保存する
備考:
計測時間の計測は、本API関数をコールするThread周期から計算するので、THREAD_OSS_ECAL_PERIOD[ms]にThread周期を設定してください。
戻り値 | etSTS | OSS-ECALステータスコード | |
eSTS_FIN | 正常終了 | ||
eSTS_EXE | 実行中 | ||
eSTS_ERR_MIN | 最小温度エラー(rlt.temperatureは最小温度) | ||
eSTS_ERR_MAX | 最大温度エラー(rlt.temperatureは最大温度) | ||
eSTS_ERR_I2C_OBJECT | I2Cオブジェクト選択エラー | ||
eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
eSTS_ERR_HAL_I2C | HAL I2Cエラー | ||
引数 OUT | stHDC1080_O* rlt | HDC1080からの受信データ | |
float32 temperature | 温度 [°C] | ||
float32 humidity | 湿度 [%RH](未更新) | ||
uint16 config | Register 0x02の値(未更新) | ||
uint64 serialID | Register 0xFB to 0xFDの値(未更新) |
etSTS oHDC1080_READ_HUMI( stHDC1080_O* rlt )
oHDC1080_READ_HUMI関数は、HDC1080のHumidity Registerの値を読み込み、その値を湿度に変換し、その湿度をrlt.humidityに保存するAPI関数です。
- Pointer Registerに0x01を書き込む
- 計測時間が経過するまで待機する
待機中は戻り値eSTS_EXE - Humidity Registerの値を読み込む
- Humidity Registerの読み込んだ値を湿度に変換する
湿度=読み込んだ値/ゲイン係数
(Min, Max Limit) - rlt.humidityに湿度を保存する
備考:
計測時間の計測は、本API関数をコールするThread周期から計算するので、THREAD_OSS_ECAL_PERIOD[ms]にThread周期を設定してください。
戻り値 | etSTS | OSS-ECALステータスコード | |
eSTS_FIN | 正常終了 | ||
eSTS_EXE | 実行中 | ||
eSTS_ERR_MIN | 最小湿度エラー(rlt.humidityは最小湿度) | ||
eSTS_ERR_MAX | 最大湿度エラー(rlt.humidityは最大湿度) | ||
eSTS_ERR_I2C_OBJECT | I2Cオブジェクト選択エラー | ||
eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
eSTS_ERR_HAL_I2C | HAL I2Cエラー | ||
引数 OUT | stHDC1080_O* rlt | HDC1080からの受信データ | |
float32 temperature | 温度 [°C](未更新) | ||
float32 humidity | 湿度 [%RH] | ||
uint16 config | Register 0x02の値(未更新) | ||
uint64 serialID | Register 0xFB to 0xFDの値(未更新) |
etSTS oHDC1080_READ_TEMP_HUMI( stHDC1080_O* rlt )
oHDC1080_READ_TEMP_HUMI関数は、HDC1080のHumidity RegisterおよびTemperature Registerの値を読み込み、その値を温度および湿度に変換し、その温度および湿度をrlt.temperature および rlt.humidityに保存するAPI関数です。
- Pointer Registerに0x00を書き込む
- 計測時間が経過するまで待機する
待機中は戻り値eSTS_EXE - Temperature Registerの値とHumidity Registerの値を読み込む
- Temperature Registerの読み込んだ値を温度に変換する
温度=(読み込んだ値/ゲイン係数)+温度オフセット値
(Min, Max Limit) - Humidity Registerの読み込んだ値を湿度に変換する
湿度=読み込んだ値/ゲイン係数
(Min, Max Limit) - rlt.temperatureに温度を保存する
- rlt.humidityに湿度を保存する
備考:
計測時間の計測は、本API関数をコールするThread周期から計算するので、THREAD_OSS_ECAL_PERIOD[ms]にThread周期を設定してください。
戻り値 | etSTS | OSS-ECALステータスコード | |
eSTS_FIN | 正常終了 | ||
eSTS_EXE | 実行中 | ||
eSTS_ERR_MIN | 最小温度エラー(rlt.temperatureは最小温度) または 最小湿度エラー(rlt.humidityは最小湿度) | ||
eSTS_ERR_MAX | 最大温度エラー(rlt.temperatureは最大温度) または 最大湿度エラー(rlt.humidityは最大湿度) | ||
eSTS_ERR_I2C_OBJECT | I2Cオブジェクト選択エラー | ||
eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
eSTS_ERR_HAL_I2C | HAL I2Cエラー | ||
引数 OUT | stHDC1080_O* rlt | HDC1080からの受信データ | |
float32 temperature | 温度 [°C] | ||
float32 humidity | 湿度 [%RH] | ||
uint16 config | Register 0x02の値(未更新) | ||
uint64 serialID | Register 0xFB to 0xFDの値(未更新) |
etSTS oHDC1080_READ_SERI_ID( stHDC1080_O* rlt )
oHDC1080_READ_SERI_ID関数は、HDC1080のSerial IDの値を読み込み、その値をrlt.serialIDに保存するAPI関数です。
- Pointer Registerに0xFBを書き込む
- Serial ID ( First )を読み込む
- Pointer Registerに0xFCを書き込む
- Serial ID ( Mid )を読み込む
- Pointer Registerに0xFDを書き込む
- Serial ID ( Last )を読み込む
- rlt.serialIDに読み出した値を保存する
備考:
戻り値 | etSTS | OSS-ECALステータスコード | |
eSTS_FIN | 正常終了 | ||
eSTS_ERR_I2C_OBJECT | I2Cオブジェクト選択エラー | ||
eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
eSTS_ERR_HAL_I2C | HAL I2Cエラー | ||
引数 OUT | stHDC1080_O* rlt | HDC1080からの受信データ | |
float32 temperature | 温度 [°C](未更新) | ||
float32 humidity | 湿度 [%RH](未更新) | ||
uint16 config | Register 0x02の値(未更新) | ||
uint64 serialID | Register 0xFB to 0xFDの値 |
etSTS oHDC1080_READ_CFG( stHDC1080_O* rlt )
oHDC1080_READ_CFG関数は、HDC1080のConfiguration Registerの値を読み込み、その値をrlt.configに保存するAPI関数です。
- Pointer Registerに0x02を書き込む
- Configuration Registerを読み込む
- rlt.configに読み出した値を保存する
備考:
Datasheet “Configuration Register Description”を参照してください。
戻り値 | etSTS | OSS-ECALステータスコード | |
eSTS_FIN | 正常終了 | ||
eSTS_ERR_I2C_OBJECT | I2Cオブジェクト選択エラー | ||
eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
eSTS_ERR_HAL_I2C | HAL I2Cエラー | ||
引数 OUT | stHDC1080_O* rlt | HDC1080からの受信データ | |
float32 temperature | 温度 [°C](未更新) | ||
float32 humidity | 湿度 [%RH](未更新) | ||
uint16 config | Register 0x02の値 | ||
uint64 serialID | Register 0xFB to 0xFDの値(未更新) |
etSTS oHDC1080_DIAG_DEVI_ID( void )
oHDC1080_DIAG_DEVI_ID関数は、HDC1080のDeviceID Registerの値を読み込み、その値と0x1050の比較結果を戻り値として返すAPI関数です。
- Pointer Registerに0xFFを書き込む
- DeviceID Registerを読み込む
- 読み出した値と0x1050の比較結果を戻り値として返す
True … eSTS_FIN
False … eSTS_ERR_DIAG
備考:
戻り値 | etSTS | OSS-ECALステータスコード | |
eSTS_FIN | 正常終了 | ||
eSTS_ERR_DIAG | DeviceID Registerの値と0x1050が不一致 | ||
eSTS_ERR_I2C_OBJECT | I2Cオブジェクト選択エラー | ||
eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
eSTS_ERR_HAL_I2C | HAL I2Cエラー |
etSTS oHDC1080_DIAG_MANU_ID( void )
oHDC1080_DIAG_DEVI_ID関数は、HDC1080のManufacturerID Registerの値を読み込み、その値と0x5449の比較結果を戻り値として返すAPI関数です。
- Pointer Registerに0xFEを書き込む
- ManufacturerID Register を読み込む
- 読み出した値と0x5449の比較結果を戻り値として返す
True … eSTS_FIN
False … eSTS_ERR_DIAG
備考:
戻り値 | etSTS | OSS-ECALステータスコード | |
eSTS_FIN | 正常終了 | ||
eSTS_ERR_DIAG | ManufacturerID Registerの値と0x5449が不一致 | ||
eSTS_ERR_I2C_OBJECT | I2Cオブジェクト選択エラー | ||
eSTS_ERR_OTHERS_RUN | 他のコンポーネントが処理実行中 | ||
eSTS_ERR_HAL_OTHERS_RUN | 他のアプリケーションがHAL実行中 | ||
eSTS_ERR_HAL_I2C | HAL I2Cエラー |
File構成
フォルダ* | ファイル | 概要 |
---|---|---|
HDC1080_HALNAME_VERSION/sample | sample.c (.cpp) | サンプル・アプリケーション・プログラム |
sample.h | サンプル・アプリケーション・ヘッダ | |
HDC1080_HALNAME_VERSION | oHDC1080.c (.cpp) | HDC1080用OSS-ECALプログラム |
oHDC1080.h | HDC1080用OSS-ECALヘッダ | |
HDC1080_ARDUINO.ino | Arduino用サンプル・アプリケーション・プログラム | |
oss_ecal.h | OSS-ECAL 共通ヘッダ (Ver 01.00.00以降、AUTOSARはVer01.01.07以降) | |
user_setting.c (.cpp) | ユーザ設定定数・テーブル | |
user_setting.h | ユーザ設定ヘッダ | |
oHAL_i2c_stm32f4.c | STM32Cube FW_F4用HALプログラム | |
oHAL_i2c_stm32f4.h | STM32Cube FW_F4用HALヘッダ | |
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 イベント割込み(優先順位高)で圧力取込み