コントロールDLLを作ろう - ProjectC3 @ ウィキ

PC-OP-RS1-CONTROL.DLL APIリファレンス

Last updated : 06/07/2008

Written by Yasuhiro ISHII(石井 康寛)

このページのもくじ

ここでとりあげるモジュールのダウンロード

DLL本体

#ref error ：ご指定のファイルが見つかりません。ファイル名を確認して、再度指定してください。 (pc-op-rs1-control.dll)

ソース一式

#ref error ：ご指定のファイルが見つかりません。ファイル名を確認して、再度指定してください。 (pc-op-rs1-control.zip)

概要

このページでは、バッファロー製学習リモコンPC-OP-RS1に対してアクセスするライブラリPC-OP-RS1-CONTROL.DLLの提供するAPIについて説明しています。 このリファレンスでは、C言語によるインターフェースで説明していますので、他の言語から使用される場合には適宜読み替えてください。

API一覧

このライブラリが提供するAPIとそれぞれが提供する機能の内訳は以下の通りです。

API名	機能
Open	ドライバのオープンを行う
Close	ドライバのクローズを行う
SetTimeOut	PC-OP-RS1との送受信をする際のタイムアウト時間を設定する
Receive	PC-OP-RS1でリモコンデータを受信する
Transmit	PC-OP-RS1からリモコンデータを送信する
LedFlash	PC-OP-RS1のACCESS LEDの点灯を行う
GetModuleVersion	当DLLのバージョンを取得する

APIリファレンス

Open

概要

ドライバをオープンする。

プロトタイプ

PCOPRS1CONTROL_RET Open(int port_no)

入力

• port_no
  使用するCOMポート番号(0 - 255)

出力

• PCOPRS1CONTROL_RET_OK
  成功
• PCOPRS1CONTROL_RET_ERR
  失敗

Close

概略

オープンしたドライバをクローズする。

プロトタイプ

PCOPRS1CONTROL_RET Close(void)

入力

なし

出力

• PCOPRS1CONTROL_RET_OK
  成功
• PCOPRS1CONTROL_RET_ERR
  失敗

SetTimeOut

概要

送受信のタイムアウト時間を設定する。(単位:[ms])
なお、このタイムアウト時間は、Receive関数での、リモコンコード受信待ちを中断するタイムアウト時間としても機能します。

プロトタイプ

PCOPRS1CONTROL_RET SetTimeOut(unsigned long tmo_milliseconds)

入力

• tmo_milliseconds
  タイムアウト時間(単位:[ms])

出力

• PCOPRS1CONTROL_RET_OK
  成功
• PCOPRS1CONTROL_RET_ERR
  失敗

Receive

概要

PC-OP-RS1のリモコン受光部からのリモコンコード受信処理を行います。
受信データは、PC-OP-RS1の仕様により240バイト固定です。

プロトタイプ

PCOPRS1CONTROL_RET Receive(unsigned char* premocon_code)

入力

• premocon_code
  受信したリモコンコードのタイミング情報を保存する為のバッファへのポインタです。
  240バイトあるいはそれ以上の領域を設定して下さい。
  (使用するのは先頭から240バイトのみ)

出力

• PCOPRS1CONTROL_RET_OK
  成功
• PCOPRS1CONTROL_RET_ERR
  失敗

Transmit

概要

PC-OP-RS1の4chある赤外線リモコンコマンド送出ポートの任意の一つを使用して、設定したコマンド列を出力します。

プロトタイプ

PCOPRS1CONTROL_RET Transmit(int ch,unsigned char* premocon_code)

入力

• ch
  赤外線を出力するポートを設定します。
  ポート番号 : 0 - 3
• premocon_code
  送出する赤外線コマンドデータ。
  Receive関数で取得した240バイト長のデータを設定します。

出力

• PCOPRS1CONTROL_RET_OK
  成功
• PCOPRS1CONTROL_RET_ERR
  失敗

LedFlash

概要

PC-OP-RS1に搭載されたアクセスLEDを一定期間点灯させます。
また、Receive関数でコマンド受信待ちのまま、タイムアウトを検出した場合の復帰処理としても使用します。
ソフトウェアがPC-OP-RS1に対して制御を開始した時のPC-OP-RS1の状態は不明であるため、一旦ソフトウェア側でLedFlashを呼び出すことを推奨いたします。

プロトタイプ

PCOPRS1CONTROL_RET LedFlash(void)

入力

なし

出力

• PCOPRS1CONTROL_RET_OK
  成功
• PCOPRS1CONTROL_RET_ERR
  失敗

GetModuleVersion

概要

PC-OP-RS1-CONTROL.DLLのバージョン番号を取得する為のインターフェースです。

プロトタイプ

PCOPRS1CONTROL_RET GetModuleVersion(unsigned long* major_version,unsigned long* minor_version)

入力

• major_version
  major_versionを格納する為のバッファへのポインタ
• minor_version
  minor_versionを格納する為のバッファへのポインタ

出力

• PCOPRS1CONTROL_RET_OK
  成功
• PCOPRS1CONTROL_RET_ERR
  失敗

アクセスカウント(累計) : - アクセスカウント(本日) : - アクセスカウント(昨日) : -