Table of contents

概要 anchor.png

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

なお、PCとBTE061D・BTE061E・BTE068・BTE068B・BTE068C・BTE082・BTE083・BTE074・BTE074B・BTE079・BTE080・BTE079B・BTE080B・BTE079C・BTE080C・BTE096・BTE101・BTE110・BTX229のいずれかがUSBポートに接続され、PCのOSに仮想COMポートが増設された状態で使用するものとします。BTE100の場合はRaspberry Piに依存します。

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

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

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

最新版のアーカイブファイルには以下のファイルが同梱されます。必要に応じて解凍してください。

DX2LIBdx2lib_x32.dllライブラリ本体
dx2lib_x64.dll
libdx2lib_x32.aMINGW用ライブラリ(定義のみ)
libdx2lib_x64.a
dx2lib_x32.llbMSVC用ライブラリ(定義のみ)
dx2lib_x64.lib
dx2lib.cppライブラリソース
dx2lib_intuitive.cpp
dx2lib.hライブラリヘッダ
dx2memmap.hDXLアイテムアドレス定義ヘッダ
dx2lib_matlab.hmatlab用ヘッダ
dx2lib.pypython用モジュール
makelib.cmdWindows向けライブラリ再構築用バッチ
build_dx2lib.shLinux向けライブラリ再構築用スクリプト
SampleCodeCsmpl??.cサンプル
dxmisc.hサンプル共通設定
kbhit.hkbhitエミュレーション
makefileサンプルコンパイル用makefile
makeexe.cmdWindows向け再構築用バッチ
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サンプル
kbhit.pykbhitエミュレーション
dx2lib.pyDX2LIBフォルダに収録されるものと同一
dx2lib_x32.dll
dx2lib_x64.dll
LabVIEW2011sample??.viサンプル
DX2LIB.llbDX2LIBラッパーライブラリ
DX2LIB_DXL.llbDX2LIBラッパーライブラリ
DX2LIB_Wrapper.llb
dx2lib_x32.dllDX2LIBフォルダに収録されるものと同一
EXCELtext.xlsサンプルシート
dx2lib_x32.dllDX2LIBフォルダに収録されるものと同一
dx2lib_x64.dll
Rubysmpl??.rbサンプル
dx2lib_x32.dllDX2LIBフォルダに収録されるものと同一
dx2lib_x64.dll
Page Top

開発環境毎の設定 anchor.png

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

Page Top

GCC Developer Lite anchor.png

GCC Developer Liteの詳細についてはこちら。
「基本パック」と「WINパック」をダウンロードしてインストールしてください。

'SampleCode\C'フォルダにはAPIの基本的な使い方を紹介したサンプルが同梱されます。ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。

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

静的に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

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

#define _DYNAMICLOAD
#include "dx2lib.h"

これによりヘッダファイル内の諸定義が切り替わり、LoadDLLとUnloadDLLで動的なDLL読み込みと破棄ができます。

  TDeviceID   dev;
  // DLLを読み込み
  if (LoadDLL ()) {
    if ((dev = DX2_OpenPort (COMPORT, BAUDRATE))) {
      ...
      DX2_ClosePort (dev);
    }
    // DLLを破棄
    UnloadDLL ();
  }

LoadDLLが成功していない状態で各APIを呼び出してはいけません。またDLL自体は実行プログラムと同じフォルダかOSがDLLを検索できる場所に配置しておく必要があります。

Page Top
サンプルフォルダ内のmakefileを使用 anchor.png

サンプルをコンパイルするだけならばGCC Developer Liteを起動する必要は無く、サンプルフォルダ内に同梱される「makeexe.cmd」を実行すればmakefileを読み込んでGCC Developer Liteに同梱されるmakeを使用してコンパイルします。
引数にソース名をしていするとそのソースだけコンパイル、何も付けなければフォルダ内の拡張子がCのソースファイル全てがコンパイル対象となります。

