插件

RoboDK 附加插件是RoboDK 软件的自定义扩展,可让您为特定操作或制造应用定制用户界面。第三方开发人员可以轻松创建插件,为 RoboDK 软件添加新功能。

RoboDK 插件允许您自定义RoboDK 软件,以自动执行特定应用的任务。

注:请访问插件市场,浏览可用的插件。任何人都可以创建 RoboDK 附加组件,包括RoboDK 和第三方公司或开发人员。

Add ins - 图片 1

插件是一种软件插件,通过提供额外的工具、特性或功能来扩展RoboDK的功能。RoboDK 附加插件的一些示例包括:

1.用户自定义脚本,自动执行重复性任务。

2.附加模拟功能或库(作为库的插件)。

3.与其他软件工具或硬件设备集成的应用程序。

插件是使用 RoboDK API 开发的,该 API 提供了一组可用于与 RoboDK 软件交互的函数和类。API 可用多种编程语言编写,包括 PythonC++C# MATLAB

创建插件后,可将其安装在 RoboDK 中,并通过主用户界面或自定义菜单或按钮进行访问。这样,用户就可以根据自己的具体需求和工作流程定制 RoboDK,并实现复杂任务或流程的自动化。

插件管理器

插件管理器是RoboDK中的一个工具,允许用户安装、管理和配置RoboDK插件。事实上,插件管理器本身就是 RoboDK 的一个插件!

注:插件管理器取代了所谓的 App Loader 插件,因为它包括其所有功能以及通过用户界面编辑 Apps 的功能。

Add ins - 图片 2

插件管理器简化了安装、更新和导出插件的过程,它提供了一个完整的用户界面,用户可以在此浏览可用的插件、启用或禁用它们、管理依赖关系、查看每个插件的详细信息,并将它们打包以便部署。

要使用插件管理器,必须首先在 RoboDK 设置中启用插件管理器插件:

1.选择工具附加插件 (Shift+I)

2.如果插件管理器插件未启用,则启用该插件。

3.选择工具插件管理器 (Shift+A)

Add ins - 图片 3

用户界面

插件管理器 "窗口包含五个关键区域:

Add ins - 图片 4

1.左侧窗格按类型(应用程序、后处理器、机器人驱动器等)对插件进行分类。这样设计的目的是让你更容易找到自己喜欢的插件。

2.上部工具栏用于控制插件列表的显示模式、排序和按名称或描述搜索插件。它还包含一个按钮,用于更新已安装插件的列表或立即禁用所有插件。

Add ins - 图片 5

3.主区域以列表或表格(详细信息视图)的形式显示插件。

Add ins - 图片 6

4.说明区域包含所选插件的类型、当前状态和位置、说明和文档链接等信息。

5.下部面板包含用于执行辅助功能的按钮:打开插件管理器设置、运行插件创建器、打开 RoboDK 插件市场、安装新插件或关闭窗口。

管理插件

单个插件可通过右键单击列表或表格中选定的插件来调用上下文菜单进行管理。在列表模式下,也可以按下 "操作 "按钮来调用上下文菜单。

Add ins - 图片 7

    启用/禁用:启用或禁用插件。该菜单项的类似功能是列表模式下的启用/禁用按钮或表格模式下的双击。

    重新加载:强制插件管理器重新读取插件的所有配置文件(清单)。这在插件文件在磁盘上被修改的罕见情况下非常有用。

    终止子进程:终止属于插件的所有正在运行的应用程序。该功能仅适用于 App 类型的插件。

    编辑...将插件资产和清单载入插件创建器,以创建插件的衍生版本。

    安装要求...应用程序类型的插件安装附加模块。如果您在安装插件时拒绝安装所需的模块,可以通过此菜单项启动自动安装过程。

    创建包...打开插件创建向导,从现有的遗留应用程序中创建 RoboDK 包(.rdkp 文件)。

    打开插件位置:打开插件文件所在文件夹的资源管理器窗口。

    卸载:禁用插件并将其从磁盘中完全删除。

安装新插件

安装新插件的方法是单击底部面板上的 "安装... "按钮,然后在磁盘上搜索 .rdkp 文件。也可以将文件从文件夹拖放到插件管理器窗口。

