Back to page

− Links

 Print 

Dynamixel Protocol 2 Library :: Besttechnology

knowledge:Dynamixel Protocol 2 Library

Table of contents
    • 概要
    • ライブラリおよびサンプルプログラムのダウンロード
    • 開発環境毎の設定
      • GCC Developer Lite
        • DLLの静的リンク
        • DLLの動的リンク
      • Microsoft Visual C++
      • National Instruments LabVIEW
      • DELPHI
      • VB
      • Ruby
      • Python
      • Java
      • MathWorks MATLAB
      • Linux
    • API
      • DX2_OpenPort
      • DX2_ClosePort
      • DX2_SetBaudrate
      • DX2_Active
      • DX2_SetTimeOutOffset
      • DX2_Ping
      • DX2_Ping2
      • DX2_Reset
      • DX2_Reboot
      • DX2_ReadByteData
      • DX2_WriteByteData
      • DX2_ReadWordData
      • DX2_WriteWordData
      • DX2_ReadLongData
      • DX2_WriteLongData
      • DX2_ReadBlockData
      • DX2_WriteBlockData
      • DX2_ReadSyncData
      • DX2_WriteSyncData
      • DX2_ReadBulkData
      • DX2_WriteBulkData
      • DX2_TxPacket
      • DX2_RxPacket
      • DX2LIBのオリジナルな定義
    • 追加API

概要 anchor.png[1]

Dynamixel Protocol 2 LibraryはDYNAMIXEL Communiation Protocol 2.0[2]に対応した製品をWindows等のOSから操作するためのライブラリ集です。
シリアル通信に関するAPI、タイミングやエラー処理、プロトコルの整合性チェック等をライブラリ内で行うため、シリアル通信である事をほとんど意識すること無くアプリケーションの作りこみに専念することができます。

なお、PCとBTE061D[3]BTE061E[4]BTE068[5]BTE068B[6]BTE082[7]BTE083[8]BTE074[9]BTE079[10]BTE080[11]BTE079B[12]BTE080B[13]BTX229[14]のいずれかがUSBポートに接続され、PCのOSに仮想COMポートが増設された状態で使用するものとします。

:idea:DYNAMIXEL Communiation Protocol 1.0[15]DYNAMIXEL Communiation Protocol 2.0[2]を装備した装置を同一ネットワーク上で同時に運用する事は推奨できない。
Page Top

ライブラリおよびサンプルプログラムのダウンロード anchor.png[16]

以下のリンクよりライブラリ及びサンプルプログラムをアーカイブしたファイルがダウンロードできます。

アーカイブファイルには以下のファイルが同梱されます。必要に応じて解凍してください(ベータ版では一部欠損)。

DX2LIBdx2lib_x32.dllライブラリ本体
dx2lib_x64.dll
libdx2lib_x32.aGCC用ライブラリ(定義のみ)
libdx2lib_x64.a
dx2lib_x32.llbMSVC用ライブラリ(定義のみ)
dx2lib_x64.lib
dx2lib.cライブラリソース
dx2lib.hライブラリヘッダ
dx2lib_matlab.hmatlab用ヘッダ
makelib.batライブラリ再構築用バッチ
83.bat
SampleCodeGCCDeveloperLitesmpl??.cサンプル
dx2lib.hDX2LIBフォルダに収録されるものと同一
dx2memmap.h
dx2lib_x32.dll
dx2lib_x64.dll
DELPHIProject1.dprサンプル
Unit1.dfm
Unit1.pas
DX2LIB.pas
dx2lib_x32.dllDX2LIBフォルダに収録されるものと同一
dx2lib_x64.dll
Pythonsmpl??.pyサンプル
dx2lib.pyDX2LIBフォルダに収録されるものと同一
dx2lib_x32.dllDX2LIBフォルダに収録されるものと同一
dx2lib_x64.dll
LabVIEW2011sample??.viサンプル
DX2LIB.llbDX2LIBラッパーライブラリ
DX2LIB_DXL.llbDX2LIBラッパーライブラリ
DX2LIB_Wrapper.llb
dx2lib_x32.dllDX2LIBフォルダに収録されるものと同一
EXCELtext.xlsサンプルシート
dx2lib_x32.dllDX2LIBフォルダに収録されるものと同一
dx2lib_x64.dll
Linuxsmpl2.cサンプル
smpl4.c
RubySMPL1.cサンプル
SMPL3.c
Page Top

開発環境毎の設定 anchor.png[20]

ここでは3つのツールで使用する場合の設定方法を説明します。ここで紹介しないツールでも必要とされる操作は概ね同様ですが、全てに対応できるとまでは明言しません。

Page Top

GCC Developer Lite anchor.png[21]

GCC Developer Liteの詳細についてはこちら[22]
'SampleCode\GCCDeveloperLite'フォルダにはAPIの基本的な使い方を紹介したサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。

Page Top
DLLの静的リンク anchor.png[23]

静的にDLLを使用する場合は以下の手順でDLLをリンクする指定を行った上でコンパイルします。なお32bit環境を前提とします。

  1. ファイルの準備

    ダウンロードファイルを解凍後、コンパイルするソースファイルと同一フォルダに以下のファイルをコピー

    ファイルファイル名備考
    ヘッダdx2lib.h必要な宣言を集約
    DLLdx2lib_x32.dllDLL本体(実行時およびリンク時に必要)
  2. コンパイルオプションの選択

    ツールメニュー→コンパイラオプションをクリックし、表示されるダイアログボックスの設定リストから'x86 (Console)'を選択

    GCC_CompileOption_sel.png
  3. ライブラリの追加

    etc...タブ内の追加ボタンを押し、新規に行を追加

    GCC_CompileOption_AddEtc.png

    新規に追加された空の行をクリックし'dx2lib_x32.dll'と入力

    GCC_CompileOption_AddDx2lib.png

OKを押して設定を反映

Page Top
DLLの動的リンク anchor.png[24]

動的にDLLを使用する場合はDLL自体をコンパイラオプションへ追記する必要はありません。その代わりにソース中でdx2lib.hをインクルードする前に_DYNAMICLOADマクロを定義しておきます。

#define _DYNAMICLOAD
#include "dx2lib.h"

これによりヘッダファイル内の諸定義が切り替わり、DLLのロード及びアンロードを行うLoadDLLとUnloadDLLが利用できるようになります。

  TDeviceID   dev;
  // DLLをロード
  if (LoadDLL ()) {
    if ((dev = DX2_OpenPort (COMPORT, BAUDRATE))) {
      ...
      DX2_ClosePort (dev);
    }
    // DLLをアンロード
    UnloadDLL ();
  }
Page Top

Microsoft Visual C++ anchor.png[25]

Visual C++ 2010 Express[26]でDLLの静的なリンク方法のみ紹介します。

  1. ファイルの準備

    ダウンロードファイルを解凍後、コンパイルするソースファイルと同一フォルダに以下のファイルをコピー

    ファイルファイル名備考
    ヘッダdx2lib.h必要な宣言を集約
    DLLdx2lib_x32.dll実行時に必要
    ライブラリdx2lib_x32.libリンク時に必要
  2. プロジェクトのプロパティを変更

    構成プロパティ→C/C++→全般→追加のインクルードディレクトリの項目にヘッダファイルの格納フォルダを指定

    VCC_property_include.png

    構成プロパティ→リンカー→全般→追加のライブラリディレクトリの項目にLIBファイルの格納フォルダを指定

    VCC_property_lib_path.png

    構成プロパティ→リンカー→入力→追加の依存ファイルの項目にLIBファイル名を指定

    VCC_property_lib_file.png

    構成プロパティ→C/C++→プリコンパイル済ヘッダーの項目にプリコンパイル済ヘッダーを使用しないを指定

    VCC_property_precompile.png
Page Top

National Instruments LabVIEW anchor.png[27]

'SampleCode\LabVIEW2011'フォルダにサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。
LabVIEW[28]には外部のDLLへアクセスする手段が提供されています。しかしながらDX2LIBそのままの定義ではLabVIEWからは使いづらいため、サンプルプログラムではサブviでラッピングしてDX2LIB.llbにまとめて提供しています。