makeexe sample2_ping2 (特定のソースのみコンパイル)
makeexe (カレントの全ソースをコンパイル)

なおI/Fのポート名やボーレート等はサンプル共通として「dxmisc.h」に記述してありますので、環境に応じて修正した上でコンパイルして下さい。

// マクロ定義
#if _WIN32  // Wiindows時
#define _COMPORT    "\\\\.\\COM3"   // ポート名
#define _COMPORT2   "\\\\.\\COM4"
#else       // LinuxやmacOS時
#define _COMPORT    "/dev/ttyUSB0"  // ポート名
#define _COMPORT2   "/dev/ttyUSB1"
#endif
#define _BAUDRATE   (57600)         // ボーレート[bps]
#define _TARGETID   (1)             // 対象ID
#define _TARGETID2  (2)             // 対象ID

またバッチファイル内においてコンパイラなどのツール類へのパスを通す際に64bit環境を優先しています。

Page Top

Microsoft Visual C++ anchor.png

Visual C++ 2010 Expressで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

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

vi_frontpanel.png
vi_diagram.png
Page Top

DELPHI anchor.png

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

Page Top

VB anchor.png

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

Page Top

Ruby anchor.png

'SampleCode\Ruby'フォルダにサンプルが同梱されます。ライブラリ名・ポート・ボーレート・ID等は使用する環境に合わせて適宜修正して使用します。
Rubyはオープンソースの動的なプログラミング言語で、外部のライブラリはfiddleを使用してアクセスします。

require "fiddle/import"

module DX2LIB		
  extend Fiddle::Importer
  dlload './dx2lib_x32.dll'
  extern 'void * DX2_OpenPort( const char *, long )'
  extern 'char DX2_Active( void * )'
  extern 'char DX2_Ping( void *, unsigned char, unsigned short * )'
  extern 'char DX2_ClosePort( void * )'
end

devid = dx2lib.DX2_OpenPort( 'ポート名', ボーレート )

LinuxやmacOSの場合は予めライブラリを再構築しておいて下さい。

Page Top

Python anchor.png

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

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

なおdx2lib.pyはctypesによるDLLの単純なラッパーに過ぎませんので、Pythonならではの抽象的な定義は何一つ受け付けてくれません。Pythonからプログラミングを始めた方は微妙に扱いづらいかと思いますので、詳細はサンプルコードを参考にしてください。

LinuxやmacOSの場合は予めライブラリを再構築しておいて下さい。

Page Top

Java anchor.png

Page Top

MathWorks MATLAB anchor.png

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

  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 & macOS anchor.png

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

  1. ダウンロードと展開
    ライブラリのアーカイブファイルをダウンロードし展開
    wget https://www.besttechnology.co.jp/download/DX2LIB_V3.0.zip
unzip DX2LIB_V3.0.zip
  2. ライブラリ及び共有ライブラリの生成
    DXLIB2ディレクトリに移動し同梱のスクリプトファイルを実行
    gccは予めインストールされている必要がある 
    cd DX2LIB_v3.0/DX2LIB
bash ./build_dx2lib.sh
    コンパイルが成功するとライブラリファイルがサンプルディレクトリにコピーされる
  3. ユーザプログラムとのリンク
    生成したライブラリファイルと自身のソースをリンクする。
    ポート・ボーレート等は使用する環境に合わせて適宜追加・修正する。
    ライブラリ検索パスは必要に合わせて変更する。
    gcc sample.c -L. -ldx2lib -o sample

'SampleCode\C'のサンプルプログラムはmakeを使ってコンパイルできます。

make sample2_ping2 (特定のソースのみコンパイル)
make (カレントの全ソースをコンパイル)

