GP2Y0A21YK0Fは、Sharp製の距離測定センサ IC（100～800mm）です。GP2Y0A21YK0FのOSS-ECAL（電子部品抽象化レイヤのオープンソースソフトウェア：Open Source Software for Electronic Components Abstraction Layer）を提供致します。
MCUインタフェース：ADC
ご注意：このリソースの元の言語は英語です。 翻訳は概要を便宜的に提供するもので、機械翻訳を使用していることがあり、私たちは翻訳の正確性および妥当性につきましては一切保証いたしません。 また、実際の設計などの前には、必ず最新版Datasheetをご参照くださいますようお願いいたします。
GP2Y0A21YK0F
概要
GP2Y0A21YK0Fは、PSD（位置感応型検出器）、IR-LED（赤外発光ダイオード）、信号処理回路を一体化した測距センサユニットです。三角測量方式を採用しているため、対象物の反射率の違い、環境温度、動作時間などの影響を受けにくく、距離検出が可能です。検出距離に応じた電圧を出力します。そのため、近接センサとしても使用できます。
特徴
- 測距センサーは、PSD、赤外線LED、信号処理回路で構成されています。
- 測距範囲：10～80cm
- コンパクトサイズ（29.5×13.0×13.5mm）
- アナログ出力タイプ
用途
- タッチレスセンサスイッチ
- お掃除ロボット
- 省エネセンサ
- アミューズメント
OSS-ECAL仕様
API関数
etSTS oGP2Y0A21YK0F( etCMD cmd, float32* rlt )
oGP2Y0A21YK0F関数は、引数のコマンドによってGP2Y0A21YK0Fの処理を実行する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変換値から距離変換式 電圧値=(読み込んだ値×VDD)/(2AD bit) 距離＝下表テーブル検索値 (Min, Max Limit) | ||
| eCMD_START_READ | AD変換をスタートし、AD変換値を読込み、AD変換値を距離に変換するコマンド AD変換値から距離変換式 電圧値=(読み込んだ値×VDD)/(2AD bit) 距離＝下表テーブル検索値 (Min, Max Limit) | ||
| 引数 OUT | float32* rlt | 距離 100.0 to 800.0 [mm] |
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 oGP2Y0A21YK0F_START(void)
oGP2Y0A21YK0F_START関数は、GP2Y0A21YK0Fの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 oGP2Y0A21YK0F_READ( float32* rlt )
oGP2Y0A21YK0F_READ関数は、GP2Y0A21YK0FのAD変換の終了を確認し、AD変換値を読み込み、そのAD変換値を距離に特性変換して、その距離をrltに保存するAPI関数です。
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 | 距離 100.0 to 800.0 [mm] |
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 oGP2Y0A21YK0F_START_READ( float32* rlt )
oGP2Y0A21YK0F_START_READ関数は、GP2Y0A21YK0FのAD変換を開始し、AD変換の終了を待ち、AD変換値を読み込み、そのAD変換値を距離に特性変換して、その距離をrltに保存するAPI関数です。
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 | 距離 100.0 to 800.0 [mm] |
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構成
| フォルダ* | ファイル | 概要 |
|---|---|---|
| GP2Y0A21YK0F_HALNAME_VERSION/sample | sample.c (.cpp) | サンプル・アプリケーション・プログラム |
| sample.h | サンプル・アプリケーション・ヘッダ | |
| GP2Y0A21YK0F_HALNAME_VERSION | oGP2Y0A21YK0F.c (.cpp) | GP2Y0A21YK0F用OSS-ECALプログラム |
| oGP2Y0A21YK0F.h | GP2Y0A21YK0F用OSS-ECALヘッダ | |
| GP2Y0A21YK0F_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 イベント割込み（優先順位高）で圧力取込み