〜 シンプル通信PLC For OMRON ライブラリ　リファレンス 〜

　付属のライブラリのリファレンスマニュアルです。

　全ての関数の第一引数（Omron rs）には、シンプル通信LC For OMRONのコントロールを設定します。

名前空間
using Aoyama.Rs232.Omron;

データの読み出し関数
関数名 名称
RRs 入出力リレー／内部補助リレー／特殊補助リレーエリア読み出し
データの書き込み関数
関数名 名称
WRs 入出力リレー／内部補助リレー／特殊補助リレーエリア書き込み
データの一括読み出し関数
関数名 名称
WriteQQ 複合コマンド　読み出し登録
ReadQQ 複合コマンド　一括読み出し
その他の関数
関数名 名称
Test テスト関数　送信データが、受信できるかをテストします

データの読み出し関数

long RRs(Omron rs, long ch)
入出力リレー／内部補助リレー／特殊補助リレーエリア読み出し　
リレーの値を取得します。
データが取得できた場合、データを返します。
引数に問題がある場合やポートが開かれていない場合、タイムアウトなどが発生した場合には、例外が発生します。
引数意味説明
rs コンポーネント コンポーネントのオブジェクトを指定します。
ch 読出開始チャネル 読み出し開始チャネルを整数で指定します
戻り値説明
チャネルデータ 関数の実行に成功した場合、long型データを返す。
失敗した場合、例外が発生する。
例外説明
ParamException チャネルの値が指定できる範囲を超えている場合、ParamExceptionが発生します。
NotOpenException ポートが開かれていない場合、NotOpenExceptionが発生します。
StatusException データを送信できない状態であった場合、StatusExceptionが発生します。
RecDataException 受信データに異常がある場合、RecDataExceptionが発生します。

データの書き込み関数

bool WRs(Omron rs, long ch, long val)
入出力リレー／内部補助リレー／特殊補助リレーエリア書き込み
リレーに値を書き込みます。
メソッドの実行に成功した場合、trueが返えします。タイムアウトや、ポートが開かれていないなど、実行に失敗した場合は、falseを返します。
引数意味説明
rs コンポーネント コンポーネントのオブジェクトを指定します。
ch 読出開始チャネル 読み出し開始チャネルを整数で指定します
val 書き込む値 書き込む値を整数で指定します
戻り値説明
メソッドの成否 メソッドの実行に成功した場合、trueを返す。
失敗した場合、falseを返す。

データの一括読み出し関数

bool WriteQQ(Omron rs, cmdList[] cmds)
複合コマンド　読み出し登録
複合コマンドを登録します。
メソッドの実行に成功した場合、trueを返します。失敗した場合、falseを返すか、例外を発生します。
引数に問題がある場合やポートが開かれていない場合、タイムアウトなどが発生した場合には、例外が発生します。
引数意味説明
rs コンポーネント コンポーネントのオブジェクトを指定します。
cmdList 登録データ 登録データをcmdList型の配列で指定します。
戻り値説明
メソッドの成否 関数の実行に成功した場合、trueを返す。
失敗した場合、falseを返すか、例外が発生する。
例外説明
ParamException チャネルの値が指定できる範囲を超えている場合、ParamExceptionが発生します。
NotOpenException ポートが開かれていない場合、NotOpenExceptionが発生します。
StatusException データを送信できない状態であった場合、StatusExceptionが発生します。
RecDataException 受信データに異常がある場合、RecDataExceptionが発生します。
cmdList型
プロパティ意味説明
area 読み出しエリア 読み出したいエリアを整数で指定します
1：入出力リレー、内部補助リレー、特殊補助リレー
2：リンクリレー
3：保持リレー
4：補助記憶リレー
5：タイマ
6：高速タイマ
7：カウンタ
8：可逆カウンタ
9：データメモリ
以下は、機種に依存します
20:積算タイマ
99:拡張メモリエリア（カレント）
100〜115：拡張メモリエリア（バンク指定　100が0、115が0Fに対応）
ch 読出チャネル 読み出すチャネルを整数で指定します
op オペラント 読み出すデータの形式を整数で指定します
0〜15: 接点の指定
-1: チャネルデータ
例： リレーの０チャネルと、DMの０チャネルを一括して読み出すための登録
using Aoyama.Rs232.Omron;

mdlOmron.cmdList[] cmds = new mdlOmron.cmdList[2];
cmds[0].area = 1;　1は、リレーを意味します
cmds[0].ch = 0;　チャネルの番号
cmds[0].op = -1;　-1は、チャネルの値を意味します。0〜15を指定すると、指定のビットのみを読み出せます。
cmds[1].area = 9;　9は、DMを意味します
cmds[1].ch = 0;　
cmds[1].op = -1;　
bool ret = mdlOmron.WriteQQ(omron1, cmds);
string[] ReadQQ(Omron rs)
複合コマンド　一括読み出し
WriteQQコマンドで指定したエリアのデータを一括して取り出します。
メソッドの実行に成功した場合、文字列データの入った配列を返します。失敗した場合、配列０に文字列”FALSE”を入れて返すか、例外を発生します。
引数に問題がある場合やポートが開かれていない場合、タイムアウトなどが発生した場合には、例外が発生します。
引数意味説明
rs コンポーネント コンポーネントのオブジェクトを指定します。
戻り値説明
メソッドの成否 関数の実行に成功した場合、文字列データの入った配列を返す。
失敗した場合、配列０に文字列”FALSE”を入れて返すか、例外が発生する。
例外説明
ParamException チャネルの値が指定できる範囲を超えている場合、ParamExceptionが発生します。
NotOpenException ポートが開かれていない場合、NotOpenExceptionが発生します。
StatusException データを送信できない状態であった場合、StatusExceptionが発生します。
RecDataException 受信データに異常がある場合、RecDataExceptionが発生します。
例： 上記の設定(WriteQQの例)を行い、一括してデータを読み出す 
  using Aoyama.Rs232.Omron;
  using System.Text;

  string[] data = mdlOmron.ReadQQ(omron1);
  StringBuilder mes = new StringBuilder();
  foreach(string s in data)
  {
    mes.Append(s);
  }
  labelMsg.Text = mes.ToString();

その他の関数

string Test(Omron rs, string sendData)
テスト関数　送信データが、受信できるかをテストします
コンポーネントのPlcTSメソッドを同等です。
引数意味説明
rs コンポーネント コンポーネントのオブジェクトを指定します。
sendData 送信データ 任意の送信データ（文字列）を指定します。
戻り値説明
受信データ 関数の実行に成功した場合、受信データを返す。
失敗した場合、例外が発生する。
例外説明
ParamException チャネルの値が指定できる範囲を超えている場合、ParamExceptionが発生します。
NotOpenException ポートが開かれていない場合、NotOpenExceptionが発生します。
StatusException データを送信できない状態であった場合、StatusExceptionが発生します。
RecDataException 受信データに異常がある場合、RecDataExceptionが発生します。