phantom omni setup

• 結構，速いマシンが必要．低スペックの場合，激しく振動したり，良い触感が得られない場合がある．

• 今回は以下のPCを用いました．

• PC：DELL OptiPlex 745

• OS：Windows7 64bit

• CPU：Intel Core2Duo 6700 2.6GHz

• メモリ：4GB

• 1394ボード：Buffalo IFC-ILP4

• PC本体付属の1394ポートは不安定な場合が多いので，別途ボードを用意したほうが良いと思う．

• PCIカードタイプ（Low ProfileでもOK）：Buffalo IFC-ILP4

• PCI Expressタイプ：SUNIX FWB3414G

• Cardbusタイプ：RATOC REX-CFW3H

• Cardbusタイプ：IODATA CB1394L

• ExpressCard/34/54：玄人志向 1394a2-EC34

• Phantom Omniは自ら電源を持つため，1394カード側から電源供給する必要は無い．（なので，4ピンケーブルで接続しても問題は無いはず．やったこと無いけど．）

• 今回は Microsoft Visual Studio 2008 を用いる．

• Visual StudioのExpress系はコンパイラの性能があまり良くないので使わない方が無難．

• C++とC#をインストールする．C++だけだとcl.exeがインストールされず，OpenHaptics Toolkitのコンパイルが出来ないので注意．

• Sensable Downloads - Sensable : http://www.sensable.com/support-downloads.htm の　PHANTOM Device Drivers　をクリック．

• シリアル番号は，Phantom Omni本体の下面に貼ってある．

• 現時点では，PDD_32and64-bit_4.2.131.zip　が最新のようなので，これをダウンロードした．

• SensAble Developer Support Center(DSC)に登録し，OpenHaptics Toolkitを取得する．

• DSC: Registration : http://dsc.sensable.com/register_ohae.asp で必要な情報を入力して，登録．

• しばらくするとパスワードがメールで送られてくる．

• Welcome to the Sensable Developer Support Center : http://dsc.sensable.com/index.aspからログインして，

• アカデミックユースの場合，OpenHaptics™ Academic Edition for Microsoft® Windows® →Software Downloads→Download OpenHaptics Academic Edition for Windows - v2.0 をクリックして，OHAE_Windows_v2.zip をダウンロードする．

• 最新のOpenHapticsはversion 3系だが，まだ私自身が追いつけてないので今回はversion 2系を使う．

• 必要に応じてインストールしておく．

• IFC-ILP4の場合はWindows標準のドライバで動作するので別途インストールは不要．

• PDD_32and64-bit_4.2.131.zip を展開

• もし古いPDDが既にインストールされている場合は，先にアンインストールしておくこと．

• SensAble_PDD_4.2.131_Install.exe をShift+右クリック，管理者として実行をクリック．

• 後は適当に．

• PHANTOM Configurationの画面が出てきたら，OKをクリックして閉じる．

• PCを再起動する．

• Phantom Omniのスタイラスをデフォルトポジション（穴(ink well)に挿した状態）にする．

• デスクトップにあるPHANTOM Testを起動．（本体は，C:\Program Files\SensAble\PHANTOM Device Drivers\PHANToM Test.exe）

• 使用開始時には，必ずすべてのPhantomのキャリブレーションを行うこと．

• スタイラスをink wellから外す際は，ボタン部分を上にしてそっと抜くこと．

• C:\Program Files (x86)\SensAble\3DTouch\examples\bin\HL にあるexeを実行してみる．

• プログラムの説明は，C:\Program Files (x86)\SensAble\3DTouch\doc\OpenHaptics_Examples.htmに書いてある．

• PHANTOM Omni User Guide（C:\Program Files\SensAble\PHANTOM Device Drivers\hardware_documentation\PHNTMOmni_UserGuide.pdf）のAppendix B，Appendix Dを参照．

• Appendix B: Troubleshooting　追記B：トラブルシューティング

  • #7 How do I connect multiple PHANTOM Omni devices, daisy chaining?（#7 複数台のPHANTOM Omniを使うときは，デイジーチェーンで繋ぐの?）

  • To connect more than one PHANTOM Omni device, first connect your primary device to your computer following the instructions on “Connecting the PHANTOM Omni Device” on page 1（複数台のPhantom Omniを使うには，まず10ページの「PhantomOmniのつなぎ方」に従って，1台目のデバイスを繋いで設定する．）

  • Follow the same instructions for the second device, but connect the FireWire cable of your second device into the back of the first device rather than your computer.（同様にして2台目も繋ぐのだが，2台目のデバイスのFireWireケーブルは，直接PCには繋がずに，1台目のデバイスの背面に繋ぐ方が良い．）

  • IMPORTANT Remember to ensure that the connectors are oriented properly to the ports.（重要　コネクタの向きを間違えないように．）

  • See Appendix D: “Configuring Multiple Devices” for more information（詳細はAppendix D「複数デバイスの設定」を参照．）