コンパイルや実行にあたってI/Fやカーネル・ディストリビューションに依存しますので、そのまま使用できない場合は適宜ソースを修正下さい。またWindowsを前提とした_DYNAMICLOADマクロが宣言されているとコンパイルできません。
なおI/Fのポート名やボーレート等はサンプル共通として「dxmisc.h」に記述してありますので、環境に応じて修正した上でコンパイルして下さい。
またmacOSの場合のポート名は「/dev/tty.usbserial-????」ではなく「/dev/cu.usbserial-????」を指定してください。更に最近のmacOSにおける標準の機能ではlatency timeを変更できなかったので、以下のようなコードで対応してみてください(USB I/Fの抜き挿しの度に実行する必要がありますが...)。

// brew install libftdi
// cc -I/opt/homebrew/include/libftdi1 -L/opt/homebrew/lib -lftdi1 setlatency.c -o setlatency

#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <ftdi.h>

int main (void) {
  int result = EXIT_FAILURE;
  struct ftdi_context *ftdic;
  struct ftdi_device_list *devlist;
  bool f = true, b = false;

  if ((ftdic = ftdi_new ()) != 0) {
    ftdi_set_interface (ftdic, INTERFACE_ANY);
    int num = ftdi_usb_find_all (ftdic, &devlist, 0, 0);
    if (num > 0) {
      for (int i = 0; i < num; i++) {
        printf ("%d: ",i);
        if (ftdi_usb_open_dev (ftdic, devlist[i].dev) == 0) {
          char s[2][512];
          unsigned char prev_latency;
          if (ftdi_read_eeprom(ftdic) == 0 && ftdi_eeprom_decode(ftdic,0) == 0 && ftdi_eeprom_get_strings(ftdic, s[0], 512, s[1], 512, NULL, 0) == 0)
            printf("[%s][%s] ", s[0], s[1]);
          if (ftdi_get_latency_timer (ftdic, &prev_latency) == 0) {
            b = (ftdi_set_latency_timer (ftdic, 1) == 0);
            printf ("prev latency = %i to %s\n", prev_latency, b ? "1" : "?");
          } else b = false;
          f = f && b;
        }
        ftdi_usb_close (ftdic);
      }
    } else printf ("no device found.\n");

    if (f && b) result = EXIT_SUCCESS;
    ftdi_list_free (&devlist);
    ftdi_free (ftdic);
  }
  return result;
}
Page Top

API anchor.png

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

注意事項：
DynamixelのStatus Return Levelを必ず2に設定した上で使用する事。それ以外の値が設定されていた場合はAPIが想定した応答が得られず、タイムアウトするまでAPIから返らない。

Page Top

DX2_OpenPort anchor.png

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

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

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

    • long baud

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

  • 戻り値
    • TDeviceID

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

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

DX2_ClosePort anchor.png

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

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

既にオープンされているTDeviceIDの通信速度の変更を行う。
実行すると強制的に受信バッファがクリアされる。

bool DX2_SetBaudrate (TDeviceID dvid, long baud);
  • パラメータ
    • TDeviceID dvid

      DX2_OpenPortで開いた際のTDeviceID。

    • long baud

      新しい通信速度[bps]。

  • 戻り値
    • 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

指定されたTDeviceIDのポートが開かれており、使用可能であるかを確認する。
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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint32_t offsettime

      タイムアウトオフセット時間[ms]

  • 戻り値
    • bool

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

Page Top

