定数定義

列挙型の値:

URG_CONNECTION_TIMEOUT

タイムアウトが発生したときの戻り値

通信タイプ

列挙型の値:

URG_SERIAL	シリアル, USB 接続
URG_ETHERNET	イーサーネット接続

切断

デバイスとの接続を切断する。

引数:

[in,out]

connection

通信リソース

  connection_close(&connection); 

参照:

connection_open()

接続

指定されたデバイスに接続する。

引数:

[in,out]	connection	通信リソース
[in]	connection_type	接続タイプ
[in]	device	接続名
[in]	baudrate_or_port	ボーレート / ポート番号

戻り値:

0	正常
<0	エラー

connection_type には

• URG_SERIAL ... シリアル通信
  • URG_ETHERNET .. イーサーネット通信

を指定する。

device, baudrate_or_port の指定は connection_type により指定できる値が異なる。 例えば、シリアル通信の場合は以下のようになる。

Example

  connection_t connection;
  if (! connection_open(&connection, URG_SERIAL, "COM1", 115200)) {
      return 1;
  } 

And, in case of ethernet connection:

Example

  connection_t connection;
  if (! connection_open(&connection, URG_ETHERNET, "192.168.0.10", 10940)) {
      return 1;
  } 

参照:

connection_close()

受信

データを受信する。

引数:

[in,out]	connection	通信リソース
[in]	data	受信データを格納するバッファ
[in]	max_size	受信データを格納できるバイト数
[in]	timeout	タイムアウト時間 [msec]

戻り値:

>=0	受信データ数
<0	エラー

timeout に負の値を指定した場合、タイムアウトは発生しない。

1 文字も受信しなかったときは URG_CONNECTION_TIMEOUT を返す。

Example

enum {
    BUFFER_SIZE = 256,
    TIMEOUT_MSEC = 1000,
};
char buffer[BUFFER_SIZE];
n = connection_read(&connection, buffer, BUFFER_SIZE, TIMEOUT_MSEC); 

参照:

connection_write(), connection_readline()

改行文字までの受信

改行文字までのデータを受信する。

引数:

[in,out]	connection	通信リソース
[in]	data	受信データを格納するバッファ
[in]	max_size	受信データを格納できるバイト数
[in]	timeout	タイムアウト時間 [msec]

戻り値:

>=0	受信データ数
<0	エラー

data には、'\0' 終端された文字列が max_size を越えないバイト数だけ格納される。 つまり、受信できる文字のバイト数は、最大で max_size - 1 となる。

改行文字は '\r' または '\n' とする。

受信した最初の文字が改行の場合は、0 を返し、1 文字も受信しなかったときは URG_CONNECTION_TIMEOUT を返す。

参照:

connection_write(), connection_read()

送信

データを送信する。

引数:

[in,out]	connection	通信リソース
[in]	data	送信データ
[in]	size	送信バイト数

戻り値:

>=0	送信データ数
<0	エラー

Example

  n = connection_write(&connection, "QT\n", 3); 

参照:

connection_read(), connection_readline()