Add ins - 图片 8

在安装插件之前,插件管理器会询问您所需的插件位置。

Add ins - 图片 9

    当前用户存储 将插件安装到系统上运行的当前用户的文件夹中。如果插件只能供一个用户使用,或者当前用户的访问权限不足以将插件安装到 RoboDK 文件夹中,则此选项非常有用。

    RoboDK 全局存储会将插件安装到主程序文件夹中。在这种情况下,在计算机上工作的所有用户都可以使用该插件。如果当前用户没有 RoboDK 文件夹的写入权限,尝试安装到全局存储可能会失败。

插件接口

RoboDK 插件接口是一个应用程序接口,允许用户使用 C++ 编程语言和 Qt 库为 RoboDK 创建自定义插件。

注:创建新插件的技术文档可从以下链接获取 https://robodk.com/doc/en/PlugIns/index.html

插件接口提供了一组C++类和函数,可用于与RoboDK进行交互,包括创建自定义菜单、工具栏和对话框,以及通过添加新工具、特性或功能来扩展RoboDK的功能。

开发人员可使用插件接口创建与其他软件工具或硬件设备集成的插件,或在RoboDK中自动执行复杂的任务或流程。插件可以编译成动态链接库(DLL),在运行时加载到RoboDK中,便于安装和分发。

总之,C++语言的RoboDK插件接口为开发人员提供了一种强大而灵活的方式,使他们能够根据自己的具体需求和工作流程扩展和定制RoboDK的功能。

应用程序

RoboDK 应用程序是一种插件,旨在提供一套特定的功能或工作流程,可轻松定制和共享,以定制特定用途的 RoboDK 用户界面。

例如,RoboDK 应用程序可能被设计用于生成特定类型的机器人程序,或与特定硬件或软件连接。

RoboDK 应用程序通常是使用 RoboDK Python API Python 脚本,并打包为独立文件(rdkp 文件)。应用程序(插件)可以很容易地在不同计算机之间共享。安装后,可通过主工具栏或RoboDK用户界面中的自定义菜单或按钮访问RoboDK应用程序。

任何人都可以使用RoboDK API开发RoboDK应用程序,并可向其他RoboDK用户分发或共享。这样,用户就可以轻松发现和安装新的应用程序,开发人员也可以通过自定义工具和工作流程接触到更多用户。

创建您的 RoboDK 应用程序

应用程序是为特定应用程序定制RoboDK用户界面的最简单方法。您可以通过一个或多个 Python 脚本轻松创建自己的应用程序,这使您可以自定义工具栏,并自动执行 RoboDK 软件内的某些任务。

注意:请阅读 "插件创建器 "部分,了解有关如何使用此工具创建插件的更多详情。

请按照以下步骤创建应用程序:

1.github 上的 RoboDK 插件库中提取应用程序模板或任何应用程序示例,然后在计算机上新建一个文件夹。

2.修改、添加或删除要用作应用程序操作的脚本。每个脚本都会被自动识别为新的操作,并显示在工具栏上(除非脚本文件以下划线开头)。

3.您可以选择添加与文件名匹配的图标插件。支持的图标格式包括 PNGSVG JPG。您还可以稍后添加或自定义图标。

从此时开始,你可以在插件管理器底部选择创建插件,选择你创建的插件文件夹,然后按照提示操作,就可以使用用户界面了。

Add ins - 图片 10

或者,您也可以通过重命名文件和自定义 AppConfig.ini 文件来手动配置应用程序

4.将您的应用程序放入此文件夹:C:/RoboDK/Apps/

5.打开插件管理器,选择 "传统应用程序 "选项卡。

6.如果没有看到您的应用程序,请单击 "刷新"

7.双击您的应用程序以启用它,并在 RoboDK 用户界面中看到它。这将在您的应用程序文件夹中自动创建一个AppConfig.ini 文件。

8.修改AppConfig.ini 文件,自定义应用程序与 RoboDK UI 的集成方式。每个脚本都会被自动检测为一个动作(除非以下划线开头)。默认情况下,所有操作都被置于RoboDK菜单和工具栏的新条目中。您可以自定义是否要在菜单、工具栏中查看每个动作/脚本,或将其作为一个或多个项目的上下文菜单选项。

