21: 2013-03-30 (Sat) 18:27:17 takaboo source Cur: 2021-03-27 (Sat) 08:17:58 takaboo source
Line 1: Line 1:
-TITLE:Dynamixel Library+TITLE:Dynamixel Protocol Library
**概要 [#va21cbfb] **概要 [#va21cbfb]
-Dynamixel LibraryはDynamixelの通信プロトコルをサポートした製品をWindows等のOSから操作するためのライブラリ集です。+Dynamixel Protocol LibraryはDynamixel Protocol 1の通信プロトコルをサポートした製品をWindows等のOSから操作するためのライブラリ集です。
-従来はユーザ自らシリアル通信に関するAPIを使用してタイミングやエラー処理を加えて利用するものでしたが、本APIを介する事でシリアル通信である事をほとんど意識すること無くアプリケーションの作りこみに専念することができるはずです。+シリアル通信に関するAPI、タイミングやエラー処理、プロトコルの整合性チェック等を本ライブラリ内で行っているため、シリアル通信である事をほとんど意識すること無くアプリケーションの作りこみに専念することができます。
-なお、PCと[[BTE061D]]・[[BTE068]]・[[BTE082]]・[[BTE083]]のいずれかがUSBケーブルで接続され、PC上にWindowsのデバイスとして仮想COMポートが増設された状態で使用するものとします。+なお、PCと[[BTE061D]]・[[BTE061E]]・[[BTE068]]・[[BTE068B]]・[[BTE068C]]・[[BTE082]]・[[BTE083]]・[[BTE074]]・[[BTE079]]・[[BTE080]]・[[BTE079B]]・[[BTE080B]]・[[BTX229>http://emanual.robotis.com/docs​/en/parts/interface/u2d2/]]のいずれかがUSBポートに接続され、PCのOSに仮想COMポートが増設された状態で使用するものとします。
**ライブラリおよびサンプルプログラムのダウンロード [#j8bd290f] **ライブラリおよびサンプルプログラムのダウンロード [#j8bd290f]
以下のリンクよりライブラリ及びサンプルプログラムをアーカイブしたファイルがダウンロードできます。 以下のリンクよりライブラリ及びサンプルプログラムをアーカイブしたファイルがダウンロードできます。
--''2013/03/28 Ver.2.8''~ +-''2021/1/22 Ver.4.4''~ 
-#ref(http://www.besttechnology.co.jp/download/DXLIBforWin2.8.zip)+#ref(https://www.besttechnology.co.jp/download/DXLIB_V4.4.zip) 
 +内容 
 +--新しく追加されたDynamixelの定義を追加 
 +--makedll.batの内容を一部変更 
 +-2019/11/15 Ver.4.3~ 
 +#ref(https://www.besttechnology.co.jp/do​wnload/DXLIB_V4.3.zip) 
 +内容 
 +--Visual Studio上での動作検証を行いヘッダを一部修正 
 +--ライブラリソースのエンコードをUTF-8のBOM付きに統一 
 +--新しく追加されたDynamixelの定義を追加 
 +-2019/03/27 Ver.4.2~ 
 +#ref(https://www.besttechnology.co.jp/do​wnload/DXLIB_V4.2.zip) 
 +内容 
 +--追加APIの正式リリース 
 +--C言語による追加APIのサンプルプログラムを拡充 
 +--Pythonによるサンプルプログラムを拡充 
 +-2016/07/13 Ver.3.3~ 
 +#ref(https://www.besttechnology.co.jp/do​wnload/DXLIB_V3.3.zip) 
 +内容 
 +--Linux上でのttyの初期化処理を修正 
 +--Linux上でのスリープ命令をusleepに置換する様に変更 
 +-2016/01/12 Ver.3.2~ 
 +#ref(https://www.besttechnology.co.jp/do​wnload/DXLIB_V3.2.zip) 
 +内容 
 +--ヘッダファイルを最近のVCで使用するとエラーになるのを修正 
 +--DLLMainの不用意な呼び出しで余計な処理をしないよう対応 
 +--デバイス毎に異なるパケットサイズの制限のうち最小に合わせていたが、ライブラリ内では250バイトとする 
 +--GCCがやたらエラーを吐くので、ライブラリソースのエンコードをUTF-8に統一 
 +-2015/11/18 Ver.3.1~ 
 +#ref(https://www.besttechnology.co.jp/do​wnload/DXLIB_V3.1.zip) 
 +内容 
 +--TDxAlarmStatus構造体のアライメントがGCCのバージョンによって1バイト境界にならない事があるのを修正 
 +--ヘッダファイルの一部の記述がMSVCに対応していなかったのを修正 
 +--DX_SetBaudrateの処理に待ち時間を挿入 
 +-2014/06/11 Ver.3.0~ 
 +#ref(https://www.besttechnology.co.jp/do​wnload/DXLIB_V3.0.zip) 
 +内容 
 +--各APIのアドレス指定が8bit幅だったものを16bitに拡張(後継のDYNAMIXEL2に合わせた) 
 +--TDxAlarmStatus構造体のアライメントを1バイト境界に変更 
 +--不定なDevice IDを指定された際のクラッシュを簡易的にブロック 
 +--似非ReadSync APIを追加 
 +--DX_Reset処理後に1秒の待ち時間を挿入 
 +--dllのソースをC++に 
 +--API引数の変更に伴い各サンプルを修正 
 +--LabVIEWのサンプルを大幅に拡充 
 +--EXCELのVBAを64bitに対応 
 +--アーカイブファイル名を変更 
 +-2013/10/10 Ver.2.9.1~ 
 +内容 
 +--DX_SetTimeOutOffsetでオフセットタイムを指定していない場合のデフォルト値が0ではタイムアウトが生じやすいため20に変更 
 +--DX_Ping2の検索最大数を254に修正 
 +--DXLIB.pasに追加したDX_SetTimeOutOffsetの定義ミスを修正 
 +-2013/09/15 Ver.2.9~ 
 +内容 
 +--タイムアウトの値を見定めるのが困難という事から基本的に引数から排除し、内部で理論値を算出する様に変更。 
 +--タイムアウト以外にタイムラグが必要ということでDX_SetTimeOutOffsetを新設。 
 +--USB搭載のマイコンのファームにおいてポートオープンの状態検出の仕様を変更したため、DTRの制御をイネーブルに変更。 
 +--DX_ChangeBaudrateをDX_SetBaudrateに改名。 
 +--サイズを指定する引数はuint32_tに統一。 
 +--Linux対応をさらに進め、USB搭載のマイコン等でioctlによるボーレートの変更が使えないケースに一部対応。 
 +--Win32とLinuxの相違部分を整理して多少見やすくしてみた。 
 +-2013/03/28 Ver.2.8.1~ 
 +内容 
 +--DX_Ping2の初期化部において不定なTDevicdIDを想定していなかったのを修正。 
 +-2013/03/28 Ver.2.8~
内容 内容
--名称をDXLIB2からDXLIBに戻す。 --名称をDXLIB2からDXLIBに戻す。
Line 21: Line 85:
--デバイスからのアラームステータスがAPIの応答に反映されないケースを修正。 --デバイスからのアラームステータスがAPIの応答に反映されないケースを修正。
-2011/07/20 Ver.2.6~ -2011/07/20 Ver.2.6~
-#ref(http://www.besttechnology.co.jp/dow​nload/DXLIB2forWin2.6.zip) 
内容 内容
--DX_SyncWriteDataをDX_WriteSyncDataへ改名。 --DX_SyncWriteDataをDX_WriteSyncDataへ改名。
Line 28: Line 91:
--古いバージョンのmatlabがDEVICEIDを誤認するため型を変更。 --古いバージョンのmatlabがDEVICEIDを誤認するため型を変更。
-2011/03/28 Ver.2.5.1~ -2011/03/28 Ver.2.5.1~
-#ref(http://www.besttechnology.co.jp/dow​nload/DXLIB2forWin2.5.1.zip) 
内容 内容
--放置していたLinuxへの対応をマトモに見直し。 --放置していたLinuxへの対応をマトモに見直し。
-2011/03/16 Ver.2.5~ -2011/03/16 Ver.2.5~
-#ref(http://www.besttechnology.co.jp/dow​nload/DXLIB2forWin2.5.zip) 
内容 内容
--内部のイベント処理をさらに整理しパフォーマンスを改善。 --内部のイベント処理をさらに整理しパフォーマンスを改善。
Line 38: Line 99:
--DELPHI向けのサンプル追加。 --DELPHI向けのサンプル追加。
-2011/03/08 Ver.2.4~ -2011/03/08 Ver.2.4~
-#ref(http://www.besttechnology.co.jp/dow​nload/DXLIB2forWin2.4.zip) 
内容 内容
--内部のイベント処理が一部破綻していたのを修正。 --内部のイベント処理が一部破綻していたのを修正。
Line 44: Line 104:
--ゴミデータ受信時の停滞を解消。 --ゴミデータ受信時の停滞を解消。
-2011/03/03 Ver.2.3 -2011/03/03 Ver.2.3
-#ref(http://www.besttechnology.co.jp/dow​nload/DXLIB2forWin2.3.zip) 
内容 内容
--内部のイベント処理がことごとく破綻していたのを修正。 --内部のイベント処理がことごとく破綻していたのを修正。
Line 50: Line 109:
--BROADCASTING IDを使用したPING(DX_Ping2)を追加。 --BROADCASTING IDを使用したPING(DX_Ping2)を追加。
-2011/02/02 Ver.2.2 -2011/02/02 Ver.2.2
-#ref(http://www.besttechnology.co.jp/dow​nload/DXLIB2forWin2.2.zip) 
内容 内容
--ライブラリ構築のオプションを修正し、各言語毎の呼出規約に囚われないファンクション名を吐く様にした。 --ライブラリ構築のオプションを修正し、各言語毎の呼出規約に囚われないファンクション名を吐く様にした。
-2011/02/01 Ver.2.1~ -2011/02/01 Ver.2.1~
-#ref(http://www.besttechnology.co.jp/dow​nload/DXLIB2forWin2.1.zip) 
内容 内容
--呼出規約をstdcallに変更 --呼出規約をstdcallに変更
Line 60: Line 117:
--新規ターゲット向けにサンプルを追加~ --新規ターゲット向けにサンプルを追加~
-2010/12/24 Ver.2.0~ -2010/12/24 Ver.2.0~
-#ref(http://www.besttechnology.co.jp/dow​nload/DXLIB2forWin2.0.zip) 
内容 内容
--初期リリース~ --初期リリース~
-アーカイブファイルには以下のファイルが同梱されます。必要に応じて解凍してください。(注意:Ver2.8以降の記述に更新されています)+アーカイブファイルには以下のファイルが同梱されます。必要に応じて解凍してください。(※最新版のフォルダ構成を記載しています)
|DXLIB|dxlib_x32.dll|<|ライブラリ本体 | |DXLIB|dxlib_x32.dll|<|ライブラリ本体 |
|~|dxlib_x64.dll|<|~| |~|dxlib_x64.dll|<|~|
Line 71: Line 127:
|~|dxlib_x32.llb|<|MSVC用ライブラリ(定義のみ) | |~|dxlib_x32.llb|<|MSVC用ライブラリ(定義のみ) |
|~|dxlib_x64.lib|<|~| |~|dxlib_x64.lib|<|~|
-|~|dxlib.c|<|ライブラリソース |+|~|dxlib.cpp|<|ライブラリソース |
|~|dxlib.h|<|ライブラリヘッダ | |~|dxlib.h|<|ライブラリヘッダ |
|~|dxlib_matlab.h|<|matlab用ヘッダ | |~|dxlib_matlab.h|<|matlab用ヘッダ |
 +|~|dxlib.py|<|python用API定義 |
|~|dxmemmap.h|<|DX/AX/RX/EX/MXシリーズ用コントロールテーブル定義ヘッダ | |~|dxmemmap.h|<|DX/AX/RX/EX/MXシリーズ用コントロールテーブル定義ヘッダ |
|~|makelib.bat|<|ライブラリ再構築用バッチ | |~|makelib.bat|<|ライブラリ再構築用バッチ |
|~|83.bat|<|~| |~|83.bat|<|~|
-|SampleCode|GCCDeveloperLite|smpl1(template).c |サンプル +|SampleCode|GCCDeveloperLite|smpl*.c |サンプル |
-|~|~|smpl2(ping).c |~| +
-|~|~|smpl3(byte_rw).c |~| +
-|~|~|smpl4(word_rw).c |~| +
-|~|~|smpl5(multithread).c |~| +
-|~|~|smpl6(sync).c |~| +
-|~|~|smpl7(rawpacket).c |~| +
-|~|~|smpl8(dualport).c |~| +
-|~|~|smpl9(DynamicLoad).c |~| +
-|~|~|smpl10(USS3).c |~|+
|~|~|dxlib.h |DXLIBフォルダに収録されるものと同一 | |~|~|dxlib.h |DXLIBフォルダに収録されるものと同一 |
|~|~|dxmemmap.h |~| |~|~|dxmemmap.h |~|
Line 97: Line 145:
|~|~|dxlib_x32.dll |DXLIBフォルダに収録されるものと同一 | |~|~|dxlib_x32.dll |DXLIBフォルダに収録されるものと同一 |
|~|~|dxlib_x64.dll |~| |~|~|dxlib_x64.dll |~|
-|~|LabVIEW2010|sample.vi |サンプル | +|~|LabVIEW2011|sample*.vi |サンプル | 
-|~|~|sample_mx.vi |~+|~|~|DXLIB.llb |dllの呼び出しをvi化
-|~|~|synctest.vi |~+|~|~|DXLIB_DXL.llb |dllの呼び出しをvi化
-|~|~|dbyte2byte.vi |サブvi | +|~|~|DXLIB_Wrapper.llb |アクチュエータに特化したvi |
-|~|~|dbyte2word.vi |~| +
-|~|~|errcnt.vi |~| +
-|~|~|DXLIB.llb |DXLIBラッパーライブラリ |+
|~|~|dxlib_x32.dll |DXLIBフォルダに収録されるものと同一 | |~|~|dxlib_x32.dll |DXLIBフォルダに収録されるものと同一 |
|~|EXCEL|text.xls |サンプルシート | |~|EXCEL|text.xls |サンプルシート |
|~|~|dxlib_x32.dll |DXLIBフォルダに収録されるものと同一 | |~|~|dxlib_x32.dll |DXLIBフォルダに収録されるものと同一 |
|~|~|dxlib_x64.dll |~| |~|~|dxlib_x64.dll |~|
-|~|Linux|smpl2.c |サンプル | +|~|Linux|smpl*.c |サンプル | 
-|~|~|smpl4.c |~+|~|Ruby|smpl*.rb |サンプル
-|~|Ruby|SMPL1.c |サンプル | +|~|Python|smpl*.py |サンプル | 
-|~|~|SMPL3.c |~+|~|~|dxlib.py |DXLIBフォルダに収録されるものと同一
-|~|Python|SMPL1.py |サンプル +|~|~|dxlib_x32.dll |~
-|~|~|SMPL3.py |~|+|~|~|dxlib_x64.dll |~|
**開発環境毎の設定 [#u3ff03d9] **開発環境毎の設定 [#u3ff03d9]
-ここでは3つのツールで使用する場合の設定方法を説明します。ここで紹介しないツールでも必要とされる操作は概ね同様ですが、全てに対応できるとまでは明言しません。+サンプルを元にいくつかのツール・環境で使用する場合の設定方法を説明します。ここで紹介されないツールにおいても、dllを利用できるのであれば必要とされる操作は概ね同様だと思います。、
***GCC Developer Lite [#e1d4017c] ***GCC Developer Lite [#e1d4017c]
Line 141: Line 186:
****DLLの動的リンク [#y15bf22f] ****DLLの動的リンク [#y15bf22f]
-動的にDLLを使用する場合はDLL事態をコンパイラオプションへ追記する必要はありません。その代わりにソース中でdxlib.hをインクルードする前に_DYNAMICLOADマクロを定義しておきます。+動的にDLLを使用する場合はDLL自体をコンパイラオプションへ追記する必要はありません。その代わりにソース中でdxlib.hをインクルードする前に_DYNAMICLOADマクロを定義しておきます。
 #define _DYNAMICLOAD  #define _DYNAMICLOAD
 #include "dxlib.h"  #include "dxlib.h"
Line 175: Line 220:
***National Instruments LabVIEW [#mdd5d507] ***National Instruments LabVIEW [#mdd5d507]
-'SampleCode\LabVIEW2010'フォルダにサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。~ +'SampleCode\LabVIEW2011'フォルダにサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。~ 
-[[LabVIEW2010:http://www.ni.com/labview/ja/]]には外部のDLLへアクセスする手段が提供されています。しかしながらDXLIBそのままの定義ではLabVIEWからは使いづらいため、サンプルプログラムではサブviでラッピングしてDXLIB.llbにまとめて提供しています。+[[LabVIEW:http://www.ni.com/labview/ja/]]には外部のDLLへアクセスする手段が提供されています。しかしながらDXLIBそのままの定義ではLabVIEWからは使いづらいため、サンプルプログラムではサブviでラッピングしてDXLIB.llbにまとめて提供しています。
#ref(vi_frontpanel.png) #ref(vi_frontpanel.png)
#ref(vi_diagram.png) #ref(vi_diagram.png)
 +
 +****関数パレットへの登録 [#v135be5a]
 +DXLIB.llbから各viを開き、開いたviの右上にあるアイコンを自分のブロックダイアグラムにドラッグドロップするという操作でviを使用しても良いのですが、頻繁に操作するとなると少々煩雑です。~
 +関数パレットに登録すればスムーズに操作できますので、その手順を紹介します。
 ++LabVIEWのメニューの「ツール」→「上級」→パレットセットを編集」をクリック。
 +#ref(lvmenu_step1.png,100%)
 ++開いた関数パレットの空いたスペースで右クリックし、ポップアップメニューから「挿入」→「サブパレット」をクリック。
 +#ref(lvmenu_step2.png,100%)
 ++開いたダイアログボックスから「LLBへリンク(.llb)」を選びOKを押す。
 +#ref(lvmenu_step3.png,100%)
 ++LLBを選択するファイルダイアログボックスから、先に解凍したファイルの中から「DXLIB.llb」を選択しOKを押す。
 +#ref(lvmenu_step4.png,100%)
 ++次の様なメニューが追加されたらOK。
 +#ref(lvmenu_step5.png,100%)
***DELPHI [#bdd8ef87] ***DELPHI [#bdd8ef87]
Line 186: Line 245:
***VB [#p8d7963b] ***VB [#p8d7963b]
'SampleCode\EXCEL'フォルダにサンプルが同梱されます。~ 'SampleCode\EXCEL'フォルダにサンプルが同梱されます。~
-ここではVBと似たMicrosoft OfficeのVBAを使用し、マクロの標準モジュールにDXLIB2HEADという名称でDLLに含まれるいくつかのAPIを定義しました。+ここではVBと似たMicrosoft OfficeのVBAを使用し、マクロの標準モジュールにDXLIB_HEADという名称でDLLに含まれるいくつかのAPIが定義してあります。
-Module1にPingTestとMotorTestというマクロを記述しましたので、ワークシートから適宜マクロを呼び出して実行してください。結果がシート上に反映されます。+Module1にPingTestとMotorTestというマクロが記述されていますので、ワークシートから適宜マクロを呼び出して実行してください。結果がシート上に反映されます。 
 + 
 +なお、Officeにも32bit版と64bit版があるため、Declare宣言の方法が異なります。その部分はDXLIB_HEADにて判定していますので、参考にしてください。
***Ruby [#r63b1e3e] ***Ruby [#r63b1e3e]
Line 201: Line 262:
***Python [#mc6a5a49] ***Python [#mc6a5a49]
-'SampleCode\Ruby'フォルダにサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。~ +'SampleCode\Python'フォルダにサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。~ 
-[[Python:http://www.python.jp/Zope]]はオープンソースの動的なプログラミング言語で、外部のDLLへ簡易にアクセスすることが出来ます。~ +[[Python:http://www.python.jp/]]はオープンソースの動的なプログラミング言語で、外部のDLLへ簡易にアクセスすることが出来ます。~ 
-LinuxでLoadLibraryを呼び出す際はcdllインスタンスを使用します。 +各APIのPython用の宣言を定義したdxlib.pyをimportするだけで済みます。 
-  dxlib = windll.LoadLibrary( "dxlib_x32.dll" )  # for window + from dxlib import *   # dxlibをインポート
-  dxlib = cdll.LoadLibrary( "./dxlib.so" )   # for linux+
***Java [#ceff395d] ***Java [#ceff395d]
***MathWorks MATLAB [#mad2ebed] ***MathWorks MATLAB [#mad2ebed]
-[[MATLAB:http://www.mathworks.co.jp/prod​ucts/matlab]]からの使用例を紹介します。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して下さい。~+[[MATLAB:http://www.mathworks.co.jp/prod​ucts/matlab]]からの使用例を紹介します。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して下さい。また、mex-setupにて[[Cコンパイラを選択>http://www.mathworks.co.jp/jp/help/matl​ab/matlab_external/building-mex-files.ht​ml#f23734]]しておく必要があります。~
+事前準備 +事前準備
-~まずはMATLAB起動後、「ファイル(F)」→「パス設定(H)」でdxlib_x32.dllとdxlib_matlab.hの格納されたパスを指定します。dxlib.hはMATLABでは解釈できない記述が多いため使用しないでください。+~まずはMATLAB起動後、「ファイル(F)」→「パス設定(H)」でdxlib_x32.dll(MATALBが64bitの場合はdxlib_x64.dll)とdxlib_matlab.hの格納されたパスを指定します。dxlib.hはMATLABでは解釈できない記述が多いため使用しないでください。~
+DLLのロード +DLLのロード
 loadlibrary('dxlib_x32.dll','dxlib_matl​ab.h','alias','dxlib')  loadlibrary('dxlib_x32.dll','dxlib_matl​ab.h','alias','dxlib')
Line 221: Line 281:
~TErrorCodeはポインタで引き渡しているため、事前に型宣言をしておきます。値はErr.Valueで取得可能です。必要なければ0を指定しても構いません。 ~TErrorCodeはポインタで引き渡しているため、事前に型宣言をしておきます。値はErr.Valueで取得可能です。必要なければ0を指定しても構いません。
 Err = libpointer('uint16Ptr', 0);  Err = libpointer('uint16Ptr', 0);
- Ret = calllib('dxlib', 'DX_Ping', devid, 1, 10, Err);+ Ret = calllib('dxlib', 'DX_Ping', devid, 1, Err);
 fprintf('%x', Err.Value);  fprintf('%x', Err.Value);
+ポートのクローズ +ポートのクローズ
Line 230: Line 290:
***Linux [#w5c096b8] ***Linux [#w5c096b8]
-Linux上でのdxlibのコンパイル方法を紹介します。~+Linux上でdxlibをコンパイルする方法を紹介します。~
+コンパイル準備~ +コンパイル準備~
ダウンロードファイルを解凍~ ダウンロードファイルを解凍~
-+オブジェクトファイルの作成++ライブラリファイルの生成
-  gcc dxlib.c -o dxlib.o+ $ gcc -c -D__MAKE_LIB__ dxlib_intuitive.cpp dxlib.cpp 
 + $ ar -rcsv libdxlib.a dxlib_intuitive.o dxlib.o
+共有ライブラリの作成~ +共有ライブラリの作成~
-RubyやPython等で使用する場合のみ。+RubyやPython等で使用する場合等
-  gcc -fPIC -shared dxlib.c -o dxlib.so + $ gcc -fPIC -shared -D__MAKE_LIB__ dxlib_intuitive.cpp dxlib.cpp -o dxlib.so.4.2 
-+コンパイル++ユーザプログラムとのリンク
-dxlibのオブジェクトファイルとC言語ソースを合わせてコンパイルする。~+生成したライブラリファイルと自身のソースをリンクする。~
ポート・ボーレート等は使用する環境に合わせて適宜追加・修正する。~ ポート・ボーレート等は使用する環境に合わせて適宜追加・修正する。~
ライブラリは必要に合わせて追加する。~ ライブラリは必要に合わせて追加する。~
-  gcc sample.c dxlib.o -o sample+ $ gcc sample.c -ldxlib -o sample 
 + 
 +なお、コンパイルや実行にあたってI/Fやカーネル・ディストリビューションに依存するのがLinuxですので、そのまま使用できない場合は適宜ソースを修正下さい。
**API [#ybae1454] **API [#ybae1454]
-Dynamixel Libraryではシリアル通信を直接意識するコードを記述せずに、対象IDのデバイスのコントロールテーブルへの読み書き行うAPIを用意しています。+本ライブラリはシリアル通信を行うコードを記述しなくて良いのですが、デバイスIDという番号を用いて使用するシリアルI/Fを一元的に管理します。また、制御対象となるDynamixelのIDを指定し、そのコントロールテーブルへの読み書き行うAPIが用意されています。
-C言語のソースにdxlib.hをインクルードすれば、APIを使用するのに必要なプロトタイプとマクロの定義がなされます。+自身のC言語で記述されたソースプログラムにdxlib.hをインクルードする事で、APIを使用するのに必要なプロトタイプとマクロの定義がなされます。 
 + 
 +''注意事項'':~ 
 +DynamixelのStatus Return Levelを必ず''2''に設定した上で使用する事。それ以外の値が設定されていた場合はAPIが想定した応答が得られず、タイムアウトするまでAPIから返らない。
***DX_OpenPort [#zbd2f6ef] ***DX_OpenPort [#zbd2f6ef]
-ライブラリの内部情報を初期化すると同時に指定されたCOMポートをオープンし、ユニークな[[TDeviceID>#TDeviceID]]を返す。以後はこの[[TDeviceID>#TDeviceID]]を使用して各APIを使用する。~ +ライブラリの内部情報を初期化すると同時に指定されたCOMポートをオープンし、[[DX_SetBaudrate>#ba9f52b8]]を使用して通信速度を設定した後、ユニークな[[TDeviceID>#TDeviceID]]を返す。以後はこの[[TDeviceID>#TDeviceID]]を使用して各APIを使用する。~ 
-複数のCOMポートを使用する場合は、使用するポート毎にDX_OpenPortを行い[[TDeviceID>#TDeviceID]]を取得しなくてはならない。 +複数のCOMポートを使用する場合は、使用するポート毎にDX_OpenPortを行い[[TDeviceID>#TDeviceID]]を取得しなくてはならない。
- TDeviceID DX_OpenPort (char *name, long baud);+なお、Linuxにおけるボーレートの指定に関しては、[[DX_SetBaudrate>#ba9f52b8]]の解説に注意の事。 
 + TDeviceID DX_OpenPort (char *name, uint32_t baud);
-パラメータ -パラメータ
--char '''*name''' --char '''*name'''
Line 286: Line 353:
 }  }
-***DX_ChangeBaudrate [#ba9f52b8]+***DX_SetBaudrate [#ba9f52b8]
既にオープンされている[[TDeviceID>#TDeviceID]]の通信速度の変更を行う。~ 既にオープンされている[[TDeviceID>#TDeviceID]]の通信速度の変更を行う。~
-実行すると強制的に受信バッファがクリアされる。 +実行すると強制的に受信バッファがクリアされる。
- bool DX_ChangeBaudrate (TDeviceID dvid, long baud);+なお、Linux環境におけるボーレートの設定は、POSIX.1でサポートする値(50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400, 460800, 500000, 576000, 921600, 1000000, 1152000, 1500000, 2000000, 2500000, 3000000, 3500000, 4000000)であればtcsetattrを使用して処理するが、これらの値に当てはまらない場合はioctrlを使用する。その際I/Fがこれらのボーレートに対応していなかったり、ioctrlをサポートしない場合、本APIは失敗する。 
 + bool DX_SetBaudrate (TDeviceID dvid, long baud);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 304: Line 372:
 if (dev) {  if (dev) {
   // 通信速度を1M[bps]に変更    // 通信速度を1M[bps]に変更
-   DX_ChangeBaudrate (dev, 1000000);+   DX_SetBaudrate (dev, 1000000);
   ... (中略)    ... (中略)
   // クローズ    // クローズ
Line 331: Line 399:
   DX_ClosePort (dev);    DX_ClosePort (dev);
 }  }
 +
 +***DX_SetTimeOutOffset [#h4a1b54e]
 +I/FやOSの都合で生じるであろうタイムラグを予め設定する。~
 +ライブラリ内で想定した受信時間と指定されたタイムアウトオフセット時間を加算した時間を超えた場合に、タイムアウトエラーとして処理される。~
 +デフォルトは20。
 + void DX_SetTimeOutOffset (TDeviceID dvid, uint32_t offsettime);
 +-パラメータ
 +--[[TDeviceID>#TDeviceID]] '''dvid'''
 +~DX_OpenPortで開いた際の[[TDeviceID>#TDeviceID]]。
 +--uint32_t '''offsettime'''
 +~タイムアウトオフセット時間[ms]
 +-戻り値
 +--bool
 +~指定されたdvidが使用可能な場合はtrue、使用不可の場合はfalseを返す。
***DX_Ping [#v393b505] ***DX_Ping [#v393b505]
PINGインストラクションを使用して対象IDからの応答を確認する。 PINGインストラクションを使用して対象IDからの応答を確認する。
- bool DX_Ping (TDeviceID dvid, uint8_t id, int timeout, TErrorCode *err);+ bool DX_Ping (TDeviceID dvid, uint8_t id, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
~DX_OpenPortで開いた際の[[TDeviceID>#TDeviceID]]。 ~DX_OpenPortで開いた際の[[TDeviceID>#TDeviceID]]。
--uint8_t '''id''' --uint8_t '''id'''
-~対象とするID (0~253)。 +~対象とするID (0~254)。
---int '''timeout''' +
-~受信タイムアウト[ms]+
--[[TErrorCode>#TErrorCode]] '''*err''' --[[TErrorCode>#TErrorCode]] '''*err'''
~エラーコード。 ~エラーコード。
Line 354: Line 434:
 if (dev) {  if (dev) {
   // ID=1にPINGを発行    // ID=1にPINGを発行
-   if (DX_Ping (dev, 1, 100, &err))+   if (DX_Ping (dev, 1, &err))
     printf ("Found [%08X]\n", err);      printf ("Found [%08X]\n", err);
   else    else
Line 364: Line 444:
***DX_Ping2 [#g16504b3] ***DX_Ping2 [#g16504b3]
PINGインストラクションでBROADCASTING IDを指定して不特定の対象の応答を確認する。~ PINGインストラクションでBROADCASTING IDを指定して不特定の対象の応答を確認する。~
-BROADCASTING IDを指定した場合の応答がデバイスのシリーズによって差が生じるため、正確な情報を取得できない場合がある。 +応答時間がDynamixelの種類によって差があるため、それらが混在している環境では正確な情報を取得できない場合がある。 
- bool DX_Ping2 (TDeviceID dvid, int *num, TDxAlarmStatus *AlarmStatus, TErrorCode *err);+ bool DX_Ping2 (TDeviceID dvid, uint32_t *num, TDxAlarmStatus *AlarmStatus, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
~DX_OpenPortで開いた際の[[TDeviceID>#TDeviceID]]。 ~DX_OpenPortで開いた際の[[TDeviceID>#TDeviceID]]。
---int '''*num'''+--uint32_t '''*num'''
~検索する最大数及び検索で見つかったデバイス数の保存先。 ~検索する最大数及び検索で見つかったデバイス数の保存先。
--[[TDxAlarmStatus>#TDxAlarmStatus]] '''*AlarmStatus''' --[[TDxAlarmStatus>#TDxAlarmStatus]] '''*AlarmStatus'''
Line 383: Line 463:
 TErrorCode  err;  TErrorCode  err;
 uint8_t    id;  uint8_t    id;
- TDxAlarmStatus stat[253]; + TDxAlarmStatus stat[254]; 
- int        i, num = 100;+ int        i
 + uint32_t    num = 254;
 // オープン  // オープン
 dev = DX_OpenPort ("\\\\.\\COM10", 57143);  dev = DX_OpenPort ("\\\\.\\COM10", 57143);
 if (dev) {  if (dev) {
   // 不明な対象に対してPINGを発行    // 不明な対象に対してPINGを発行
 +   // numには予め254の値を指定したので、最大254台まで見つけようとする
   if (DX_Ping2 (dev, &num, stat, &err)) {    if (DX_Ping2 (dev, &num, stat, &err)) {
 +     // 1台以上見つかるとnumには見つかった数が返ってくる
     for (i = 0; i < num; i++)      for (i = 0; i < num; i++)
       printf ("Found ID=%d %02X\n", stat[i].id, stat[i].Status);        printf ("Found ID=%d %02X\n", stat[i].id, stat[i].Status);
Line 399: Line 482:
***DX_ReadByteData [#u7d86432] ***DX_ReadByteData [#u7d86432]
対象IDのコントロールテーブルから1バイトのデータを読み出す。 対象IDのコントロールテーブルから1バイトのデータを読み出す。
- bool DX_ReadByteData(TDeviceID dvid, uint8_t id, uint8_t adr, uint8_t *rdata, int timeout, TErrorCode *err);+ bool DX_ReadByteData(TDeviceID dvid, uint8_t id, uint16_t adr, uint8_t *rdata, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 405: Line 488:
--uint8_t '''id''' --uint8_t '''id'''
~対象とするID (0~253)。 ~対象とするID (0~253)。
---uint8_t '''adr'''+--uint16_t '''adr'''
~コントロールテーブルのアドレス。 ~コントロールテーブルのアドレス。
--uint8_t '''*rdata''' --uint8_t '''*rdata'''
~読み出した値の保存先。 ~読み出した値の保存先。
---int '''timeout''' 
-~受信タイムアウト[ms]。 
--[[TErrorCode>#TErrorCode]] '''*err''' --[[TErrorCode>#TErrorCode]] '''*err'''
~エラーコード。 ~エラーコード。
Line 424: Line 505:
 if (dev) {  if (dev) {
   // ID=1のAX-12からLEDの状態を取得    // ID=1のAX-12からLEDの状態を取得
-   if (DX_ReadByteData (dev, 1, 25, &dat, 100, &err)) {+   if (DX_ReadByteData (dev, 1, 25, &dat, &err)) {
     printf ("LED STAT=%d\n", dat);      printf ("LED STAT=%d\n", dat);
   }    }
Line 432: Line 513:
***DX_WriteByteData [#ma2205f0] ***DX_WriteByteData [#ma2205f0]
対象IDのコントロールテーブルへ1バイトのデータを書き込む。 対象IDのコントロールテーブルへ1バイトのデータを書き込む。
- bool DXAPIDLL DX_WriteByteData(TDeviceID dvid, uint8_t id, uint8_t adr, uint8_t dat, int timeout, TErrorCode *err);+ bool DX_WriteByteData(TDeviceID dvid, uint8_t id, uint16_t adr, uint8_t dat, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 438: Line 519:
--uint8_t '''id''' --uint8_t '''id'''
~対象とするID (0~253, 254)。 ~対象とするID (0~253, 254)。
---uint8_t '''adr'''+--uint16_t '''adr'''
~コントロールテーブルのアドレス。 ~コントロールテーブルのアドレス。
--uint8_t '''dat'''~ --uint8_t '''dat'''~
~書き込む値。 ~書き込む値。
---int '''timeout''' 
-~受信タイムアウト[ms]。 
--[[TErrorCode>#TErrorCode]] '''*err''' --[[TErrorCode>#TErrorCode]] '''*err'''
~エラーコード。 ~エラーコード。
Line 458: Line 537:
 if (dev) {  if (dev) {
   // ID=1のAX-12からLEDの状態を取得    // ID=1のAX-12からLEDの状態を取得
-   if (DX_ReadByteData (dev, 1, 25, &dat, 100, &err)) {+   if (DX_ReadByteData (dev, 1, 25, &dat, &err)) {
     dat ^= 1; // ビット反転      dat ^= 1; // ビット反転
     // ID=1のAX-12へLEDの状態を設定      // ID=1のAX-12へLEDの状態を設定
-     DX_WriteByteData (dev, 1, 25, dat, 100, &err);+     DX_WriteByteData (dev, 1, 25, dat, &err);
   }    }
   DX_ClosePort (dev);    DX_ClosePort (dev);
Line 468: Line 547:
***DX_ReadWordData [#x202d573] ***DX_ReadWordData [#x202d573]
対象IDのコントロールテーブルから1ワード(2バイト)のデータを読み出す。 対象IDのコントロールテーブルから1ワード(2バイト)のデータを読み出す。
- bool DX_ReadWordData(TDeviceID dvid, uint8_t id, uint8_t adr, uint16_t *rdata, int timeout, TErrorCode *err);+ bool DX_ReadWordData(TDeviceID dvid, uint8_t id, uint16_t adr, uint16_t *rdata, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 474: Line 553:
--uint8_t '''id''' --uint8_t '''id'''
~対象とするID (0~253)。 ~対象とするID (0~253)。
---uint8_t '''adr'''+--uint16_t '''adr'''
~コントロールテーブルのアドレス。 ~コントロールテーブルのアドレス。
--uint16_t '''*rdata''' --uint16_t '''*rdata'''
~読み出した値の保存先。 ~読み出した値の保存先。
---int '''timeout''' 
-~受信タイムアウト[ms]。 
--[[TErrorCode>#TErrorCode]] '''*err''' --[[TErrorCode>#TErrorCode]] '''*err'''
~エラーコード。 ~エラーコード。
Line 493: Line 570:
 if (dev) {  if (dev) {
   // ID=1のAX-12から現在位置を取得    // ID=1のAX-12から現在位置を取得
-   if (DX_ReadWordData (dev, 1, 36, &dat, 100, &err)) {+   if (DX_ReadWordData (dev, 1, 36, &dat, &err)) {
     printf ("PRESENT POS=%d\n", dat);      printf ("PRESENT POS=%d\n", dat);
   }    }
Line 501: Line 578:
***DX_WriteWordData [#pcc1b3ce] ***DX_WriteWordData [#pcc1b3ce]
対象IDのコントロールテーブルへ1ワード(2バイト)のデータを書き込む。 対象IDのコントロールテーブルへ1ワード(2バイト)のデータを書き込む。
- bool DX_WriteWordData(TDeviceID dvid, uint8_t id, uint8_t adr, uint16_t dat, int timeout, TErrorCode *err);+ bool DX_WriteWordData(TDeviceID dvid, uint8_t id, uint16_t adr, uint16_t dat, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 507: Line 584:
--uint8_t '''id''' --uint8_t '''id'''
~対象とするID (0~253, 254)。 ~対象とするID (0~253, 254)。
---uint8_t '''adr'''+--uint16_t '''adr'''
~コントロールテーブルのアドレス。 ~コントロールテーブルのアドレス。
--uint16_t '''dat''' --uint16_t '''dat'''
~書き込む値。 ~書き込む値。
---int '''timeout''' 
-~受信タイムアウト[ms]。 
--[[TErrorCode>#TErrorCode]] '''*errcode''' --[[TErrorCode>#TErrorCode]] '''*errcode'''
~エラーコード。 ~エラーコード。
Line 526: Line 601:
 if (dev) {  if (dev) {
   // ID=1のAX-12へ位置(511)を指令    // ID=1のAX-12へ位置(511)を指令
-   DX_WriteWordData (dev, 1, 30, 511, 100, &err);+   DX_WriteWordData (dev, 1, 30, 511, &err); 
 +   DX_ClosePort (dev); 
 + } 
 + 
 +***DX_ReadLongData [#w341e7a5] 
 +対象IDのコントロールテーブルから2ワード(4バイト)のデータを読み出す。 
 + bool DX_ReadLongData(TDeviceID dvid, uint8_t id, uint16_t adr, uint32_t *rdata, TErrorCode *err); 
 +-パラメータ 
 +--[[TDeviceID>#TDeviceID]] '''dvid''' 
 +~DX_OpenPortで開いた際の[[TDeviceID>#TDeviceID]]。 
 +--uint8_t '''id''' 
 +~対象とするID (0~253)。 
 +--uint16_t '''adr''' 
 +~コントロールテーブルのアドレス。 
 +--uint32_t '''*rdata''' 
 +~読み出した値の保存先。 
 +--[[TErrorCode>#TErrorCode]] '''*err''' 
 +~エラーコード。 
 +-戻り値 
 +--bool 
 +~正常な応答が得られた場合はtrue、それ以外はfalseを返す。~ 
 +-使用例 
 + TDeviceID  dev; 
 + TErrorCode err; 
 + uint32_t  dat; 
 + // オープン 
 + dev = DX_OpenPort ("\\\\.\\COM10", 1000000); 
 + if (dev) { 
 +   // ID=1のXM430から現在位置を取得 
 +   if (DX_ReadLongData (dev, 1, 132, &dat, &err)) { 
 +     printf ("PRESENT POS=%d\n", dat); 
 +   } 
 +   DX_ClosePort (dev); 
 + } 
 + 
 +***DX_WriteLongData [#k42e5e5f] 
 +対象IDのコントロールテーブルへ2ワード(4バイト)のデータを書き込む。 
 + bool DX_WriteLongData(TDeviceID dvid, uint8_t id, uint16_t adr, uint32_t dat, TErrorCode *err); 
 +-パラメータ 
 +--[[TDeviceID>#TDeviceID]] '''dvid''' 
 +~DX_OpenPortで開いた際の[[TDeviceID>#TDeviceID]]。 
 +--uint8_t '''id''' 
 +~対象とするID (0~253, 254)。 
 +--uint16_t '''adr''' 
 +~コントロールテーブルのアドレス。 
 +--uint32_t '''dat''' 
 +~書き込む値。 
 +--[[TErrorCode>#TErrorCode]] '''*errcode''' 
 +~エラーコード。 
 +-戻り値 
 +--bool 
 +~正常な応答が得られた場合はtrue、それ以外はfalseを返す。~ 
 +BROADCASTING IDを指定した場合は応答待ちを行わない。 
 +-使用例 
 + TDeviceID  dev; 
 + TErrorCode err; 
 + // オープン 
 + dev = DX_OpenPort ("\\\\.\\COM10", 1000000); 
 + if (dev) { 
 +   // ID=1のXM430へ位置(1024)を指令 
 +   DX_WriteLongData (dev, 1, 30, 1024, &err);
   DX_ClosePort (dev);    DX_ClosePort (dev);
 }  }
Line 532: Line 667:
***DX_ReadBlockData [#b8a1ae1e] ***DX_ReadBlockData [#b8a1ae1e]
対象IDのコントロールテーブルから指定サイズのデータを読み出す。 対象IDのコントロールテーブルから指定サイズのデータを読み出す。
- bool DX_ReadBlockData (TDeviceID dvid, uint8_t id, uint8_t adr, uint8_t *rdata, int len, int timeout, TErrorCode *err);+ bool DX_ReadBlockData (TDeviceID dvid, uint8_t id, uint16_t adr, uint8_t *rdata, uint32_t len, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 538: Line 673:
--uint8_t '''id''' --uint8_t '''id'''
~対象とするID (0~253)。 ~対象とするID (0~253)。
---uint8_t '''adr'''+--uint16_t '''adr'''
~コントロールテーブルのアドレス。 ~コントロールテーブルのアドレス。
--uint8_t '''*rdata''' --uint8_t '''*rdata'''
~読み出したデータの保存先。 ~読み出したデータの保存先。
---int '''len'''+--uint32_t '''len'''
~読み出すデータのサイズ。 ~読み出すデータのサイズ。
---int '''timeout''' 
-~受信タイムアウト[ms]。 
--[[TErrorCode>#TErrorCode]] '''*err''' --[[TErrorCode>#TErrorCode]] '''*err'''
~エラーコード。 ~エラーコード。
Line 558: Line 691:
 if (dev) {  if (dev) {
   // ID=1のAX-12+からコンプライアンスのデータを取得    // ID=1のAX-12+からコンプライアンスのデータを取得
-   if (DX_ReadBlockData (dev, 1, 26, comp, 4, 100, &err) {+   if (DX_ReadBlockData (dev, 1, 26, comp, 4, &err) {
     printf (      printf (
     "CWM=%d CCWM=%d CWS=%d CCWS=%d\n",      "CWM=%d CCWM=%d CWS=%d CCWS=%d\n",
Line 569: Line 702:
***DX_WriteBlockData [#fcf55aa0] ***DX_WriteBlockData [#fcf55aa0]
対象IDのコントロールテーブルへ指定サイズのデータを書き込む。 対象IDのコントロールテーブルへ指定サイズのデータを書き込む。
- bool DX_WriteBlockData(TDeviceID dvid, uint8_t id, uint8_t adr, uint8_t *dat, int len, int timeout, TErrorCode *err);+ bool DX_WriteBlockData(TDeviceID dvid, uint8_t id, uint16_t adr, uint8_t *dat, uint32_t len, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 575: Line 708:
--uint8_t '''id''' --uint8_t '''id'''
~対象とするID (0~253, 254)。 ~対象とするID (0~253, 254)。
---uint8_t '''adr'''+--uint16_t '''adr'''
~コントロールテーブルのアドレス。 ~コントロールテーブルのアドレス。
--uint8_t '''*dat''' --uint8_t '''*dat'''
~書き込むデータの保存先。 ~書き込むデータの保存先。
---int '''len'''+--uint32_t '''len'''
~書き込むデータのサイズ。 ~書き込むデータのサイズ。
---int '''timeout''' 
-~受信タイムアウト[ms]。 
--[[TErrorCode>#TErrorCode]] '''*err''' --[[TErrorCode>#TErrorCode]] '''*err'''
~エラーコード。 ~エラーコード。
Line 596: Line 727:
 if (dev) {  if (dev) {
   // ID=1のAX-12+のコンプライアンスを変更    // ID=1のAX-12+のコンプライアンスを変更
-   DX_WriteBlockData (dev, 1, 26, comp, 4, 100, &err);+   DX_WriteBlockData (dev, 1, 26, comp, 4, &err);
   DX_ClosePort (dev);    DX_ClosePort (dev);
 }  }
 +
 +***DX_ReadSyncData [#oc111b2e]
 +SYNCインストラクションには読み出し機能が無いが、DX_ReadBlockDataを使用して指定された複数IDからブロック読み出しを行う。正確には「同期」していない。
 + bool DX_ReadSyncData (TDeviceID dvid, uint8_t *dat, uint32_t size, uint8_t *retdat, TErrorCode *err);
 +-パラメータ
 +--[[TDeviceID>#TDeviceID]] '''dvid'''
 +~DX_OpenPortで開いた際の[[TDeviceID>#TDeviceID]]。
 +--uint8_t '''*dat'''
 +~読み出す情報の保存先~
 +[addr][length][ID1][ID2]...[IDn]~
 +addr:先頭アドレス (1バイト)~
 +length:先頭アドレスからのバイト数 (1バイト)~
 +IDn:読み出す対象IDを列挙 (nバイト)。
 +--uint32_t '''size'''
 +~datのサイズ。
 +--uint8_t '''result'''~
 +読み出したデータの保存先~
 +[ID1][ALARM1][DATA1_0]....[DATA1_m]~
 +[ID2][ALARM2][DATA2_0]....[DATA2_m]~
 +...
 +[IDn][ALARMn][DATAn_0]....[DATAn_m]~
 +IDn:対象ID (1バイト)~
 +ALARMn:TErrorCode (2バイト)~
 +DATAn_m:読み出されたデータ
 +--[[TErrorCode>#TErrorCode]] '''*err'''
 +~エラーコード。
 +-戻り値
 +--bool
 +~指定された全てのIDに対する読み出しが正常に完了したらtrue、それ以外はfalseを返す。~
***DX_WriteSyncData [#v566e16b] ***DX_WriteSyncData [#v566e16b]
SYNCインストラクションを使用して複数IDへブロック書き込みを行う。~ SYNCインストラクションを使用して複数IDへブロック書き込みを行う。~
書き込まれるデータの構成はユーザに委ねられる。 書き込まれるデータの構成はユーザに委ねられる。
- bool DX_WriteSyncData (TDeviceID dvid, uint8_t *dat, int size, TErrorCode *err);+ bool DX_WriteSyncData (TDeviceID dvid, uint8_t *dat, uint32_t size, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 609: Line 769:
--uint8_t '''*dat''' --uint8_t '''*dat'''
~書き込むパラメータの保存先。 ~書き込むパラメータの保存先。
---int '''size'''+--uint32_t '''size'''
~パラメータのサイズ。 ~パラメータのサイズ。
--[[TErrorCode>#TErrorCode]] '''*err''' --[[TErrorCode>#TErrorCode]] '''*err'''
Line 619: Line 779:
 #define _POS1 (400)  #define _POS1 (400)
 #define _POS2 (511)  #define _POS2 (511)
 + 
 TDeviceID  dev;  TDeviceID  dev;
 TErrorCode err;  TErrorCode err;
Line 634: Line 794:
   _POS2 >> 8    _POS2 >> 8
 };  };
 + 
 dev = DX_OpenPort ("\\\\.\\COM10", 1000000);  dev = DX_OpenPort ("\\\\.\\COM10", 1000000);
 if (dev) {  if (dev) {
Line 644: Line 804:
***DX_TxPacket [#r051327a] ***DX_TxPacket [#r051327a]
任意のインストラクションパケットを送信する。 任意のインストラクションパケットを送信する。
- bool DX_TxPacket (TDeviceID dvid, uint8_t id, TInstruction inst, uint8_t *param, int len, TErrorCode *err);+ bool DX_TxPacket (TDeviceID dvid, uint8_t id, TInstruction inst, uint8_t *param, uint32_t len, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 654: Line 814:
--uint8_t '''*param''' --uint8_t '''*param'''
~送信するパラメータの保存先。 ~送信するパラメータの保存先。
---int '''len'''~+--uint32_t '''len'''~
~送信するパラメータのサイズ。 ~送信するパラメータのサイズ。
--[[TErrorCode>#TErrorCode]] '''*err''' --[[TErrorCode>#TErrorCode]] '''*err'''
Line 676: Line 836:
***DX_RxPacket [#r280cda8] ***DX_RxPacket [#r280cda8]
ステータスパケットを受信する。~ ステータスパケットを受信する。~
-基本的にDX_TxPacketとペアで使用する。ステータスパケットが得られない状況で使用するとタイムアウトするまで返らない。 +基本的にDX_TxPacketとペアで使用する。ステータスパケットが得られない状況で使用するとタイムアウトするまで返らない。
- bool DXAPIDLL DX_RxPacket (TDeviceID dvid, uint8_t *rdata, int rdatasize, int *rlen, int timeout, TErrorCode *err);+なお、本APIは[[DX_SetTimeOutOffset>#h4a1b54e]]で設定されたオフセット値は使用せず、引数で指定された受信タイムアウトのみが適用される。 
 + bool DX_RxPacket (TDeviceID dvid, uint8_t *rdata, uint32_t rdatasize, uint32_t *rlen, uint32_t timeout, TErrorCode *err);
-パラメータ -パラメータ
--[[TDeviceID>#TDeviceID]] '''dvid''' --[[TDeviceID>#TDeviceID]] '''dvid'''
Line 684: Line 845:
~受信バッファ。~ ~受信バッファ。~
ステータスパケットを受信するのに十分なサイズを確保しておく必要がある。 ステータスパケットを受信するのに十分なサイズを確保しておく必要がある。
---int '''readsize'''+--uint32_t '''readsize'''
~rdataのサイズ。~ ~rdataのサイズ。~
---int '''*rlen'''+--uint32_t '''*rlen'''
~実際に受信されたステータスパケットのサイズ。 ~実際に受信されたステータスパケットのサイズ。
--int '''timeout''' --int '''timeout'''
Line 695: Line 856:
~受信成功時はtrue、それ以外はfalseを返す。 ~受信成功時はtrue、それ以外はfalseを返す。
-使用例 -使用例
- int        i, len;+ int        i
 + uint32_t  len;
 TDeviceID  dev;  TDeviceID  dev;
 TErrorCode err;  TErrorCode err;
Line 702: Line 864:
   1,    // サイズ    1,    // サイズ
 };  };
 + 
 dev = DX_OpenPort ("\\\\.\\COM10", 1000000);  dev = DX_OpenPort ("\\\\.\\COM10", 1000000);
 if (dev) {  if (dev) {
Line 738: Line 900:
&aname(TErrorCode); &aname(TErrorCode);
:TErrorCode | ''(uint16_t)''~ :TErrorCode | ''(uint16_t)''~
-APIの内部処理とステータスパケットに含まれる16ビットのエラーコード。上位8ビットはAPI内部で検出したエラー、下位8ビットはステータスパケットに含まれるエラーフラグが割り当てられている。~+API内で検出される16ビットのエラーコード。上位8ビットはAPI内部で検出したエラー、下位8ビットはステータスパケットに含まれるエラーフラグが割り当てられている。~
|CENTER:|LEFT:|LEFT:|c |CENTER:|LEFT:|LEFT:|c
|bit|macro name| |h |bit|macro name| |h
Line 757: Line 919:
|1|ERR_DX_ANGLE|Angle Limitの範囲外にGoal Positionが指定された| |1|ERR_DX_ANGLE|Angle Limitの範囲外にGoal Positionが指定された|
|0|ERR_DX_OVERVOLTAGE|電源電圧が指定動作電圧の範囲を超えた| |0|ERR_DX_OVERVOLTAGE|電源電圧が指定動作電圧の範囲を超えた|
 +
 +**追加API [#i7e58b8f]
 +#include(DXL_intuitive,notitle)


Front page   Diff ReloadPrint View   Page list Search Recent changes   RSS of recent changes (RSS 1.0) RSS of recent changes (RSS 2.0) RSS of recent changes (RSS Atom)