DX2_Ping anchor.png

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • 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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint32_t *num

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

    • TDxAlarmStatus *AlarmStatus

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

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • 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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • 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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint16_t adr

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

    • uint8_t *rdata

      読み出した値の保存先。

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint16_t adr

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

    • uint8_t dat

      書き込む値。

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint16_t adr

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

    • uint16_t *rdata

      読み出した値の保存先。

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint16_t adr

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

    • uint16_t dat

      書き込む値。

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint16_t adr

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

    • uint32_t *rdata

      読み出した値の保存先。

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint16_t adr

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

    • uint32_t dat

      書き込む値。

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint16_t adr

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

    • uint8_t *rdata

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

    • uint32_t len

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

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint16_t adr

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

    • uint8_t *dat

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

    • uint32_t len

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

    • TErrorCode *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

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 dvid

      DX2_OpenPortで開いた際のTDeviceID。

    • TSyncReadParam *param

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

    • uint32_t *num

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

    • uint8_t dat

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

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t *dat

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

    • uint32_t size

      パラメータのサイズ。

    • TErrorCode *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

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 dvid

      DX2_OpenPortで開いた際のTDeviceID。

    • TBulkReadParam *param

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

    • uint32_t *num

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

    • uint8_t dat

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

    • TErrorCode *err

      エラーコード。

  • 戻り値
    • bool

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

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

const TBulkReadParam param[3] = {
  {1,100,20}, // ID=1の100番地から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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t *dat

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

    • uint32_t size

      パラメータのサイズ。

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • TInstruction inst

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

    • uint8_t *param

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

    • uint32_t len

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

    • TErrorCode *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

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

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

      DX2_OpenPortで開いた際のTDeviceID。

    • uint8_t *rdata

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

    • uint32_t readsize

      rdataのサイズ。

    • uint32_t *rlen

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

    • int timeout

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

    • TErrorCode *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

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で使用される。
TSyncReadParam
struct {
  uint16_t addr;
  uint16_t length;
  uint8_t ids[256];
}
addr, length, idsをまとめた構造体でアライメントは1バイト。DX2_ReadSyncDataで使用される。
TBulkReadParam
struct {
  uint8_t id;
  uint16_t addr;
  uint16_t length;
}
id, addr, lengthをまとめた構造体でアライメントは1バイト。DX2_ReadBulkDataで使用される。
TBulkReadResult
struct {
  uint16_t size;
  uint8_t id;
  TErrorCode err;
  uint8_t dat[];
}
size, id, err, datをまとめた構造体でアライメントは1バイト。DX2_ReadBulkDataで読み出されたデータのアクセスに使用される。
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

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

Page Top
DXL_ScanDevices anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

PDXL_ModelInfo DXL_GetModelInfo (TDeviceID dvid, uint8_t id);
  • パラメータ
    • TDeviceID dvid

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

  • 戻り値
  • 使用例 
    #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

ライブラリ内のリストに登録された全てのデバイスの情報をコンソールに出力する。
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

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

void DXL_InitDevicesList (void);
Page Top

エラー anchor.png

Page Top
DXL_GetErrorCode anchor.png

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

TErrorCode DXL_GetErrorCode (TDeviceID dvid, uint8_t id);
  • パラメータ
    • TDeviceID dvid

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

  • 戻り値
Page Top
DXL_GetHWErrorCode anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint8_t *hwerr

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

  • 戻り値
    • bool

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

Page Top

運転・動作モード anchor.png

運転モードはDynamixelのDrive Mode、動作モードはOperating Modeを意味します。
運転モードはデフォルトの回転方向やプロファイルの選択、マスタースレーブの設定を行います。
動作モードについてはDynamixel X・Pシリーズの動作モードを基準とし、他のモデルにおいてもこの動作モードの番号を踏襲することとします。

Page Top
DXL_SetDriveMode anchor.png

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

bool DXL_SetDriveMode (TDeviceID dvid, uint8_t id, uint8_t mode);
  • パラメータ
    • TDeviceID dvid

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint8_t mode

      機種依存あり

  • 戻り値
    • bool

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

  • 使用例 
    #include <dx2lib.h>

void main (void) {
  TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
  // ID:1を検索し見つかれば登録
  DXL_GetModelInfo (dev, 1);
  // ID:1のXシリーズをTime-Base Profileに設定
  DXL_SetDriveMode (dev, 1, 4);
  DX2_ClosePort (dev);
}
Page Top
DXL_SetDriveModesEquival anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • int num

      対象とするID数

    • uint8_t mode

      機種依存あり

  • 戻り値
    • 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のDrive Modeを出荷時デフォルト値に設定
  DXL_SetDriveModesEquival (dev, ids, sizeof (ids), 0);
  DX2_ClosePort (dev);
}
Page Top
DXL_SetOperatingMode anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint8_t mode

      Dynamixel Xシリーズの動作モードを想定し、それに完全対応しないデバイスに対しては近似値もしくは失敗を返す。
      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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • int num

      対象とするID数

    • uint8_t mode

      Dynamixel Xシリーズの動作モードを想定し、それに完全対応しないデバイスに対しては近似値もしくは失敗を返す。
      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