vi_frontpanel.png
vi_diagram.png
Page Top

DELPHI anchor.png[29]

'SampleCode\DELPHI'フォルダにサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。
DELPHI[30]はPASCAL言語によるPC向け開発ツールであり、外部のDLLへ容易にアクセスする事が出来ます。サンプルに含まれるDX2LIB.pas内にdx2lib_x32.dllないしdx2lib_x64.dllを動的にロードする関数を用意しましたので、ユーザソースのuses節にdx2libを追記すればDynamixel Libraryの各APIへ簡便にアクセスできます。

Page Top

VB anchor.png[31]

'SampleCode\EXCEL'フォルダにサンプルが同梱されます。
ここではVBと似たMicrosoft OfficeのVBAを使用し、マクロの標準モジュールにDX2LIBHEADという名称でDLLに含まれるいくつかのAPIが定義してあります。
Module1にPingTestとMotorTestというマクロが記述されていますので、ワークシートから適宜マクロを呼び出して実行してください。結果がシート上に反映されます。

Page Top

Ruby anchor.png[32]

'SampleCode\Ruby'フォルダにサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。
Ruby[33]はオープンソースの動的なプログラミング言語で、外部のDLLへ簡易にアクセスすることが出来ます。

 require 'dl/import'
 molude dx2lib
   extend DL::Importer
   dlload "./dx2lib_x32.dll"
   extern "int DX2_OpenPort( char *, long )"
 end
 devid = dx2lib.DX2_OpenPort( "ポート名", ボーレート )
Page Top

Python anchor.png[34]

'SampleCode\Python'フォルダにサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。
Python[35]はオープンソースの動的なプログラミング言語で、外部のDLLへ簡易にアクセスすることが出来ます。
各APIのPython用の宣言を定義したdx2lib.pyをimportするだけで済みます。

from dx2lib import *  # dx2libをインポート
Page Top

Java anchor.png[36]

Page Top

MathWorks MATLAB anchor.png[37]

MATLAB[38]からの使用例を紹介します。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して下さい。また、mex-setupにてCコンパイラを選択[39]しておく必要があります。

  1. 事前準備

    まずはMATLAB起動後、「ファイル(F)」→「パス設定(H)」でdx2lib_x32.dll(MATALBが64bitの場合はdx2lib_x64.dll)とdx2lib_matlab.hの格納されたパスを指定します。dx2lib.hはMATLABでは解釈できない記述が多いため使用しないでください。

  2. DLLのロード
    loadlibrary('dx2lib_x32.dll','dx2lib_matlab.h','alias','dx2lib')
  3. ポートのオープン

    ロードされたdx2libのDX2_OpenPortを呼出します。関数名の後はポートとボーレートです。

    devid = calllib('dx2lib','DX2_OpenPort','\\.\COM3',1000000)
  4. TErrorCodeの取得

    TErrorCodeはポインタで引き渡しているため、事前に型宣言をしておきます。値はErr.Valueで取得可能です。必要なければ0を指定しても構いません。

    Err = libpointer('uint16Ptr', 0);
    Ret = calllib('dx2lib', 'DX2_Ping', devid, 1, Err);
    fprintf('%x', Err.Value);
  5. ポートのクローズ

    DX2_OpenPortを行ったので、DX2_ClosePortを使用してポートを閉じます。

    calllib('dx2lib','DX2_ClosePort',devid)
  6. DLLのアンロード
    unloadlibrary('dx2lib')
Page Top

Linux anchor.png[40]

Linux上でのdx2libのコンパイル方法を紹介します。

  1. コンパイル準備
    ダウンロードファイルを解凍
  2. ライブラリファイルの生成
    $ gcc -c -D__MAKE_LIB__ dx2lib_intuitive.cpp dx2lib.cpp
    $ ar -rcsv libdx2lib.a dx2lib_intuitive.o dx2lib.o
  3. 共有ライブラリの作成
    RubyやPython等で使用する場合等
    $ gcc -fPIC -shared -D__MAKE_LIB__ dx2lib_intuitive.cpp dx2lib.cpp -o dx2lib.so.2.3
  4. ユーザプログラムとのリンク
    生成したライブラリファイルと自身のソースをリンクする。
    ポート・ボーレート等は使用する環境に合わせて適宜追加・修正する。
    ライブラリは必要に合わせて追加する。
    $ gcc sample.c -ldx2lib -o sample

なお、コンパイルや実行にあたってI/Fやカーネル・ディストリビューションに依存するのがLinuxですので、そのまま使用できない場合は適宜ソースを修正下さい。

Page Top

API anchor.png[41]

Dynamixel Libraryではシリアル通信を直接意識するコードを記述せずに、対象IDのデバイスのコントロールテーブルへの読み書き行うAPIを用意しています。
C言語のソースにdx2lib.hをインクルードすれば、APIを使用するのに必要なプロトタイプとマクロの定義がなされます。

Page Top

DX2_OpenPort anchor.png[42]

ライブラリの内部情報を初期化すると同時に指定されたCOMポートをオープンし、DX2_SetBaudrate[43]を使用して通信速度を設定した後、ユニークなTDeviceID[44]を返す。以後はこのTDeviceID[44]を使用して各APIを使用する。
複数のCOMポートを使用する場合は使用するポート毎にDX2_OpenPortを行い、各々のポートに対してTDeviceID[44]を取得しなくてはならない。
なお、Linuxにおけるボーレートの指定に関しては、DX2_SetBaudrate[43]の解説に注意の事。

TDeviceID DX2_OpenPort (char *name, uint32_t baud);
  • パラメータ
    • char *name

      インターフェースが提供するCOMポート名。
      Windowsの場合の記述方法はこちら[45]の情報に従う。

    • long baud

      インターフェースとデバイス間の通信速度[bps]。

  • 戻り値
    • TDeviceID[44]

      オープンに成功した場合は0以外の値、失敗した場合は0を返す。

  • 使用例
    TDeviceID dev;
    // COM10を9600bpsでオープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 9600);
Page Top

DX2_ClosePort anchor.png[46]

DX2_OpenPortで開いたCOMポートを閉じる。
DX2_ClosePortが実行された以後はTDeviceID[44]は使用できなくなる。

bool DX2_ClosePort (TDeviceID dvid);
  • パラメータ
  • 戻り値
    • bool

      クローズに成功した場合はtrue、失敗した場合はfalseを返す。

  • 使用例
    TDeviceID dev;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 9600);
    if (dev) {
      ... (中略)
      // クローズ
      DX2_ClosePort (dev);
    }
Page Top

DX2_SetBaudrate anchor.png[47]

既にオープンされているTDeviceID[44]の通信速度の変更を行う。
実行すると強制的に受信バッファがクリアされる。
なお、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 DX2_SetBaudrate (TDeviceID dvid, long baud);
  • パラメータ
  • 戻り値
    • bool

      通信速度の変更が成功するとtrue、失敗するとfalseを返す。

  • 使用例
    TDeviceID dev;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 9600);
    if (dev) {
      // 通信速度を1M[bps]に変更
      DX2_SetBaudrate (dev, 1000000);
      ... (中略)
      // クローズ
      DX2_ClosePort (dev);
    }
Page Top

DX2_Active anchor.png[48]

指定されたTDeviceID[44]のポートが開かれており、使用可能であるかを確認する。
USB接続等によりインターフェース自体が取り外し可能な場合に、実際に使用可能であるかを判断するために使用するが、状況によっては正確に判断できない場合もある。

bool DX2_Active (TDeviceID dvid);
  • パラメータ
  • 戻り値
    • bool

      指定されたdvidが使用可能な場合はtrue、使用不可の場合はfalseを返す。

  • 使用例
    TDeviceID dev;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 9600);
    if (dev) {
      while (DX2_Active (dev)) {
        ... (中略)
      }
      // クローズ
      DX2_ClosePort (dev);
    }
Page Top

DX2_SetTimeOutOffset anchor.png[49]