• Appendix D: Configuring Multiple Devices　追記D：複数台のPHANToMの設定

  • If you want to use more than one PHANTOM haptic device with your computer, you can create as many as 20 uniquely named PHANTOM configurations. Each named PHANTOM configuration can refer to a particular system configuration that you use frequently. Which device to use is defined by the software application which uses it.（複数台のPHANTOMを使う場合は，PHANTOM Configurationを使って，最大20台までのPHANTOMを登録できる．PHANTOM configurationでPhantomに付けた名前を指定することで，どのデバイスを使用するかを選択できる．）

  • To create a new PHANTOM configuration use the PHANTOM Configuration Utility.（新しいPHANTOMを登録するには，PHANTOM Configurationを使う．）

• 関数hdGet*を使う

• 引数に HD_{CURRENT, LAST}_{FORCE, TORQUE, POSITION, VELOCITY, BUTTONS, TRANSFORM}などを指定すれば，それぞれの情報が取得できる．

• HD_CURRENT_*は現在の状態，HD_LAST_*は1フレーム前の状態を表す．

• sample_hdget.cpp

• sample_hdget_dual.cpp

• スタイラスのボタンを押すと力を発生させる．

• ボタン1で+x方向，ボタン2で+y方向，ボタン3（両方押し）で+z方向 sample_force1.cpp

• 複数台の場合，MakeCurrentでデバイスを切り替える． sample_force1_dual.cpp

• 追加のインクルードディレクトリ：$(3DTOUCH_BASE)\include,$(3DTOUCH_BASE)\utilities\include

• 追加のライブラリディレクトリ：$(3DTOUCH_BASE)\lib,$(3DTOUCH_BASE)\utilities\lib

• 追加の依存ファイル（Debug）：hd.lib hl.lib hdud.lib

• 追加の依存ファイル（Release）：hd.lib hl.lib hdu.lib

• $(3DTOUCH_BASE) はOpenHaptics をインストールした際に自動で設定される環境変数で，C:\Program Files (x86)\SensAble\3DTouch

• 数字から始まる環境変数が使えなくなったため，3DTOUCH_BASEでは不具合が起きる．

  • 回避策：手動で適当な環境変数（例えば，変数名：OPENHAPTICS，変数値：C:\Program Files (x86)\SensAble\3DTouch ）を設定し，VisualStudioの設定もこれに合わせて変更すればよい．

• 「error LNK2026: モジュールは SAFESEH イメージには安全ではありません。」が出る．

  • 回避策：メニュー，プロジェクト，プロパティ，構成プロパティ，リンカー，詳細設定

  • 一番下の，安全な例外ハンドラーを含むイメージ，に何も書かない（消去する）．

• 「error LNK2038: '_MSC_VER' の不一致が検出されました。」が出る．

  • 回避策：ライブラリをビルドしたVisual Studioのバージョンと今使っているVisual Studioのバージョンが異なるため発生する．ちゃんと合わせれば問題は解決する．

• C:\Program Files (x86)\SensAble\3DTouch\doc　にPDFある．

• OpenHaptics_Install_win.pdf：Windowsへのインストールガイド

• OpenHapticsAcademicEditionLicense.pdf：使用許諾書

• OpenHaptics_ProgGuide.pdf：プログラミングのガイド

• OpenHaptics_Ref.pdf：関数リファレンス

そのうち書く

hdInitDevice()

Description: Initializes the device. If successful, this returns a handle to the device and sets the device as the current device.

hlCreateContext()

Description: Creates a new haptic rendering context. The haptic rendering context stores the current set of haptic primitives to be rendered as well as the haptic rendering state.

hlMakeCurrent()

Description: Makes a haptic rendering context current. The current rendering context is the target for all rendering and state commands. All haptic rendering commands will be sent to the device in the current context until a context with a different device is made current.

hdMakeCurrentDevice()

Description: Makes the device current. All subsequent device-specific actions such as getting and setting state or querying device information will be performed on this device until another is made current.

hlBeginFrames()

Description: Begins an haptics frame, which is a block of code within which the device state is guaranteed to be consistent. Updates state from the device for current/last information. All state-related information, such as setting state, should be done within a haptics frame.

hlEndFrames()

Description: Ends a haptics rendering pass, that is a block of code that sends primitives to the haptic device to be rendered. hlEndFrame() flushes the set of haptics primitives (that is, shapes, effects) specified since the last hlBeginFrame() to the haptics device. All haptic primitive rendering functions must be made within a begin/end frame pair.

hlBeginShape()

Description: Indicates that subsequent geometry commands will be sent to the haptic renderer as part of the shape indicated until hlEndShape() is called. Geometric primitives may only be sent to the haptic renderer if they are specified inside an hlBeginShape()/hlEndShape() block. Grouping geometric primitives is important for two reasons:

1 Event callbacks will report the shape id of geometric primitives touched, and

2 Correct haptic rendering of geometric primitives that are dynamically moving is

accomplished by looking at frame to frame differences based on shape id.

hlEndShape()

Description: Completes the shape specified by the last call to hlBeginShape(). Geometry, materials, transforms and other state for the shape are captured and sent to the haptic renderer.

hlGenShapes()

Description: For shapes, generates a unique identifier that may be used with hlBeginShape().

hdGet (Parameter Values): hdGetIntegerv(), hdGetFloatv(), hdGetDoublev(), etc