9.右键点击应用程序,选择 "重新加载",即可在 RoboDK UI 中看到您所做的更改。

10.  最后,您可以选择 "创建软件包... "并按照说明将应用程序打包为RDKP 插件。您可以选择编译应用程序的代码。

您可以用 RoboDK 打开此 RDKP 文件,在任何装有 RoboDK 的计算机上安装此应用程序/插件。

Add ins - 图片 11

注:您可以在 GitHub 插件界面的应用程序部分RoboDK API 文档的应用程序部分和找到更多技术信息。

提示:如果您是一家销售产品或服务的公司,并且您希望在RoboDK市场中列出您的插件,您可以通过联系我们RoboDK提交您的插件共享源代码并非必要条件。只需提供一个自述文件和清单文件即可。这将为您的公司、产品和服务提供知名度。请查看 "提交您的插件 "部分了解更多信息。

插件创建器

通过插件创建工具,您可以轻松创建和修改 RoboDK 的插件包。插件创建工具是插件管理器的一部分。

选择 "工具-插件管理器",然后单击插件管理器底部的 "创建插件 "按钮,即可打开插件创建器。

Add ins - 图片 12

打开插件创建向导后,您可以选择以下选项:

    从头开始创建新插件:这将产生一个新的 RoboDK 包(RDKP 文件)。

    从文件夹或传统应用程序中创建新插件:在这种情况下,您可以指定插件文件所在文件夹的路径。不创建包选项允许您直接在插件所在文件夹中编辑插件,而无需创建 RoboDK 包(RDKP 文件)。

    修改现有插件:打开现有 RoboDK 包,修改并创建新版本。

创建或编辑插件

只需输入类型、名称、作者信息等基本信息,即可轻松创建新插件。

Add ins - 图片 13

"插件创建器 "窗口中,您会发现必填字段以粗体显示。一共有五个:

1.类型:插件类型,如应用程序、机器人驱动器、语言等。

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.  网站:贵公司(插件开发商)的网站。

16.  文档链接:指向插件文档的链接。

17.  版本库链接:对于开源插件,指向插件所在的 GitHub 代码库或其他公共代码库的链接。

18.  关键字:关键字(标签)列表,用于简化在插件市场中搜索插件的过程。

为插件添加资产

插件应包含一个或多个资产。资产可以是定义插件操作的脚本和图标。

Add ins - 图片 14

插件资产 "页面分为三个功能区:

1.包装图标选择区。

2.文件树区域。

3.文件内容预览区

本页按钮和复选框的用途:

    TargetPath目标路径按钮会打开当前图标文件的属性窗口,并允许您设置目标属性(请参阅软件包内部的相应章节)。

    更改图标...按钮允许您用新图标替换当前软件包图标。

    删除图标 "按钮会删除当前软件包的图标,并设置与正在创建的软件包类型相对应的默认图标。

    新建文件夹按钮可在选定的文件树分支中创建一个新的子文件夹。

    添加资产...按钮可将新文件添加到文件树的选定分支中。

    删除按钮可从文件树中删除所选项目,锁定的项目除外。

    Make Python Package 复选框可将 __init__.py 文件添加到项目中,这样 Python 解释器就能将项目文件作为外部可加载模块使用。

注意:该选项仅在创建应用程序类型的插件时显示。

可以对 Python 脚本进行标记,以便稍后编译成扩展名为 .pyc 文件。编译过程将显示在向导的下一页。

Add ins - 图片 15

目标路径 "字段允许你为每个文件设置目标属性。您可以手动输入所需的路径和变量名,也可以在单击目标上的齿轮按钮时调用属性窗口:

Add ins - 图片 16

文件属性对话框允许您设置目标属性值,并提供可用变量的便捷列表。此外,还可以定义部署文件的目标平台参数(操作系统类型和版本、CPU 型号)。

Add ins - 图片 17

编译 Python 脚本

如果在添加插件资产时选择了至少一个 Python 脚本,则将打开 Python 编译页面。

Add ins - 图片 18

