アドイン
RoboDK アドインとは、RoboDK ソフトウェアの拡張機能で、特定の操作や製造アプリケーション用にユーザーインターフェースをカスタマイズすることができます。アドインはサードパーティの開発者によって簡単に作成することができ、RoboDK ソフトウェアに新しい機能を追加することができます。
RoboDK アドインを使用すると、RoboDK ソフトウェアをカスタマイズして、特定のアプリケーションのタスクを自動化することができます。
メモ: アドインマーケットプレイスでは、利用可能なアドインを閲覧することができます。RoboDKアドインはRoboDKだけでなく、サードパーティの企業や開発者でも作成することができます。
アドインとは、RoboDK の機能を拡張するためのソフトウェアプラグインのことです。RoboDK のアドインには以下のようなものがあります：
1.繰り返し作業を自動化するユーザー定義スクリプト。
2.追加シミュレーション機能またはライブラリ（ライブラリとしてのプラグイン）。
3.他のソフトウェアツールやハードウェアデバイスと統合するアプリ。
アドインは RoboDK API を使って開発します。RoboDK API は、RoboDK ソフトウェアを操作するための関数やクラスを提供するものです。API は Python、C++、C#、MATLAB などのプログラミング言語で利用できます。
一度作成したアドインは RoboDK にインストールすることができ、メインのユーザーインターフェースから、あるいはカスタムメニューやカスタムボタンからアクセスすることができます。これにより、ユーザはそれぞれのニーズやワークフローに合わせて RoboDK をカスタマイズし、複雑なタスクやプロセスを自動化することができます。
アドインマネージャー
アドインマネージャは RoboDK のアドインのインストール、管理、設定を行うためのツールです。実際、アドインマネージャはRoboDKのアドインそのものです！
注：Add-in Managerは、いわゆるApp Loaderプラグインを置き換えるもので、すべての機能とユーザーインターフェイスを通じてAppを編集する機能を含みます。
Add-in Managerは、利用可能なアドインの参照、有効化または無効化、依存関係の管理、各アドインの詳細情報の表示、展開のためのパッケージ化が可能な完全なユーザインターフェイスを提供することで、アドインのインストール、更新、エクスポートのプロセスを簡素化します。
アドインマネージャを使うには、まずRoboDKの設定でアドインマネージャプラグインを有効にする必要があります：
1.ツール➔アドイン (Shift+I) を選択します。
2.Add-in managerプラグインが有効になっていない場合は、有効にします。
3.ツール➔アドインマネージャ（Shift+A）を選択します。
ユーザーインターフェース
Add-in Manager ウィンドウには、5 つの重要な領域があります：
1.左側のペインでは、アドインをタイプ別に分類しています（アプリ、ポストプロセッサ、ロボットドライバなど）。お気に入りのアドインを簡単に見つけることができます。
2.上部ツールバーは、アドイン一覧の表示モード、名前または説明によるアドインの並べ替えと検索を制御するためのものです。また、インストールされているアドインのリストを更新したり、すべてのアドインを即座に無効にしたりするボタンもあります。
3.メインエリアには、アドインがリストまたは表 (詳細ビュー) として表示されます。
4.説明領域には、選択したアドインの種類、現在の状態、場所、説明、ドキュメントへのリンクに関する情報が含まれています。
5.下のパネルには、アドインマネージャの設定を開いたり、アドインクリエータを実行したり、RoboDKアドインマーケットプレースを開いたり、新しいアドインをインストールしたり、ウィンドウを閉じたりするためのボタンがあります。
アドインの管理
個々のアドインは、リストまたはテーブルで選択したアドインを右クリックして呼び出すことができるコンテキストメニューを使って管理します。リストモードでは、Actions ボタンを押してコンテキストメニューを呼び出すこともできます。
●Enable/Disable：アドインを有効または無効にします。このメニュー項目のアナログは、リストモードではEnable/Disableボタン、テーブルモードではダブルクリックです。
●再読み込み(Reload): Add-in Manager にアドインのすべての設定ファイル(マニフェスト)を再読み込みさせます。これは、アドインのファイルがディスク上で変更された場合に有用です。
●サブプロセスの終了: アドインに属するすべての実行中のアプリケーションを終了します。この関数は、App タイプのアドインでのみ使用できます。
●編集...]: アドインのアセットとマニフェストを Add-in Creator にロードして、アドインの派生バージョンを作成します。
●要件をインストール...: App タイプのアドイン用の追加モジュールをインストールします。このメニュー項目を使用すると、アドインのインストール時に必要なモジュールのインストールを拒否した場合に、必要なモジュールを自動的にインストールするプロセスを開始できます。
●パッケージの作成...: Add-in Creator ウィザードを開き、既存のレガシーアプリから RoboDK パッケージ(.rdkp ファイル)を作成します。
●アドインの場所を開く: アドインファイルがあるフォルダのエクスプローラウィンドウを開きます。
●アンインストール：アドインを無効にし、ディスクから完全に削除します。
新しいアドインのインストール
新しいアドインのインストールは、下部のパネルにある[インストール...]ボタンをクリックし、ディスク上の.rdkpファイルを検索することで行います。また、ファイルをフォルダからアドインマネージャウィンドウにドラッグ＆ドロップすることでもインストールできます。
アドインをインストールする前に、アドインマネージャがアドインの保存場所を尋ねます。
●カレントユーザストレージは、システム上で実行中のカレントユーザのフォルダの一つにアドインをインストールします。このオプションは、アドインを一人のユーザーしか利用できないようにしたい場合や、現在のユーザーには RoboDK フォルダにアドインをインストールするための十分なアクセス権がない場合に便利です。
●RoboDK グローバルストレージはアドインをメインプログラムフォルダにインストールします。この場合、そのコンピュータで作業しているすべてのユーザがアドインを利用できるようになります。現在のユーザに RoboDK フォルダへの書き込み権限がない場合、グローバルストレージへのインストールは失敗することがあります。
プラグインインターフェース
RoboDK プラグインインタフェースは、C++ プログラミング言語と Qt ライブラリを使って RoboDK のカスタムプラグインを作成するための API です。
注：新しいプラグインを作成するための技術的なドキュメントは、こちらのリンクから入手できます： https://robodk.com/doc/en/PlugIns/index.html.
プラグインインターフェースは、C++のクラスと関数のセットを提供し、RoboDKとのインタラクションを可能にします。カスタムメニューやツールバー、ダイアログボックスを作成したり、新しいツールや機能を追加してRoboDKの機能を拡張したりすることができます。
開発者はプラグインインタフェースを利用して、他のソフトウェアツールやハードウェアデバイスと統合するプラグインを作成したり、RoboDK 内で複雑なタスクや処理を自動化したりすることができます。プラグインはダイナミックリンクライブラリ (DLL) としてコンパイルすることができ、実行時に RoboDK に読み込ませることができます。
全体として、C++によるRoboDKプラグインインターフェースは、開発者がそれぞれのニーズやワークフローに合わせてRoboDKの機能を拡張し、カスタマイズするための強力で柔軟な方法を提供します。
アプリ
RoboDK Apps は、特定の機能やワークフローを提供するために設計されたアドインの一種です。RoboDK Apps を簡単にカスタマイズして共有することで、RoboDK のユーザーインターフェイスを目的に応じてカスタマイズすることができます。
例えば、RoboDK アプリは、特定のタイプのロボットプログラムを生成するように設計されていたり、特定のハードウェアやソフトウェアと連携するように設計されていたりします。
RoboDK Apps は通常、RoboDK Python API を利用した Python スクリプトで、スタンドアロンファイル (rdkp ファイル) としてパッケージ化されています。アプリ (Add-in) は異なるコンピュータ間で簡単に共有することができます。一度インストールすれば、RoboDK Apps はメインツールバー、または RoboDK ユーザーインターフェースのカスタムメニューやボタンからアクセスすることができます。
RoboDK Apps は、RoboDK API を利用して誰でも開発することができ、他の RoboDK ユーザーに配布したり共有したりすることができます。これにより、ユーザーは新しいアプリを発見してインストールしやすくなり、開発者はカスタムツールやワークフローをより多くのユーザーに提供することができます。
RoboDKアプリの作成
アプリは RoboDK の UI を特定の用途向けにカスタマイズする最も簡単な方法です。Python スクリプトから簡単にアプリを作成することができ、RoboDK のツールバーをカスタマイズしたり、特定の作業を自動化したりすることができます。
注: このツールを使用してアドインを作成する方法の詳細については、アドイン作成セクションをお読みください。
以下の手順に従ってアプリを作成してください：
1.githubにあるRoboDK PluginのリポジトリからAppテンプレートまたはAppのサンプルを取り出し、コンピュータ上に新しいフォルダを作成します。
2.アプリのアクションとして使用するスクリプトを変更、追加、または削除します。各スクリプトは自動的に新しいアクションとして認識され、ツールバーに表示されます（スクリプトファイルの先頭がアンダースコアでない場合）。
3.オプションで、ファイル名が一致するアイコンを追加できます。サポートされているアイコン形式は、PNG、SVG、JPGです。アイコンは後から追加したり、カスタマイズすることもできます。
この時点からアドインマネージャの下部にある[アドインを作成]を選択し、作成したアドインフォルダを選択し、指示に従ってユーザーインターフェイスを使用することができます。
または、ファイル名を変更してAppConfig.iniファイルをカスタマイズすることで、アプリを手動で設定することもできます
4.以下のフォルダにアプリを配置します：C:/RoboDK/Apps/.
5.Add-in Managerを開き、Legacy Appsタブを選択します。
6.アプリが表示されていない場合は、「更新」をクリックしてください。
7.アプリをダブルクリックして有効にし、RoboDKのユーザーインターフェースに表示します。これでアプリのフォルダにAppConfig.iniファイルが自動的に作成されます。
8.AppConfig.ini ファイルを変更することで、RoboDK UI との連携方法をカスタマイズすることができます。各スクリプトは（アンダースコアで始まらない限り）自動的にアクションとして検出されます。デフォルトでは、すべてのアクションは RoboDK メニューとツールバーの新しい項目に配置されます。各アクションやスクリプトをメニューやツールバーに表示したり、1つまたは複数のアイテムのコンテキストメニューオプションとして表示したい場合は、カスタマイズすることができます。
9.アプリを右クリックし、リロードを選択すると、RoboDK UIに変更が反映されます。
10.最後に、[Create package...]を選択して指示に従えば、アプリをRDKP Add-inとしてパッケージ化できます。オプションで、アプリのコードをコンパイルすることもできます。
このRDKPファイルをRoboDKで開くことで、RoboDKがインストールされたコンピュータにこのアプリ/アドインをインストールすることができます。
注: 技術的な情報については、RoboDK API ドキュメントの App セクションや GitHub のプラグインインターフェースの Apps セクションをご覧ください。
ヒント: もしあなたが製品やサービスを販売している企業で、RoboDKマーケットプレイスにあなたのアドインを掲載したい場合は、RoboDKにご連絡ください。ソースコードの共有は必須ではありません。Readme ファイルとマニフェストファイルだけで十分です。これにより、あなたの会社や製品、サービスをより多くの方に知っていただくことができます。詳しくはアドインの投稿をご覧ください。
アドインクリエーター
アドインクリエータを使うと、RoboDK アドインパッケージを簡単に作成したり変更したりすることができます。アドインクリエータはアドインマネージャの一部です。
Add-in Creatorは、Tools-Add-in Managerを選択し、Add-in Managerの下部にあるCreate Add-inボタンをクリックすることで開くことができます。
Add-in Creatorウィザードを開くと、以下のオプションを選択できます：
●新規アドインをゼロから作成: 新しい RoboDK パッケージ (RDKP ファイル) が作成されます。
●フォルダまたはレガシーアプリケーションから新規アドインを作成: この場合、アドインのファイルがあるフォルダへのパスを指定します。パッケージを作成しないオプションを使うと、RoboDK パッケージ(RDKP ファイル)を作成せずに、アドインがあるフォルダで直接アドインを編集することができます。
●既存のアドインを修正する: 既存の RoboDK パッケージを開いて修正し、新しいアドインを作成します。
アドインの作成と編集
タイプ、名前、作者情報などの基本情報を入力することで、簡単に新しいAdd-inを作成できます。
Add-on Creator ウィンドウでは、必須フィールドが太字で表示されます。全部で5つあります：
1.タイプアプリ、ロボットドライバ、言語など、Add-inのタイプです。
2.名前：アドインの名前。
3.固有の識別子: この特定のアドインに属する固有の識別子です。このフィールドの隣にあるチェックボックスをオンにすると、編集モードが有効になり、任意の識別子を設定することができます。
注：domain.company.type.nameの形式で記述された一意の識別子を使用することをお勧めします。別の形式の識別子を使用することも可能ですが、推奨される形式に従うことをお勧めします。
4.バージョン：バージョンはセマンティックバージョン形式(major.minor.patch)で記述します。
5.リビジョン：アドインの変更回数で、1以上の数値をとります。
残りのフィールドはオプションですが、アドインをより正確に説明することができます：
6.著者：著者の姓名、または会社名やチーム名（複数の著者がいる場合）。
7.会社名会社名
8.言語：アドインで使用される言語。IETF BCP 47標準のすべての言語がリストされています。
9.コンテンツのステータス：最終、内部テスト、ベータなど、アドインのステータス。
10.説明アドインの簡単な説明。
11.修正者：このフィールドは、誰かが他の作者のアドインを修正し、その修正の作者として言及されたい場合に使用できます。
12.作成日：アドインの最初のバージョンの作成日（自動的に入力されます）。
13.変更日：アドインの変更日（自動的に入力されます）。
14.電子メール販売、サポート、フィードバックのための電子メールアドレス。
15.ウェブサイト貴社（Add-inの開発者）のウェブサイト。
16.ドキュメントリンク：Add-inのドキュメントへのリンクです。
17.リポジトリリンク：オープンソースのAdd-inの場合、GitHubリポジトリやその他の公開リポジトリへのリンク。
18.キーワード：アドインマーケットプレイスでアドインを検索しやすくするためのキーワード（タグ）のリストです。
アドインにアセットを追加する
アドインには、1つ以上のアセットが含まれている必要があります。アセットとは、アドインのアクションを定義するスクリプトやアイコンのことです。
Add-in Assets] ページは、3 つの機能エリアに分かれています：
1.パッケージアイコン選択エリア。
2.ファイルツリー領域。
3.ファイル内容のプレビューエリア
このページのボタンとチェックボックスの目的：
●TargetPath：TargetPath: ターゲットパス] ボタンをクリックすると、現在のアイコンファイルのプロパティウィンドウが開き、ターゲットプロパティを設定できます（パッケージ内部の対応するセクションを参照してください）。
●アイコンの変更...ボタンで、現在のパッケージアイコンを新しいものに置き換えることができます。
●アイコンの削除]ボタンは、パッケージの現在のアイコンを削除し、作成されるパッケージのタイプに対応するデフォルトのアイコンを設定します。
●新規フォルダ］ボタンは、ファイルツリーの選択したブランチに新しいサブフォルダを作成します。
●Add Asset...ボタンは、ファイルツリーの選択したブランチに新しいファイルを追加します。
●削除] ボタンは、ロックされている項目を除き、選択した項目をファイルツリーから削除します。
●Make Python Packageチェックボックスは、Pythonインタプリタがプロジェクトのファイルを外部ロード可能なモジュールとして使用できるように、__init__.pyファイルをプロジェクトに追加します。
注: このオプションは、Appタイプのアドインを作成する場合にのみ表示されます。
Python スクリプトは、後で .pyc 拡張子を持つファイルにコンパイルするためにマークアップすることができます。コンパイルのプロセスはウィザードの次のページに表示されます。
Target Pathフィールドでは、各ファイルのターゲットプロパティを設定することができます。これは、必要なパスと変数名を入力して手動で行うか、ターゲット・パスの歯車ボタンをクリックしてプロパティ・ウィンドウを起動することで行うことができます：
ファイルプロパティダイアログボックスでは、ターゲット プロパティの値を設定し、使用可能な変数の便利なリストを提供します。また、ファイルがデプロイされるターゲットプラットフォームのパラメータ（OSタイプとバージョン、CPUモデル）を定義することもできます。
Python スクリプトのコンパイル
Add-in アセットの追加時に Python スクリプトが 1 つでも選択されていれば、Python Compilation ページが開きます。
コンパイルは、利用可能なすべての Python インタプリタによって実行されます。利用可能で使用されるインタプリタのリストは Add-in Manager Settings ウィンドウで編集できます。コンパイルプロセス自体はユーザーの介入を必要とせず、ページには潜在的な問題を発見するための詳細なコンパイルログが表示されます。
重要: スクリプトをコンパイルすることで、アプリケーションのソースコードを簡単に難読化することができます。しかし、知的財産を適切に保護することを心配するのであれば、 Python スクリプトから pyd や実行可能ファイルを作成する Cython のような他のコンパイル方法を使うことを検討すべきです。カスタム実行ファイルをアクションとして使うこともできます。
アプリの設定
アプリの設定ページでは、作成したアクションやスクリプトを RoboDK ユーザーインターフェース (メニューやツールバー) からどのようにリンクさせるかをカスタマイズすることができます。App 設定ウィンドウは App タイプの Add-in を作成する場合に表示されます。
このページのパラメータは、AppConfig.iniファイルの内容を定義します。設定可能なキーと値はこのページに記載されています。RoboDKではアプリごとにメニューとツールバーがあります。メニュー項目やツールバーのボタンはアプリ用語でアクションと呼ばれます。アクションを表示するための条件や、メニュー内での順番、ホットキーの割り当てなどを定義することができます。
パラメータの基本セットは以下の通り：
●メニュー名：RoboDKのメインメニューの項目名です。
●表示します：このチェックボックスをオフにすると、RoboDKのメインメニューにメニューが表示されなくなります。
●親メニュー：アプリの子メニューを作成するメインメニュー項目を選択するか、新しいメインメニュー項目を作成する場合はMainを選択します。
●優先順位：他のAppのメニューに対して、このAppのメニューの表示順を決める優先順位を設定します（低い方が先に表示されます）。
●ツールバーエリアアプリのツールバーを配置する RoboDK メインウィンドウ上の位置（側面）。
●ツールバーのスケールRoboDK ツールバーアイコンの現在のサイズに対する比率です。
●コマンドアドインが有効化されたときに実行される RoboDK API コマンドです。
AppConfig.ini ファイルと同じフォルダにある Python スクリプトごとにアクションが作成されます。スクリプトが補助的な性質のものである場合、Visible プロパティを使用してそのようなアクションを抑制できます。
アクションプロパティは以下のリストで表されます：
●名前：メニューやツールバーに表示されるアクションの名前。
●説明: メニューアイテムやツールバーボタンの上にマウスポインタを置いた時のツールチップのテキスト。
●優先順位：このAppの他のアクションとの関係でアクションが表示される順序（低い方が先に表示されます）。
●ショートカット
●可視
●開発者専用: このアクションはRoboDKを開発者モード(Ctrl+Alt+Shift+G)に切り替えた場合にのみ表示されます。
●メニューに表示
●ツールバーに表示
●チェック可能：チェック可能なアクションを作成します。チェック可能なアクションは数字でグループ化することもできます。
●コンテキストメニューフィルター: RoboDKツリーの要素の種類を定義します。
●ダブルクリックフィルタ: ダブルクリック時にこのアクションを呼び出す RoboDK ツリーの要素の種類を定義します。
アドインパッケージの作成
RDKパッケージをRDKPファイルとしてビルドすることで、アドインの作成は完了します。これがアドイン作成の最終ステップです。
パッケージを作成する直前の最終段階で、以下のオプションが利用できます：
●パッケージの暗号化：ファイルを暗号化することで、脅威検出システムを回避して簡単に電子メールで送信できるようにします（Googleメールサービスは、添付ファイル内の実行可能ファイルやPythonスクリプトの転送を直接禁止しています）。
●ビルド後にインストール: Add-in Managerに新しく作成したパッケージをインストールさせます。
●包含フォルダを開く：パッケージが作成されたフォルダを開きます。
アドインを投稿
RoboDKアドインを他のRoboDKユーザに利用してもらいたい場合、RoboDKマーケットプレイスに登録することができます。外部の企業や開発者の方からの投稿をお待ちしています。
Add-Inを販売するために掲載することも、無料で提供することもできます。どちらのオプションも、あなたの会社、製品、サービスについての露出を提供します。
アドインを登録するには、メールでご連絡ください。RoboDKがあなたのアドインを適切にRoboDK Marketplaceに掲載するために必要な情報には以下のようなものがあります：
1.Add-Inの説明（readmeファイル）。
2.マニフェスト・ファイル。開発者のウェブサイトや、該当する場合は定価などの追加情報が含まれます。
3.RoboDK アドインを RoboDK パッケージ (RDKP ファイル。アドインクリエータが作成) にします。
4.Add-inの機能を示す少なくとも1つの画像または画面録画。
RoboDK 、RoboDK のオープンソース Add-in マーケットプレイスではを使ってマニフェストファイルの作成方法とその結果を確認することができます。マニフェストファイルの作成と更新には、アドインマネージャを使用します。
注: RDKPファイルとソースコードを共有することは必須ではありません。RDKPとReadmeファイル、およびアドインのデモを添付するだけで、アドインをリストに掲載することができます。