I/FやOSの都合で生じるであろうタイムラグを予め設定する。
内部で算出している受信タイムアウト時間とタイムアウトオフセット時間を加算した時間を超えた場合に、タイムアウトエラーとして処理する。
デフォルトは20[ms]。

void DX2_SetTimeOutOffset (TDeviceID dvid, uint32_t offsettime);
  • パラメータ
  • 戻り値
    • bool

      指定されたdvidが使用可能な場合はtrue、使用不可の場合はfalseを返す。

Page Top

DX2_Ping anchor.png[50]

PINGインストラクションを使用して対象IDからの応答を確認する。

bool DX2_Ping (TDeviceID dvid, uint8_t id, TErrorCode *err);
  • パラメータ
  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 57143);
    if (dev) {
      // ID=1にPINGを発行
      if (DX2_Ping (dev, 1, &err))
        printf ("Found [%08X]\n", err);
      else
        printf ("Not found [%08X]\n", err);
      // クローズ
      DX2_ClosePort (dev);
    }
Page Top

DX2_Ping2 anchor.png[52]

PINGインストラクションでBROADCASTING IDを指定して不特定の対象の応答を確認する。
BROADCASTING IDを指定した場合の応答時間はデバイスによって差があるため、異なるデバイスが混在している環境では正確な情報を取得できない場合がある。

bool DX2_Ping2 (TDeviceID dvid, uint32_t *num, TDxAlarmStatus *AlarmStatus, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint32_t *num

      検索する最大数及び検索で見つかったデバイス数の保存先。

    • TDxAlarmStatus[53] *AlarmStatus

      検索で見つかったデバイス情報の保存先。
      少なくともnumで指定したサイズ分の領域を確保しておく必要がある。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      1台以上のデバイスからの応答が得られた場合はtrue、それ以外はfalseを返す。

  • 使用例
    TDeviceID   dev;
    TErrorCode  err;
    uint8_t     id;
    TDxAlarmStatus stat[254];
    int         i;
    uint32_t    num = 252;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 57143);
    if (dev) {
      // 不明な対象に対してPINGを発行
      if (DX2_Ping2 (dev, &num, stat, &err)) {
        for (i = 0; i < num; i++)
          printf ("Found ID=%d %02X\n", stat[i].id, stat[i].Status);
      }
      // クローズ
      DX2_ClosePort (dev);
    }
Page Top

DX2_Reset anchor.png[54]

RESETインストラクションを使用して対象IDを出荷時の状態に初期化する。

bool DX2_Reset (TDeviceID dvid, uint8_t id, TErrorCode *err);
  • パラメータ
  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 57143);
    if (dev) {
      // ID=1にRESETを発行
      if (DX2_Reset (dev, 1, &err))
        printf ("Success [%08X]\n", err);
      else
        printf ("Fail [%08X]\n", err);
      // クローズ
      DX2_ClosePort (dev);
    }
Page Top

DX2_Reboot anchor.png[55]

REBOOTインストラクションを使用して対象IDを再起動する。

bool DX2_Reboot (TDeviceID dvid, uint8_t id, TErrorCode *err);
  • パラメータ
  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 57143);
    if (dev) {
      // ID=1にREBOOTを発行
      if (DX2_Reboot (dev, 1, &err))
        printf ("Success [%08X]\n", err);
      else
        printf ("Fail [%08X]\n", err);
      // クローズ
      DX2_ClosePort (dev);
    }
Page Top

DX2_ReadByteData anchor.png[56]

対象IDのコントロールテーブルから1バイトのデータを読み出す。

bool DX2_ReadByteData(TDeviceID dvid, uint8_t id, uint16_t adr, uint8_t *rdata, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • uint16_t adr

      コントロールテーブルのアドレス。

    • uint8_t *rdata

      読み出した値の保存先。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    uint8_t    dat;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のXL-320からLEDの状態を取得
      if (DX2_ReadByteData (dev, 1, 25, &dat, &err)) {
        printf ("LED STAT=%d\n", dat);
      }
      DX2_ClosePort (dev);
    }
Page Top

DX2_WriteByteData anchor.png[57]

対象IDのコントロールテーブルへ1バイトのデータを書き込む。

bool DX2_WriteByteData(TDeviceID dvid, uint8_t id, uint16_t adr, uint8_t dat, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252, 254)。

    • uint16_t adr

      コントロールテーブルのアドレス。

    • uint8_t dat

      書き込む値。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。
      BROADCASTING IDを指定した場合は応答待ちを行わない。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    uint8_t    dat;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のXL-320からLEDの状態を取得
      if (DX2_ReadByteData (dev, 1, 25, &dat, &err)) {
        dat = (dat + 1) & 7;
        // ID=1のXL-320へLEDの状態を設定
        DX2_WriteByteData (dev, 1, 25, dat, &err);
      }
      DX2_ClosePort (dev);
    }
Page Top

DX2_ReadWordData anchor.png[58]

対象IDのコントロールテーブルから1ワード(2バイト)のデータを読み出す。

bool DX2_ReadWordData(TDeviceID dvid, uint8_t id, uint16_t adr, uint16_t *rdata, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • uint16_t adr

      コントロールテーブルのアドレス。

    • uint16_t *rdata

      読み出した値の保存先。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    uint16_t   dat;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のXL-320から現在位置を取得
      if (DX2_ReadWordData (dev, 1, 30, &dat, &err)) {
        printf ("PRESENT POS=%d\n", dat);
      }
      DX2_ClosePort (dev);
    }
Page Top

DX2_WriteWordData anchor.png[59]

対象IDのコントロールテーブルへ1ワード(2バイト)のデータを書き込む。

bool DX2_WriteWordData(TDeviceID dvid, uint8_t id, uint16_t adr, uint16_t dat, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252, 254)。

    • uint16_t adr

      コントロールテーブルのアドレス。

    • uint16_t dat

      書き込む値。

    • TErrorCode[51] *errcode

      エラーコード。

  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。
      BROADCASTING IDを指定した場合は応答待ちを行わない。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のXL-320へ位置(511)を指令
      DX2_WriteWordData (dev, 1, 30, 511, &err);
      DX2_ClosePort (dev);
    }
Page Top

DX2_ReadLongData anchor.png[60]

対象IDのコントロールテーブルからロング(4バイト)のデータを読み出す。

bool DX2_ReadLongData(TDeviceID dvid, uint8_t id, uint16_t adr, uint32_t *rdata, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • uint16_t adr

      コントロールテーブルのアドレス。

    • uint32_t *rdata

      読み出した値の保存先。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    uint32_t   dat;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のXM430から現在位置を取得
      if (DX2_ReadWordData (dev, 1, 132, &dat, &err)) {
        printf ("PRESENT POS=%d\n", dat);
      }
      DX2_ClosePort (dev);
    }
Page Top

DX2_WriteLongData anchor.png[61]

対象IDのコントロールテーブルへロング(4バイト)のデータを書き込む。

bool DX2_WriteLongData(TDeviceID dvid, uint8_t id, uint16_t adr, uint32_t dat, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252, 254)。

    • uint16_t adr

      コントロールテーブルのアドレス。

    • uint32_t dat

      書き込む値。

    • TErrorCode[51] *errcode

      エラーコード。

  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。
      BROADCASTING IDを指定した場合は応答待ちを行わない。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    // オープン
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のXM430へ位置(2047)を指令
      DX2_WriteWordData (dev, 1, 116, 2047, &err);
      DX2_ClosePort (dev);
    }
Page Top

DX2_ReadBlockData anchor.png[62]

対象IDのコントロールテーブルから指定サイズのデータを読み出す。