対象IDの動作モードを取得する。なお内部ではDrive Modeも一緒に取得し保持している。

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • uint8_t *mode

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

  • 戻り値
    • bool

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

Page Top

LED anchor.png

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

Page Top
DXL_SetLED anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • bool en

      trueで点灯、falseで消灯。

  • 戻り値
    • bool

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

Page Top

制御ON/OFF anchor.png

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

Page Top
DXL_SetTorqueEnable anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • const bool *ens

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top
DXL_SetTorqueEnablesEquival anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • bool *en

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

  • 戻り値
    • bool

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

Page Top
DXL_GetTorqueEnables anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • bool *en

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top

角度 anchor.png

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

Page Top
DXL_SetGoalAngle anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • bool *angles

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top

停止 anchor.png

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

Page Top
DXL_StandStillAngle anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

  • 戻り値
    • bool

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

Page Top
DXL_StandStillAngles anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top

角速度 anchor.png

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

Page Top
DXL_SetGoalVelocity anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • const double *velocities

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top
DXL_GetPresentVelocity anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • double *velocity

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

  • 戻り値
    • bool

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

Page Top
DXL_GetPresentVelocities anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • bool *velocities

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top

角度と角速度 anchor.png

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

Page Top
DXL_SetGoalAngleAndVelocity anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • const PAngleVelocity anglevelocity

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top

角度と時間 anchor.png

角度と合わせて時間を同時に指令します。ライブラリ内では時間を角速度(=(目標角度-現在角度)/移動時間)に変換して指令します。
なお、Dynamixelの角速度制御の分解能はさほど大きくないため、移動速度が長い場合は誤差が大きくなります。
また事前にDXL_SetDriveModeもしくはDXL_SetDriveModesEquivalでVelocity-Base Profile(出荷時デフォルト)を指定しておく必要があります。
最新のファームウェアを備えたDynamixelの場合は角度と時間2のAPIを利用することを推奨します。

Page Top
DXL_SetGoalAngleAndTime anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • const double *angles

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

    • int num

      対象とするID数

    • double sec

      目標移動時間[sec]。

  • 戻り値
    • bool

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

Page Top

角度と時間2 anchor.png

角度と合わせて時間を同時に指令します。目的は先のAPIと同様ですが、Dynamixelの新しいファームウェアに備わっているTime-Base Profileを用いて指令するため、指定時間通りに目標角度に到達します。
事前にDXL_SetDriveModeもしくはDXL_SetDriveModesEquivalでTime-Base Profileを設定しておく必要があります。

Page Top
DXL_SetGoalAngleAndTime2 anchor.png

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

bool DXL_SetGoalAngleAndTime2 (TDeviceID dvid, uint8_t id, double angle, double sec);
  • パラメータ
    • TDeviceID dvid

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • double angle

      目標角度[deg]。

    • double sec

      移動時間[sec] (0.0~32.767)。

  • 戻り値
    • bool

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

  • 使用例 
    #include <dx2lib.h>

