通信用動的ライブラリのインターフェース

通信用動的ライブラリのインターフェースには次のAPIが用意されています。

関数 説明
criAcApiClient_Initialize 通信用ライブラリの初期化を行います
criAcApiClient_Finalize 通信用ライブラリを終了します
criAcApiClient_Connect CRI Atom Craft との接続を行います
criAcApiClient_Disconnect CRI Atom Craft との接続を解除します
criAcApiClient_GetStatus CRI Atom Craft との接続状態を取得します
criAcApiClient_Call CRI Atom Craft へコマンド文字列を送信し、完了を待機します
criAcApiClient_GetResponseBufferLength CRI Atom Craft でのAPI実行結果が格納されたJSON文字列の長さを取得します
criAcApiClient_GetResponseBuffer CRI Atom Craft でのAPI実行結果が格納されたJSON文字列を取得します
覚え書き
通信用動的ライブラリは、Python以外の他プログラミング言語からロボットを実行させる場合にのみ使用します。
詳細は 他プログラミング言語からの実行 を参照してください。


criAcApiClient_Initialize

通信用ライブラリの初期化を行います。

書式

int criAcApiClient_Initialize(void);

入力パラメーター

なし

戻り値

成功した場合は 0, 失敗した場合は 0 以外


criAcApiClient_Finalize

通信用ライブラリを終了します。

書式

void criAcApiClient_Finalize(void);

入力パラメーター

なし

戻り値

なし


criAcApiClient_Connect

CRI Atom Craft との接続を行います。

書式

int criAcApiClient_Connect(const char* hostIpAddress, unsigned short port);

入力パラメーター

名前値
hostIpAddressCRI Atom Craft のIPアドレス
port接続に使用するポート番号

戻り値

成功した場合は 0, 失敗した場合は 0 以外


criAcApiClient_Disconnect

CRI Atom Craft との接続を解除します。

書式

void criAcApiClient_Disconnect(void);

入力パラメーター

なし

戻り値

なし


criAcApiClient_GetStatus

CRI Atom Craft との接続状態を取得します。

書式

int criAcApiClient_GetStatus(void);

入力パラメーター

なし

戻り値

接続状態の場合は 0, 接続状態でない場合は 0 以外


criAcApiClient_Call

CRI Atom Craft へコマンド文字列を送信し、完了を待機します。

書式

int criAcApiClient_Call(const char* json_request, int json_request_len);

入力パラメーター

名前値
hostIpAddressCRI Atom Craft のIPアドレス
port接続に使用するポート番号

戻り値

成功した場合、0 以上
失敗した場合、0 未満


criAcApiClient_GetResponseBufferLength

CRI Atom Craft でのAPI実行結果が格納されたJSON文字列の長さを取得します。

書式

int criAcApiClient_GetResponseBufferLength(void);

入力パラメーター

なし

戻り値

JSON文字列の長さ（終端文字を含まない）


criAcApiClient_GetResponseBuffer

CRI Atom Craft でのAPI実行結果が格納されたJSON文字列を取得します。
バッファーには、 criAcApiClient_GetResponseBufferLength に加え、終端文字の長さも必要です。
このため、 criAcApiClient_GetResponseBufferLength で得た値に +1 をした長さのバッファーが最低必要です。

書式

int criAcApiClient_GetResponseBuffer(char* buffer, int buffer_length);

入力パラメーター

名前値
bufferAPI実行結果の文字列を書き込むための文字列バッファー
buffer_lengthバッファーに書き込むことができる文字列の長さ

戻り値

成功した場合は 0, 失敗した場合は 0 以外