bool DX2_ReadBlockData (TDeviceID dvid, uint8_t id, uint16_t adr, uint8_t *rdata, uint32_t len, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • uint16_t adr

      コントロールテーブルのアドレス。

    • uint8_t *rdata

      読み出したデータの保存先。

    • uint32_t len

      読み出すデータのサイズ。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    uint8_t    gain[3];
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のXL-320からPIDゲインのデータを取得
      if (DX2_ReadBlockData (dev, 1, 26, gain, 3, &err) {
        printf (
         "D=%d I=%d P=%d\n",
         gain[0], gain[1], gain[2]
        );
      }
      DX2_ClosePort (dev);
    }
Page Top

DX2_WriteBlockData anchor.png[63]

対象IDのコントロールテーブルへ指定サイズのデータを書き込む。

bool DX2_WriteBlockData(TDeviceID dvid, uint8_t id, uint16_t adr, const uint8_t *dat, uint32_t len, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252, 254)。

    • uint16_t adr

      コントロールテーブルのアドレス。

    • uint8_t *dat

      書き込むデータの保存先。

    • uint32_t len

      書き込むデータのサイズ。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      正常な応答が得られた場合はtrue、それ以外はfalseを返す。
      BROADCASTING IDを指定した場合は応答待ちを行わない。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    uint8_t    gain[3] = { 1, 1, 1 };
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のXL-320のPIDゲインを変更
      DX2_WriteBlockData (dev, 1, 26, gain, 3, &err);
      DX2_ClosePort (dev);
    }
Page Top

DX2_ReadSyncData anchor.png[64]

SYNC READインストラクションを使用して複数IDからブロック読み出しを行う。
読み出されるデータの1軸分の構造は[ID(8bit)][ERR(16bit)][DATA1(8bit)]...[D​ATAn(8bit)]となり、複数軸の場合は本データが軸数分だけスタックする。