编译将由所有可用的 Python 解释器执行。可用和已用解释器列表可在插件管理器设置窗口中编辑。编译过程本身不需要用户干预,页面会显示详细的编译日志以发现潜在问题。

重要:通过编译脚本,您可以轻松地混淆应用程序的源代码。但是,如果您担心要适当保护知识产权,就应该探索使用其他编译方法,如 Cython,从 Python 脚本创建 pyd 或可执行文件。您还可以使用自定义可执行文件作为操作。

应用程序配置

应用程序配置页面允许您自定义从 RoboDK 用户界面(菜单和工具栏)链接您的操作或脚本的方式。如果您创建的是 App 类型的插件,则会看到 App 配置窗口。

Add ins - 图片 19

本页中的参数定义了 AppConfig.ini 文件的内容。本页列出了可能的键和值。在 RoboDK 中,每个应用程序都有自己的菜单和工具栏。菜单项和工具栏上的按钮在 App 术语中称为 "操作"您可以定义显示操作的条件、它们在菜单中的顺序,并为它们分配热键。

基本参数集包括

    菜单名称:RoboDK 主菜单条目名称。

    可见:取消选中该复选框,可防止菜单显示在 RoboDK 的主菜单中。

    父菜单:选择将为其创建App 子菜单的主菜单项,或选择主菜单创建新的主菜单项。

    优先级:设置优先级,决定本应用程序菜单与其他应用程序菜单的显示顺序(低者优先)。

    工具栏区域:应用程序工具栏在 RoboDK 主窗口上的位置(侧面)。

    工具栏比例:工具栏图标与当前 RoboDK 工具栏图标大小的比例。

    命令:激活插件时将执行的 RoboDK API 命令。

为与 AppConfig.ini 文件位于同一文件夹中的每个 Python 脚本创建一个动作。如果脚本是辅助性质的,则可使用可见属性抑制该操作。

操作属性如下表所示:

    名称:菜单和工具栏中显示的操作名称。

    描述:当鼠标指针悬停在菜单项或工具栏按钮上时的工具提示文本。

    优先级:与本应用程序其他操作相比,该操作的显示顺序(低者优先)。

    快捷方式

    可见

    仅开发者模式只有当 RoboDK 切换到开发者模式(Ctrl+Alt+Shift+G)时,才会显示此操作。

    在菜单中显示

    在工具栏中显示

    可检查:创建一个可检查的操作,可检查操作也可按数字分组。

    上下文菜单筛选器:定义将此操作添加到上下文菜单的 RoboDK 树元素类型。

    双击过滤器:定义双击时将调用此操作的 RoboDK 树元素类型。

创建插件包

RoboDK 包构建为 RDKP 文件,即完成了插件的创建。这是创建插件的最后一步。

Add ins - 图片 20

在最后阶段,也就是创建软件包之前,可以使用以下选项:

    加密包:对文件进行加密,使其可以轻松通过电子邮件发送,绕过威胁检测系统(谷歌邮件服务直接禁止在附件中传输可执行文件和 Python 脚本)。

    构建后安装:让插件管理器安装新创建的软件包。

    打开包含的文件夹:打开创建软件包的文件夹。

提交您的插件

如果您希望其他RoboDK用户访问您的插件,您可以提交您的RoboDK插件,将其列入RoboDK市场。我们欢迎所有来自外部公司和开发者的提交。

您可以选择出售或免费提供您的插件。这两种方式都能让您的公司、产品和服务得到曝光。

通过电子邮件与我们联系,提交您的插件。有助于 RoboDK RoboDK 市场中正确列出您的插件的部分信息包括:

1.插件说明(自述文件)。

2.清单文件,其中包括其他信息,如开发商的网站和清单价格(如适用)。

3.作为 RoboDK 包的 RoboDK 附加组件(RDKP 文件,由附加组件创建器创建)。

4.至少一张显示插件功能的图片或屏幕录像。

您可以在 RoboDK 市场中RoboDK 查看 的开源插件,了解如何创建清单文件以及创建结果的示例。您可以使用插件管理器来创建和更新清单文件。

注意:共享 RDKP 文件的源代码并非必要条件。将 RDKP 与自述文件一起包含,并演示您的插件,就足以使您的插件被列入列表。