Description: Obtains information about the device. There are five query functions for obtaining information about the device associated with the parameter name used.

version 3.0のマニュアルより抜粋（http://www.sensable.com/documents/documents/OpenHaptics_ProgGuide.pdf）

What is OpenHaptics 3.0?

OpenHaptics 3.0 tries to make programming simpler by encapsulating the basic steps common to all haptics/graphics applications. This encapsulation is implemented in the C++ classes of the QuickHaptics micro API. By anticipating typical use scenarios, a wide range of default parameter settings is put into place that allow the user to code haptically enabled applications very efficiently. The common steps required by haptics/graphics applications include: ? Parsing geometry files from popular animation packages ? Creating graphics windows and initializing the OpenGL environment ? Initializing one or multiple haptics devices ? Scene and camera design ? Mapping force and stiffness parameters to objects in the scene ? Setting up callback responses to interactions Through an informed choice of default values for haptic and graphics parameters, a programmer can create a viable scene without the need to explicitly define the camera location, device space parameters, or settings for various shape properties. See "Default Parameter Values for Shape and Display Windows" on page 2-54. The first three programming examples in the next section shows how QuickHaptics can be used to prototype relatively complex scenes with less than a page of C++ code and represents the top of our pyramid. In the second QuickHaptics level are functions that provide custom force effects, more flexible model interactions, and user-defined callback functions. The third level of the pyramid shows that QuickHaptics is built on the foundation provided by the existing OpenHaptics 2.0 HL and HD functions. In most cases, applications previously developed in OH 2.0 should run with little to no modification in OpenHaptics 3.0. The following diagram illustrates the relationship between the QuickHaptics micro API and the existing HD and HL layers of OpenHaptics.

そのうち書く

そのうち書く

そのうち書く

• 概要

  • linux用PDDはLinux用OpenHapticsの中に含まれている．

  • Kernel 2.6.30 以上，raw1394 カーネルモジュールが必要．Mesa，GLUT，MesaGLw，FreeType2も必要．

  • 詳細は HW_userguide_Linux.pdf を参照．

• ダウンロード

  • DSCから，OpenHaptics Academic Edition for Linux →　Software Downloads　→　Download OpenHaptics Academic Edition for Linux - v3.0 　をクリックして， OpenHapticsAE_Linux_v3_0.zip　をダウンロードする．

  • zipを展開し，中身を見る．

  • # unzip OpenHapticsAE_Linux_v3_0.zip

  • # cd OpenHapticsAE_Linux_v3_0

  • # ls

  • HW_userguide_Linux.pdf OpenHaptics-AE 3.0/ PHANTOM Device Drivers/

• PDDのインストール

  • rootで実行．

  • # cd PHANTOM\ Device\ Drivers

  • # cd 32-bit （64bit環境では，cd 64-bit）

  • （rpmでインストール）# rpm -ivh phantomdevicedrivers-4.x-x.ix86.rpm

  • （dpkgでインストール）# dpkg -i phantomdevicedrivers_4.x_x.ix86.deb

  • 1394モジュールが組み込まれているかを確認．raw1394が組み込まれていれば問題なし．

  • # cat /proc/modules | grep raw1394

  • raw1394が組み込まれていない場合は以下のコマンドを実行．

  • # /sbin/modprobe raw1394

  • Phantomの登録とテストは以下のコマンドを実行．

  • # /usr/sbin/PHANToMConfiguration

  • # /usr/sbin/PHANToMTest

• OpenHapticsのインストール

  • rootで実行．

    • # cd OpenHaptics-AE\ 3.0

    • # cd 32-bit （64bit環境では，cd 64-bit）

    • （rpmでインストール）# rpm -ivh openhaptics-3.x-x.ix86.rpm

    • （dpkgでインストール）# dpkg -i openhaptics_3.x_x.ix86.deb

  • ヘッダファイルのパス

    • /usr/include/HD

    • /usr/include/HDU

    • /usr/include/HL

    • /usr/include/HLU

    • /usr/include/QH

    • /usr/include/SnapConstraints

  • ライブラリファイルのパス

    • /usr/lib/libHD.so

    • /usr/lib/libHDU.a

    • /usr/lib/libHL.so

    • /usr/lib/libHLU.a

    • /usr/lib/libQH.so

    • /usr/lib/libQHGLUTWrapper.so

    • /usr/lib/libSnapConstraints.a

  • 環境変数の設定．.cshrcなどに追記しておくと良い．

    • # setenv 3DTOUCH_BASE /usr/share/3DTouch

  • サンプルプログラムは以下のディレクトリにあるのでmakeしてください．

    • /usr/share/3DTouch/examples/HL/console

    • /usr/share/3DTouch/examples/HL/graphics

    • /usr/share/3DTouch/examples/HD/console

    • /usr/share/3DTouch/examples/HD/graphics

    • /usr/share/3DTouch/QuickHaptics/examples

• CHAI 3D : http://www.chai3d.org/

• OpenHapticsの代わりになるもの．

• 様々な力覚提示デバイスで共通して使用可能．

• フリー

• Windows, MacOS, Linuxで利用可能

• そのうち書く