bool DX2_ReadSyncData (TDeviceID dvid, const TSyncReadParam *param, uint32_t *num, uint8_t *dat, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • TSyncReadParam[65] *param

      パラメータデータを指定。

    • uint32_t *num

      読み出すデバイス数を指定。APIの処理後に応答したデバイス数が入る

    • uint8_t dat

      取得データの保存先。((受信データ長 + 3) * num)バイト以上を確保の事。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      指定したデバイス数が応答したらtrue、それ以外はfalseを返す。

  • 使用例
// XM430の120番地から2バイト分のデータをid=1,2,3より読み出すパラメータ
const TSyncReadParam param = {
  addr:120,
  length:2,
  ids:{1,2,3},
};

// 読み出しすデータの構造体
typedef struct {
  uint8_t     id;
  TErrorCode  err;
  uint16_t    RTTick;
} __attribute__ ((gcc_struct, __packed__)) TSyncR[3];
TSyncR     rdat;

TDeviceID   dev;
TErrorCode  err;
if ((dev = DX2_OpenPort ("\\\\.\\COM5", 1000000))) {
  uint32_t num = 3; // 3軸
  DX2_ReadSyncData (dev, &param, &num, (uint8_t *)&rdat, &err);
  printf("resul num=%d\n", num);
  for (int i = 0; i < num; i++) {
    printf("ID:%d ERR:%04X tick=%d\n", rdat[i].id, rdat[i].err, rdat[i].RTTick);
  }
  DX2_ClosePort (dev);
};
Page Top

DX2_WriteSyncData anchor.png[66]

SYNCインストラクションを使用して複数IDへブロック書き込みを行う。
書き込まれるデータの構成はユーザに委ねられる。

bool DX2_WriteSyncData (TDeviceID dvid, uint8_t *dat, uint32_t size, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *dat

      書き込むパラメータの保存先。

    • uint32_t size

      パラメータのサイズ。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      インターフェースより送信が行われた場合はtrue、それ以外はfalseを返す。

  • 使用例
// 2台のXM430へ位置を指令する想定の構造体
typedef struct {
  uint16_t    addr;
  uint16_t    length;
  struct {
    uint8_t   id;
    uint32_t  goalpos;
  } __attribute__ ((gcc_struct, __packed__)) data[2];
} __attribute__ ((gcc_struct, __packed__)) TSyncW;

TSyncW syncw = {
  116,  // アドレス (Goal Position)
  4,    // データ長 (4 byte)
  {{ 1, 3072 },  // 1軸目 ID=1, GoalPosition=3072
   { 2, 1024 }}  // 2軸目 ID=2, GoalPosition=1024
};

TDeviceID  dev;
TErrorCode err;

dev = DX2_OpenPort ("\\\\.\\COM5", 1000000);
if (dev) {
  // 2台のXM430へ個別の位置を指令
  DX2_WriteSyncData (dev, (uint8_t *)&syncw, sizeof(syncw), &err);
  DX2_ClosePort (dev);
};
Page Top

DX2_ReadBulkData anchor.png[67]

BULK READインストラクションを使用して複数IDの指定アドレス・サイズでブロック読み出しを行う。
読み出されるデータの1軸分の構造は[SIZE(16bit)][ID(8bit)][ERR(16bit)][DATA​1(8bit)]...[DATAn(8bit)]とし、DATAの前にSIZE(SIZEを含む1軸分のデータ長)・ID・ERRの計5バイトが付与される。複数軸の場合はSIZEから始まる本データが軸数分連続して取得される。

bool DX2_ReadBulkData (TDeviceID dvid, const TBulkReadParam *param, uint32_t *num, uint8_t *dat, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • TBulkReadParam[68] *param

      パラメータデータを指定。

    • uint32_t *num

      読み出すデバイス数を指定。APIの処理後に応答したデバイス数が入る

    • uint8_t dat

      取得データの保存先。十分な領域を確保の事。
      TBulkReadResult[69]を介して解析すると便利。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      指定したデバイス数が応答したらtrue、それ以外はfalseを返す。

  • 使用例
TDeviceID  dev;
TErrorCode err;
uint8_t    rdat[1000]; // 読み出したデータの保存先

const TBulkReadParam param[3] = {
  {1,100,20}, // ID=1の124番地から20バイト分
  {2,124,12}, // ID=2の124番地から12バイト分
  {3,  0, 7}  // ID=3の0番地から7バイト分
};

dev = DX2_OpenPort ("\\\\.\\COM5", 1000000);
if (dev) {
  uint32_t num = 3; // 3軸
  PBulkReadResult pr = (void *)rdat;
  DX2_ReadBulkData (dev, &param[0], &num, (uint8_t *)&rdat, &err);
  printf("resul num=%d err=$%04x\n", num, err);
  for (int i = 0; i < num; i++) {
    if (pr->size > 0) {
      printf("\nID:%d err:$%04X ",pr->id, pr->err);
      for (int j = 0; j < pr->size - 5; j++) printf("%02X ", pr->dat[j]);
      pr = (void *)pr + pr->size; // 次のデータ用にポインタを更新
    }
  }
  DX2_ClosePort (dev);
};
Page Top

DX2_WriteBulkData anchor.png[70]

BULKインストラクションを使用して複数の個別なID・アドレス・データサイズで書き込みを行う。

bool DX2_WriteBulkData (TDeviceID dvid, uint8_t *dat, uint32_t size, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *dat

      書き込むパラメータの保存先。

    • uint32_t size

      パラメータのサイズ。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値
    • bool

      インターフェースより送信が行われた場合はtrue、それ以外はfalseを返す。

  • 使用例
// 3台のXM430へ位置を指令する想定の構造体
typedef struct {
  uint8_t  id;
  uint16_t addr;
  uint16_t len;
  int32_t  pos;
} __attribute__ ((gcc_struct, __packed__)) TBW[3];
TBW BW = {
  {1, 116, 4, 0},    // 1軸目 ID=1, アドレス=116, サイズ=4, GPos=0
  {2, 116, 4, 2047}, // 2軸目 ID=1, アドレス=116, サイズ=4, GPos=2047
  {3, 116, 4, 4095}  // 3軸目 ID=1, アドレス=116, サイズ=4, GPos=4095
};

TDeviceID  dev;
TErrorCode err;

dev = DX2_OpenPort ("\\\\.\\COM5", 1000000);
if (dev) {
  // 3台のXM430へ個別の情報を書き込み
  DX2_WriteBulkData (dev, (uint8_t *)&BW, sizeof(BW), &err);
  DX2_ClosePort (dev);
};
Page Top

DX2_TxPacket anchor.png[71]

任意のインストラクションパケットを送信する。

bool DX2_TxPacket (TDeviceID dvid, uint8_t id, TInstruction inst, uint8_t *param, uint32_t len, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • TInstruction[72] inst

      使用するインストラクション。

    • uint8_t *param

      送信するパラメータの保存先。

    • uint32_t len

      送信するパラメータのサイズ。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値

    インターフェースより送信が行われた場合はtrue、それ以外はfalseを返す。

  • 使用例
    TDeviceID  dev;
    TErrorCode err;
    uint8_t    param[2] = {
      25,    // アドレス (LED)
      0,     // データ
    };
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のAX-12+のLEDを消灯
      DX2_TxPacket (dev, 1, INST_WRITE, param, 2, &err);
      DX2_ClosePort (dev);
    };
Page Top

DX2_RxPacket anchor.png[73]

ステータスパケットを受信する。
基本的にDX2_TxPacketとペアで使用する。ステータスパケットが得られない状況で使用するとタイムアウトするまで返らない。
なお、本APIはDX2_SetTimeOutOffset[74]で設定されたオフセット値は使用せず、引数で指定された受信タイムアウトのみが適用される。

bool DX2_RxPacket (TDeviceID dvid, uint8_t *rdata, uint32_t rdatasize, uint32_t *rlen, uint32_t timeout, TErrorCode *err);
  • パラメータ
    • TDeviceID[44] dvid

      DX2_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *rdata

      受信バッファ。
      ステータスパケットを受信するのに十分なサイズを確保しておく必要がある。

    • uint32_t readsize

      rdataのサイズ。

    • uint32_t *rlen

      実際に受信されたステータスパケットのサイズ。

    • int timeout

      受信タイムアウト[ms]。

    • TErrorCode[51] *err

      エラーコード。

  • 戻り値

    受信成功時はtrue、それ以外はfalseを返す。

  • 使用例
    int        i;
    uint32_t   len;
    TDeviceID  dev;
    TErrorCode err;
    uint8_t    param[2] = {
      25,    // アドレス (LED)
      1,     // サイズ
    };
    
    dev = DX2_OpenPort ("\\\\.\\COM10", 1000000);
    if (dev) {
      // ID=1のAX-12+からLEDの状態を読み出す要求
      if (DX2_TxPacket (dev, 1, INST_READ, param, 2, &err)) {
        // ステータスパケットを受信
        DX2_RxPacket (dev, dat, sizeof (dat), &len, 100, &err);
        for (i = 0; i < len; i++) {
          printf ("[%02X]", dat[i]);
        }
      }
      DX2_ClosePort (dev);
    };
Page Top

DX2LIBのオリジナルな定義 anchor.png[75]

TDeviceID
(uint32_t|uint64_t)
DX2_OpenPortにて自動的に生成されるユニークな値。
TInstruction
(uint8_t)
DX2_TxPacketにてインストラクションパケットを送信する場合に使用される。
使用可能なマクロは以下の通り。

INST_PING
INST_READ
INST_WRITE
INST_REG_WRITE
INST_ACTION
INST_RESET
INST_REBOOT
INST_STATUS
INST_SYNC_READ
INST_SYNC_WRITE
INST_BULK_READ
INST_BULK_WRITE

TDx2AlarmStatus
struct {
  uint8_t id;
  TErrorCode Status;
}
idとTErrorCodeを対にした構造体でアライメントは1バイト。DX2_Ping2[76]で使用される。
TSyncReadParam
struct {
  uint16_t addr;
  uint16_t length;
  uint8_t ids[256];
}
addr, length, idsをまとめた構造体でアライメントは1バイト。DX2_ReadSyncData[77]で使用される。
TBulkReadParam
struct {
  uint8_t id;
  uint16_t addr;
  uint16_t length;
}
id, addr, lengthをまとめた構造体でアライメントは1バイト。DX2_ReadBulkData[78]で使用される。
TBulkReadResult
struct {
  uint16_t size;
  uint8_t id;
  TErrorCode err;
  uint8_t dat[];
}
size, id, err, datをまとめた構造体でアライメントは1バイト。DX2_ReadBulkData[78]で読み出されたデータのアクセスに使用される。
TErrorCode
(uint16_t)
API内で検出される16ビットのエラーコード。上位8ビットはAPI内部で検出したエラー、下位8ビットはステータスパケットに含まれるエラーフラグが割り当てられている。
bitmacro name
15ERR_INVALID_DEVID使用できないTDeviceID
14ERR_INVALID_ID指定できないID
13ERR_DIFF_ID異なるIDからの応答
12ERR_ILLEGAL_SIZE異常なデータサイズ
11ERR_INVALID_PARAM異常なパラメータ
10ERR_COMMシリアルポートエラー
9ERR_CHECKSUM異常なチェックサム
8ERR_TIMEOUT受信タイムアウト
7ERR_DX2_ALERTハード的な異常検出
6ERR_DX2_ACCESS=7
ERR_DX2_DATALIMIT=6
ERR_DX2_DATALENGTH=5
ERR_DX2_DATARANGE=4
ERR_DX2_CRC=3
ERR_DX2_INSTRUCTION=2
ERR_DX2_RESULT=1
パケットの処理や数値範囲に関するエラー
5
4
3
2
1
0

Page Top

追加API anchor.png[79]

使用するDynamixelの情報を予めライブラリ内に保持させておき、位置や角速度等の指令およびフィードバック値は物理値を扱い、各々の区別はIDのみで行うAPIです。
これAPIによりDynamixelのモデルごとに異なるコントロールテーブルや煩雑な運転方法の違いを意識する事なく、少ないコードで目的の挙動を実現できます。
なお、従来通りコントロールテーブルへの直接アクセスを制限するものではありませんが、その場合は本機能が想定する状況と一致しなくなる事があります。
※以下の使用例はDX2LIBを前提としています。

Table of contents
      • 初期設定関連
        • DXL_ScanDevices
        • DXL_GetModelInfo
        • DXL_PrintDevicesList
        • DXL_InitDevicesList
      • エラー
        • DXL_GetErrorCode
        • DXL_GetHWErrorCode
      • 動作モード
        • DXL_SetOperatingMode
        • DXL_SetOperatingModesEquival
        • DXL_GetOperatingMode
      • LED
        • DXL_SetLED
      • 制御ON/OFF
        • DXL_SetTorqueEnable
        • DXL_SetTorqueEnables
        • DXL_SetTorqueEnablesEquival
        • DXL_GetTorqueEnable
        • DXL_GetTorqueEnables
      • 角度
        • DXL_SetGoalAngle
        • DXL_SetGoalAngles
        • DXL_GetPresentAngle
        • DXL_GetPresentAngles
      • 停止
        • DXL_StandStillAngle
        • DXL_StandStillAngles
      • 角速度
        • DXL_SetGoalVelocity
        • DXL_SetGoalVelocities
        • DXL_GetPresentVelocity
        • DXL_GetPresentVelocities
      • 角度と角速度
        • DXL_SetGoalAngleAndVelocity
        • DXL_SetGoalAnglesAndVelocities
      • 角度と時間
        • DXL_SetGoalAngleAndTime
        • DXL_SetGoalAnglesAndTime
      • 電流
        • DXL_SetGoalCurrent
        • DXL_SetGoalCurrents
        • DXL_GetPresentCurrent
        • DXL_GetPresentCurrents
      • PWM
        • DXL_SetGoalPWM
        • DXL_SetGoalPWMs
        • DXL_GetPresentPWM
        • DXL_GetPresentPWMs
      • オリジナルな定義

初期設定関連 anchor.png[80]

Dynamixelが持つ固有の情報を予め記憶させておくことで、それ以後の操作はIDのみを指定し、どのモデルであっても使用頻度が高いアイテムはコントロールテーブルを意識する事無く同じAPIで同様の動作ができます。

Page Top
DXL_ScanDevices anchor.png[81]

ID0~252のデバイスを順次検索し、サポートするDynamixelであればライブラリ内のリストに登録する。
リストに登録されていないデバイスのIDに対しては存在しないものとして通信を行わないため、DXL_ScanDevicesかDXL_GetModelInfoを用いて予めリストに登録しておく必要がある。

int DXL_ScanDevices (TDeviceID dvid, uint8_t *ids);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      見つかったデバイスのID一覧を必要に応じて取得する配列の保存先。最小でも253バイトを確保すること。

  • 戻り値
    • int

      見つかったデバイスの数。

  • 使用例
    #include <stdio.h>
    #include <dx2lib.h>
    
    void main (void) {
     // COM10を57600bpsでオープン
     TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
     if (dev != 0) {
       // ID=0~252の情報を取得し成功したもののみライブラリ内のリストに追加
       printf("detect num=%d\n", DXL_ScanDevices (dev, NULL));
       DX2_Close (dev);
     }
    }
    
Page Top
DXL_GetModelInfo anchor.png[82]

指定IDのモデル情報の取得し、サポートするDynamixelであればライブラリ内のリストに登録する。
リストに登録されていないデバイスのIDに対しては存在しないものとして通信を行わないため、DXL_ScanDevicesかDXL_GetModelInfoを用いて予めリストに登録しておく必要がある。

PDXL_ModelInfo DXL_GetModelInfo (TDeviceID dvid, uint8_t id);
  • パラメータ
  • 戻り値
  • 使用例
    #include <stdio.h>
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("/dev/ttyUSB0", 57600);
      for (uint8_t id = 0; id <= 252; id++) {
        // idの情報を取得し成功したらライブラリ内のリストに追加
        PDXL_ModelInfo p = DXL_GetModelInfo (dev, id);
        if (p->modelno != 0)
          printf ("[%3d] %s ($%04X) %d\n", id, p->name, p->modelno, p->devtype);
        }
      }
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_PrintDevicesList anchor.png[85]

ライブラリ内のリストに登録された全てのデバイスの情報をコンソールに出力する。
ID・モデル名・モデル番号の順に出力される。

bool DXL_PrintDevicesList (int (*pf) (const char *, ...));
  • パラメータ
    • int (*pf)(const char *, ...)

      printf等の書式化文字列出力ルーチンのポインタ。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <stdio.h>
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("/dev/ttyUSB0", 57600);
      DXL_ScanDevices (dev, NULL);
      DXL_PrintDevicesList ((void *)&printf);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_InitDevicesList anchor.png[86]

ライブラリ内に保持されたデバイスのリストをクリアする。

void DXL_InitDevicesList (void);
Page Top

エラー anchor.png[87]

Page Top
DXL_GetErrorCode anchor.png[88]

追加APIの処理の中で最後に取得したエラーを返す。本API自体は通信を行わない。

TErrorCode DXL_GetErrorCode (TDeviceID dvid, uint8_t id);
Page Top
DXL_GetHWErrorCode anchor.png[89]

対象IDのコントロールテーブルにハードウェアエラーが備わっている場合にのみ取得する。

bool DXL_GetHWErrorCode (TDeviceID dvid, uint8_t id, uint8_t *hwerr);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • uint8_t *hwerr

      取得されたハードウェアエラーの保存先。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

動作モード anchor.png[90]

現在のところDynamixel X・PRO+シリーズが最も沢山の動作モードをサポートしています。概ねこの動作モードによって動作の大別が行われるため、他のモデルにおいてもこの動作モードの番号を踏襲することとします。

Page Top
DXL_SetOperatingMode anchor.png[91]

対象IDの動作モードを変更する。
指定されたモードと現在のモードが異なる場合にのみトルクをOFFにし動作モードを更新する。
対称IDがライブラリ内のリストに登録されている必要がある。

bool DXL_SetOperatingMode (TDeviceID dvid, uint8_t id, uint8_t mode);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • uint8_t mode

      Dynamixel X/PRO/PRO plusシリーズではmodeの値をそのまま適用、それ以外では近似した動作モードを適用。
      0: Current Control (電流制御)
      1: Velocity Control (速度制御)
      3: Position Control (位置制御)
      4: Expand Position Control (多回転位置制御)
      5: Current-Base Position Control
      16: PWM Control

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      // ID:1を検索し見つかれば登録
      DXL_GetModelInfo (dev, 1);
      // ID:1をCurrent-Base Position Controlに設定
      DXL_SetOperatingMode (dev, 1, 5);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_SetOperatingModesEquival anchor.png[92]

複数IDの動作モードを一括変更する。
指定されたモードと現在のモードが異なる場合にのみトルクをOFFにし動作モードを更新する。
ライブラリ内のリストに登録されていないIDは無視される。

bool DXL_SetOperatingModesEquival (TDeviceID dvid, const uint8_t *ids, int num, uint8_t mode);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • int num

      対象とするID数

    • uint8_t mode

      Dynamixel Xシリーズの動作モード[93]を想定し、それに完全対応しないデバイスに対しては近似値もしくは失敗を返す。
      0: Current Control
      1: Velocity Control
      3: Position Control
      4: Expand Position Control
      5: Current-Base Position Control
      16: PWM Control

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      uint8_t ids[3] = {1, 2, 3};
      // ID:1~3を検索し見つかれば登録
      for (int i = 0; i < sizeof (ids); i++) DXL_GetModelInfo (dev, ids[i]);
      // ID:1~3をVelocity Controlに設定
      DXL_SetOperatingModesEquival (dev, ids, sizeof (ids), 1);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_GetOperatingMode anchor.png[94]

対象IDの動作モードを取得する。

bool DXL_GetOperatingMode (TDeviceID dvid, uint8_t id, uint8_t *mode);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • uint8_t *mode

      取得した動作モードの保存先。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

LED anchor.png[95]

Dynamixelに備わっているLEDは全てのモデルにおいてコントロールテーブル上の同じアドレスに割り当てがなされている訳では無いため、デバッグに有用なLEDを一つのAPIで使用できます。

Page Top
DXL_SetLED anchor.png[96]

対象IDのLEDを明滅させる。

bool DXL_SetLED (TDeviceID dvid, uint8_t id, bool en);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • bool en

      trueで点灯、falseで消灯。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

制御ON/OFF anchor.png[97]

コントロールテーブル上でトルクイネーブルと称しているアイテムは、LED同様にモデルによってアドレスが異なります。制御の開始と停止を司るため、こちらも同じAPIで運用できます。

Page Top
DXL_SetTorqueEnable anchor.png[98]

対象IDの制御を開始ないし停止させる。
なお、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetTorqueEnable (TDeviceID dvid, uint8_t id, bool en);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • bool en

      trueで開始、falseで停止。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      DXL_GetModelInfo (dev, 1);
      DXL_SetOperatingMode (dev, 1, 3);
      // ID:1の制御をON
      DXL_SetTorqueEnable (dev, 1, true);
      // ID:1へ角度指令 180deg
      DXL_SetGoalAngle (dev, 1, 180.0);
      // 1000ms待機
      Sleep (1000);
      // ID:1の制御をOFF
      DXL_SetTorqueEnable (dev, 1, false);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_SetTorqueEnables anchor.png[99]

複数IDの制御を個別に開始ないし停止させる。
ライブラリ内のリストに登録されていないIDは無視される。
なお、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetTorqueEnables (TDeviceID dvid, const uint8_t *ids, const bool *ens, int num);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • const bool *ens

      idsで指定されたID順にtrueで開始、falseで停止を保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top
DXL_SetTorqueEnablesEquival anchor.png[100]

複数IDの制御を一括で開始ないし停止させる。
ライブラリ内のリストに登録されていないIDは無視される。
なお、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetTorqueEnablesEquival (TDeviceID dvid, const uint8_t *ids, int num, bool en);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • int num

      対象とするID数

    • bool en

      trueで開始、falseで停止。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      DXL_GetModelInfo (dev, 1);
      DXL_GetModelInfo (dev, 2);
      DXL_GetModelInfo (dev, 3);
      uint8_t ids[3] = {1, 2, 3};
      // ID:1~3の制御をON
      DXL_SetTorqueEnablesEquival (dev, ids, sizeof (ids), true);
    
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_GetTorqueEnable anchor.png[101]

対象IDのトルクイネーブル状態を取得する。

bool DXL_GetTorqueEnable (TDeviceID dvid, uint8_t id, bool *en);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • bool *en

      取得したトルクイネーブルの保存先。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top
DXL_GetTorqueEnables anchor.png[102]

複数IDのトルクイネーブル状態を取得する。
ライブラリ内のリストに登録されていないIDは無視される。

bool DXL_GetTorqueEnables (TDeviceID dvid, const uint8_t *ids, bool *en, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • bool *en

      idsで指定されたID順に取得したトルクイネーブルを保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

角度 anchor.png[103]

DynamixelのコントロールテーブルではPositionと称しているユニークな単位系を持つアイテムは、モデルによって動作角度や分解能が大きく異なります。異なるモデルを混在して運用する場合は非常に不便なため、物理値の角度[deg]を用いてアクセスします。

Page Top
DXL_SetGoalAngle anchor.png[104]

指定IDへ目標角度を指令する。
動作モードがPosition Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalAngle (TDeviceID dvid, uint8_t id, double angle);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double angle

      目標角度[deg]。中立位置を0[deg]とする。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      DXL_GetModelInfo (dev, 1);
      DXL_SetOperatingMode (dev, 1, 3);
      DXL_SetTorqueEnable (dev, 1, true);
      // ID:1へ角度指令 180deg
      DXL_SetGoalAngle (dev, 1, 180.0);
      Sleep (1000);
      // ID:1へ角度指令 -180deg
      DXL_SetGoalAngle (dev, 1, -180.0);
      Sleep (1000);
      // ID:1へ角度指令 0deg
      DXL_SetGoalAngle (dev, 1, 0.0);
      Sleep (1000);
      DXL_SetTorqueEnable (dev, 1, false);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_SetGoalAngles anchor.png[105]

複数IDへ個別の目標角度を指令する。
ライブラリ内のリストに登録されていないIDは無視される。
動作モードがPosition Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalAngles (TDeviceID dvid, const uint8_t *ids, const double *angles, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • const double *angles

      idsで指定されたID順に目標角度[deg]を保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      DXL_GetModelInfo (dev, 1);
      DXL_GetModelInfo (dev, 2);
      DXL_GetModelInfo (dev, 3);
      uint8_t ids[3] = {1, 2, 3};
      DXL_SetOperatingModesEquival (dev, ids, sizeof (ids), 3);
      DXL_SetTorqueEnablesEquival (dev, ids, sizeof (ids), true);
      // 3軸分の角度を保存したの配列
      double angles[3] = { 0.0, 150.0, 300.0 };
      // 3軸分の角度指令
      DXL_SetGoalAngles (dev, ids, angles, sizeof (ids));
      Sleep (2000);
      DXL_SetTorqueEnablesEquival (dev, ids, sizeof (ids), false);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_GetPresentAngle anchor.png[106]

対象IDの現在角度を取得する。

bool DXL_GetPresentAngle (TDeviceID dvid, uint8_t id, double *angle);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double *angle

      取得した現在角度[deg]の保存先。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <stdio.h>
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      uint8_t id = 1;
      DXL_GetModelInfo (dev, id);
      DXL_SetOperatingMode (dev, id, 3);
      DXL_SetTorqueEnable (dev, id, true);
    
      DXL_SetGoalAngle (dev, id, -180.0);
      Sleep (1000);
    
      DXL_SetGoalAngle (dev, id, 180.0);
      for (int i = 0; i < 1000; i++) {
        double pang;
        // 現在角度取得
        if (DXL_GetPresentAngle (dev, id, &pang))
          printf ("%5.1\r", pang);
        Sleep (10);
      }
    
      DXL_SetTorqueEnable (dev, id, false);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_GetPresentAngles anchor.png[107]

複数IDの現在角度を取得する。
ライブラリ内のリストに登録されていないIDは無視される。

bool DXL_GetPresentAngles (TDeviceID dvid, const uint8_t *ids, double *angles, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • bool *angles

      idsで指定されたID順に取得した現在角度[deg]を保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

停止 anchor.png[108]

制御をOFFにする事で制御が停止するのと合わせて脱力状態になります。それでは現在の角度を保持しつつ止めることができないため、指令されたタイミングの角度を取得してその値をそのまま角度指令し直す機能を設けています。

Page Top
DXL_StandStillAngle anchor.png[109]

指定IDを現在角度で停止させる。
動作モードがPosition Controlである事。

bool DXL_StandStillAngle (TDeviceID dvid, uint8_t id);
  • パラメータ
  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top
DXL_StandStillAngles anchor.png[110]

複数IDを現在角度で停止させる。
ライブラリ内のリストに登録されていないIDは無視される。
動作モードがPosition Controlである事。

bool DXL_StandStillAngles (TDeviceID dvid, const uint8_t *ids, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

角速度 anchor.png[111]

DynamixelのコントロールテーブルではVelocityと称しているユニークな単位系を持つアイテムは、モデルによってレンジや分解能が異なります。異なるモデルを混在して運用する場合は非常に不便なため、物理値の角速度[deg/sec]を用いてアクセスします。

Page Top
DXL_SetGoalVelocity anchor.png[112]

指定IDへ目標角速度を指令する。
動作モードがVelocity Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalVelocity (TDeviceID dvid, uint8_t id, double velocity);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double velocity

      目標角速度[deg/s]。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      DXL_GetModelInfo (dev, 1);
      DXL_SetOperatingMode (dev, 1, 1);
      DXL_SetTorqueEnable (dev, 1, true);
    
      // 角速度指令 30deg/s
      DXL_SetGoalVelocity (dev, 1, 30.0);
      Sleep (1000);
    
      // 角速度指令 40deg/s
      DXL_SetGoalVelocity (dev, 1, 40.0);
      Sleep (1000);
    
      DXL_SetTorqueEnable (dev, 1, false);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_SetGoalVelocities anchor.png[113]

複数IDへ個別の目標角速度を指令する。
ライブラリ内のリストに登録されていないIDは無視される。
動作モードがVelocity Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalVelocities (TDeviceID dvid, const uint8_t *ids, const double *velocities, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • const double *velocities

      idsで指定されたID順に目標角速度[deg/s]を保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top
DXL_GetPresentVelocity anchor.png[114]

対象IDの現在角速度を取得する。

bool DXL_GetPresentVelocity (TDeviceID dvid, uint8_t id, double *velocity);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double *velocity

      取得した現在角速度[deg/s]の保存先。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top
DXL_GetPresentVelocities anchor.png[115]

複数IDの現在角速度を取得する。
ライブラリ内のリストに登録されていないIDは無視される。

bool DXL_GetPresentVelocities (TDeviceID dvid, const uint8_t *ids, double *velocities, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • bool *velocities

      idsで指定されたID順に取得した現在角速度[deg/s]を保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

角度と角速度 anchor.png[116]

角度と合わせて角速度を同時に指令することで、指定角度へゆっくり動かすと行った動作を行わせる事ができます。
なお、Dynamixelの角速度制御の分解能はさほど大きくないため、角速度が低い場合は誤差が大きくなります。

Page Top
DXL_SetGoalAngleAndVelocity anchor.png[117]

指定IDへ目標角度と目標角速度を指令する。
動作モードがPosition Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalAngleAndVelocity (TDeviceID dvid, uint8_t id, double angle, double velocity);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double angle

      目標角度[deg]。

    • double velocity

      目標角速度[deg/s]。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      uint8_t id = 3;
      DXL_GetModelInfo (dev, id);
      DXL_SetOperatingMode (dev, id, 3);
      DXL_SetTorqueEnable (dev, id, true);
      // 現在角度から-170degの角度へ30deg/sの角速度で
      DXL_SetGoalAngleAndVelocity (dev, id, -170.0, 30.0);
      Sleep (10000);
      // 現在角度から160degの角度へ40deg/sの角速度で
      DXL_SetGoalAngleAndVelocity (dev, id, 160.0, 40.0);
      Sleep (10000);
      DXL_SetTorqueEnable (dev, id, false);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_SetGoalAnglesAndVelocities anchor.png[118]

複数IDへ個別の目標角度と目標角速度を指令する。
ライブラリ内のリストに登録されていないIDは無視される。
動作モードがPosition Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalAnglesAndVelocities (TDeviceID dvid, const uint8_t *ids, const PAngleVelocity anglevelocity, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • const PAngleVelocity[119] anglevelocity

      idsで指定されたID順に目標角度[deg]と目標角速度[deg/s]を保持する構造体の配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

角度と時間 anchor.png[120]

角度と合わせて時間を同時に指令します。ライブラリ内では時間を角速度(=(目標角度-現在角度)/移動時間)に変換して指令します。
なお、Dynamixelの角速度制御の分解能はさほど大きくないため、移動速度が長い場合は誤差が大きくなります。

Page Top
DXL_SetGoalAngleAndTime anchor.png[121]

指定IDへ目標角度と現在角度から目標角度までの移動時間を指令する。
動作モードがPosition Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalAngleAndTime (TDeviceID dvid, uint8_t id, double angle, double sec);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double angle

      目標角度[deg]。

    • double sec

      移動時間[sec]。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      uint8_t id = 3;
      DXL_GetModelInfo (dev, id);
      DXL_SetOperatingMode (dev, id, 3);
      DXL_SetTorqueEnable (dev, id, true);
      // 現在角度から-150degの角度へ3秒で移動
      DXL_SetGoalAngleAndTime (dev, id, -150.0, 3.0);
      Sleep (4000);
      // 現在角度から180degの角度へ5秒で移動
      DXL_SetGoalAngleAndTime (dev, id, 180.0, 5.0);
      Sleep (6000);
      DXL_SetTorqueEnable (dev, id, false);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_SetGoalAnglesAndTime anchor.png[122]

複数IDへ個別の目標角度と現在角度から目標角度までの移動時間を指令する。
ライブラリ内のリストに登録されていないIDは無視される。
動作モードがPosition Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalAnglesAndTime (TDeviceID dvid, const uint8_t *ids, const double *angles, int num, double sec);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • const double *angles

      idsで指定されたID順に目標角度[deg]を保持する配列の保存先。

    • int num

      対象とするID数

    • double sec

      目標移動時間[sec]。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

電流 anchor.png[123]

XシリーズないしPROシリーズのみで使用でき、モデルが異なっていてもできる限り同じ運用ができるよう物理値の電流[mA]を用いてアクセスします。

Page Top
DXL_SetGoalCurrent anchor.png[124]

指定IDへ目標電流を指令する。
プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalCurrent (TDeviceID dvid, uint8_t id, double current);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double current

      目標電流[mA]。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      DXL_GetModelInfo (dev, 1);
      DXL_SetOperatingMode (dev, 1, 0);
      DXL_SetTorqueEnable (dev, 1, true);
      // 電流指令 200mA
      DXL_SetGoalCurrent (dev, 1, 200.0);
      Sleep (1000);
      // 電流指令 -200mA
      DXL_SetGoalAngle (dev, 1, -200.0);
      Sleep (1000);
      DXL_SetTorqueEnable (dev, 1, false);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_SetGoalCurrents anchor.png[125]

複数IDへ個別の目標電流を指令する。
ライブラリ内のリストに登録されていないIDは無視される。
プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalCurrents (TDeviceID dvid, const uint8_t *ids, const double *currents, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • const double *currents

      idsで指定されたID順に目標電流[mA]を保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top
DXL_GetPresentCurrent anchor.png[126]

指定IDの現在電流を取得する。

bool DXL_GetPresentCurrent (TDeviceID dvid, uint8_t id, double *current);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double *current

      取得した現在電流[mA]の保存先。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top
DXL_GetPresentCurrents anchor.png[127]

複数IDの現在電流を取得する。
ライブラリ内のリストに登録されていないIDは無視される。

bool DXL_GetPresentCurrents (TDeviceID dvid, const uint8_t *ids, double *currents, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • bool *currents

      idsで指定されたID順に取得した現在電流[mA]を保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top

PWM anchor.png[128]

現時点でXシリーズのみで使用でき、モデルが異なっていてもできる限り同じ運用ができるよう物理値のデューティー比[%]を用いてアクセスします。

Page Top
DXL_SetGoalPWM anchor.png[129]

指定IDへ目標PWMを指令する。
動作モードがPWM Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalPWM (TDeviceID dvid, uint8_t id, double pwm);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double pwm

      目標PWM[%]。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

  • 使用例
    #include <dx2lib.h>
    
    void main (void) {
      TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
      DXL_GetModelInfo (dev, 1);
      DXL_SetOperatingMode (dev, 1, 16);
      DXL_SetTorqueEnable (dev, 1, true);
      // PWM指令 50%
      DXL_SetGoalPWM (dev, 1, 50.0);
      Sleep (1000);
      // PWM指令 -40%
      DXL_SetGoalPWM (dev, 1, -40.0);
      Sleep (1000);
      DXL_SetTorqueEnable (dev, 1, false);
      DX2_ClosePort (dev);
    }
    
Page Top
DXL_SetGoalPWMs anchor.png[130]

複数IDへ個別の目標PWMを指令する。
ライブラリ内のリストに登録されていないIDは無視される。
動作モードがPWM Controlである事と、プロトコルV2のDynamixelは明示的に制御を開始しない限りモータの制御を行わない。

bool DXL_SetGoalPWMs (TDeviceID dvid, const uint8_t *ids, const double *pwms, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • const double *pwms

      idsで指定されたID順に目標PWM[%]を保持する配列の保存先。

    • int num

      対象とするID数

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top
DXL_GetPresentPWM anchor.png[131]

指定IDの現在PWMを取得する。

bool DXL_GetPresentPWM (TDeviceID dvid, uint8_t id, double *pwm);
  • パラメータ
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t id

      対象とするID (0~252)。

    • double *pwm

      取得した現在PWM[%]の保存先。

  • 戻り値
    • bool

      処理が正常終了したらtrue、それ以外はfalseを返す。

Page Top
DXL_GetPresentPWMs anchor.png[132]

複数IDの現在PWMを取得する。
ライブラリ内のリストに登録されていないIDは無視される。

bool DXL_GetPresentPWMs (TDeviceID dvid, const uint8_t *ids, double *pwms, int num);
    • TDeviceID[44] dvid

      DX?_OpenPortで開いた際のTDeviceID[44]

    • uint8_t *ids

      対象とするID一覧を保持する配列の保存先。

    • bool *pwms

      idsで指定されたID順に取得した現在PWM[%]を保持する配列の保存先。

    • int num

      対象とするID数

Page Top

オリジナルな定義 anchor.png[133]

TDXL_DevType
enum {
  devtNONE, devtDX, devtAX, devtRX, devtEX, devtMX, devtXL320, devtPRO, devtPROP, devtX
}
デバイスのグループ分け。Dynamixelはこのグループで概ねの機能が大別される。

TDXL_ModelInfo, *PDXL_ModelInfo
struct {
  uint16_t modelno;&brt// デバイス固有のモデル番号
  char name[16]; // デバイス名
  TDXL_DevType[134] devtype; // デバイスのグループ
  struct { // 位置の範囲
    int32_t max;
    int32_t min;
  } positionlimit;
  struct { // 角度の範囲
    double max;
    double min;
  } anglelimit;
  struct { // 速度の範囲
    int32_t max;
    int32_t min;
  } velocitylimit;
  struct { // PWMの範囲
    int32_t max;
    int32_t min;
  } pwmlimit;
  double velocityratio; // 角速度変換係数 [deg/sec]
  double currentratio; // 電流変換係数 [mA]
  double pwmratio; // PWM変換係数 [%]
}
Dynamixel固有の情報(モデル名や本APIで使用する各制御値の物理値変換係数等)をまとめた構造体でアライメントは1バイト。
TAngleVelocity, *PAngleVelocity
struct {
  double angle;
  double velocity;
}
角度と各速度のペア。

Last-modified: 2019-04-03 (Wed) 19:08:13 (JST) (201d) by takaboo