void main (void) {
  TDeviceID dev = DX2_OpenPort ("\\\\.\\COM10", 57600);
  uint8_t id = 3;
  DXL_GetModelInfo (dev, id);
  // Time-Base profileを設定
  DXL_SetDriveMode (dev, id, 0x04);
  DXL_SetOperatingMode (dev, id, 3);
  DXL_SetTorqueEnable (dev, id, true);
  // 現在角度から-150degの角度へ3秒で移動
  DXL_SetGoalAngleAndTime2 (dev, id, -150.0, 3.0);
  Sleep (4000);
  // 現在角度から180degの角度へ5秒で移動
  DXL_SetGoalAngleAndTime2 (dev, id, 180.0, 5.0);
  Sleep (6000);
  DXL_SetTorqueEnable (dev, id, false);
  DX2_ClosePort (dev);
}
Page Top
DXL_SetGoalAnglesAndTime2 anchor.png

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

bool DXL_SetGoalAnglesAndTime2 (TDeviceID dvid, const uint8_t *ids, const double *angles, int num, double sec);
    • TDeviceID dvid

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • const double *angles

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

    • int num

      対象とするID数

    • double sec

      移動時間[sec] (0.0~32.767)。

  • 戻り値
    • bool

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

Page Top

電流 anchor.png

電流センサを搭載したモデルのみで使用できます。

Page Top
DXL_SetGoalCurrent anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • const double *currents

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top
DXL_GetPresentCurrent anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • double *current

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

  • 戻り値
    • bool

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

Page Top
DXL_GetPresentCurrents anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • bool *currents

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top

PWM anchor.png

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

Page Top
DXL_SetGoalPWM anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • 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

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • const double *pwms

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

    • int num

      対象とするID数

  • 戻り値
    • bool

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

Page Top
DXL_GetPresentPWM anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t id

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

    • double *pwm

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

  • 戻り値
    • bool

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

Page Top
DXL_GetPresentPWMs anchor.png

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

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

      DX?_OpenPortで開いた際のTDeviceID。

    • uint8_t *ids

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

    • bool *pwms

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

    • int num

      対象とするID数

Page Top

オリジナルな定義 anchor.png

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

TDXL_ModelInfo, *PDXL_ModelInfo
struct {
  uint16_t modelno; // デバイス固有のモデル番号
  char name[16]; // デバイス名
  TDXL_DevType 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バイト。
Attach file: fileGCC_CompileOption_AddDx2lib.png 121DL [Info] fileGCC_CompileOption_AddEtc.png 114DL [Info] fileGCC_CompileOption_sel.png 101DL [Info] filevi_diagram.png 133DL [Info] filevi_frontpanel.png 126DL [Info] fileVCC_property_precompile.png 129DL [Info] fileVCC_property_lib_file.png 129DL [Info] fileVCC_property_lib_path.png 125DL [Info] fileVCC_property_include.png 134DL [Info]
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)
Last-modified: 2023-11-12 (Sun) 00:09:35 (JST) (757d)
Links: GCC Developer Lite BTE098B DXMIO with IMU BTE074B DXSHIELD BTE074C DXSHIELD DYNAMIXEL basic tutorial BTE100B DXHAT BTE100 DXHAT Dynamixel Protocol 2 Library X Series Control table BTE110 PicoSHIELD DXLIB_Arduino BTE098 DXMIO with IMU BTE101 USB2DXIF Dynamixel Library BTE079C USB2RS485 dongle BTE080C USB2TTL dongle BTE096 USB2DXIF dongle BTE080B USB2TTL dongle BTE079B USB2RS485 dongle BTE068C DXHUB DXL_intuitive BTE074 DXSHIELD BTE068B DXHUB Basic operation of PRO using dx2lib DYNAMIXEL Communiation Protocol 1.0 DYNAMIXEL Communiation Protocol 2.0 BTE079 USB2RS485 dongle BTE080 USB2TTL dongle BTE068 Dynamixelコンフィギュレータ BTE061E USB-3WAY BTE061D USBシリアル変換ケーブル BTE083 FDIII-HC ソフトウェア BTE082 USS3コンフィギュレータ