开源改变世界

请为 Arduino IDE 添加 library.properties / package_index.json #590

推推 grbl 3年前 (2023-01-22) 97次浏览

打开
Harvie 打开了这个问题 2019 年 1 月 10 日 · 8条评论
打开

请为 Arduino IDE 添加 library.properties / package_index.json#590

Harvie 打开了这个问题 2019 年 1 月 10 日 · 8条评论

注释

请为 Arduino IDE 添加 library.properties / package_index.json #590

你好,你能在 github 上的某个地方
发布文件吗,这样我就可以轻松地将 GRBL 添加到我的 Arduino IDE 并让它自动更新:package_index.json

例如:Adafruit 有这个 URL:

https://adafruit.github.io/arduino-board-index/package_adafruit_index.json

你添加它:

请为 Arduino IDE 添加 library.properties / package_index.json #590

然后您可以轻松地从他们的存储库下载并安装库和草图:

请为 Arduino IDE 添加 library.properties / package_index.json #590

我认为这是分发和更新 GRBL 的好方法,因为它已经可以通过 Arduino IDE 安装……但现在我们必须手动下载它。

请为 Arduino IDE 添加 library.properties / package_index.json #590

你混淆了两个不同的东西。

package_index.json用于允许通过 Boards Manager(工具 > Board > Boards Manager)安装硬件包。这是与File > Preferences > Additional Boards Manager URLs相关的功能。grbl 是一个库,而不是硬件包,所以这不相关。

为了方便安装和更新库,Arduino IDE 有一个有点类似的功能:库管理器(你的第二个屏幕截图)。库管理器的一个非常好的功能是它会在用户安装的任何库的新版本可用时通知用户。将库放入库管理器的过程与将 Boards Manager 安装支持添加到硬件包的过程不同,而且要容易得多。

以下是通过 Arduino IDE 的库管理器安装/更新grbl 需要做的事情:

  1. 将库移动到存储库的根目录。这也将允许通过 Arduino IDE 的Sketch > Include Library > Add .ZIP Library 轻松安装 GitHub .zip 文件…
  2. 添加符合规范的 library.properties 元数据文件。(为 Arduino IDE  #350添加 library.properties 文件
  3. 创建与versionlibrary.properties 中的值匹配的标签或版本。
  4. 在 arduino/Arduino 存储库中打开一个问题报告,请求添加到 Arduino 库管理器索引中。

将 grbl 存储库添加到 Library Manager 索引后,所有新标签将在一个小时内自动选取,因此此过程不需要进一步的工作。

如果管理员愿意接受,我很乐意提交 (1)、(2) 和 (4) 的拉取请求。由于没有这些特权,我无法执行 (3)。

参考:
https ://github.com/arduino/Arduino/wiki/Library-Manager-FAQ

请为 Arduino IDE 添加 library.properties / package_index.json #590
作者
哈维 评论了 2019 年 1 月 10 日  

你混淆了两个不同的东西。

我猜你是对的。但请注意,板管理器也可以安装库(因为您可以将它们捆绑到板定义中)并且即使没有被 arduino 人员确认也可以这样做,因为您可以将自己的包索引 url 添加到 IDE(与库管理器不同)。

但我想如果有可能被 arduino 确认,使用库管理器会更有意义。(即使 GRBL 不是真正的图书馆)。在这种情况下,将不需要添加新的索引 URL,因此它会更加用户友好。只需打开库存的 arduino,搜索 grbl 就可以了。

请为 Arduino IDE 添加 library.properties / package_index.json #590

但请注意,董事会经理也可以安装库(因为您可以将它们捆绑到董事会定义中)

的确,您可以将 grbl 变成一个硬件包,并将 grbl 作为一个捆绑库,但是与硬件包捆绑在一起的库只有在从“工具”>“板”中选择该包的板时才能访问,因此这会限制 grbl 可以使用的板数量仅用于在 grbl 包中有定义的那些。这将是一个非常棘手的解决方法,需要大量工作,使安装更加困难(由于添加 Boards Manager URL 的额外步骤),并且没有任何好处。

如果有可能被arduino确认

在提交请求包含在 Library Manager 索引中的问题后,Arduino 应该需要不到 10 天的时间来完成。我会亲自保证这一点。这是已经为近 2000 个图书馆完成的例行流程。

即使 GRBL 不是真正的图书馆

GRBL 采用 Arduino 库的形式。

在这种情况下,将不需要添加新的索引 URL,因此它会更加用户友好。只需打开库存的 arduino,搜索 grbl 就可以了。

我同意。

请为 Arduino IDE 添加 library.properties / package_index.json #590
作者

GRBL 采用 Arduino 库的形式。

我知道。它是图书馆的形式,但它不是图书馆。那么让我们看看他们将如何处理这种情况。我个人希望他们会接受它,因为 GRBL 被广泛使用。也许这甚至会让他们考虑将“固件/草图”类别添加到他们的库中。为了表明,它是现成的固件而不是用于构建自定义草图的库。

我可以想象他们可以在这个菜单中为像 grbl 这样的项目添加这样的选项:

请为 Arduino IDE 添加 library.properties / package_index.json #590

请为 Arduino IDE 添加 library.properties / package_index.json #590

那么让我们看看他们将如何处理这种情况。

他们会接受的。他们不判断提交的库的内容。他们只要求库的格式正确(在我上面列出的更改之后。

我可以想象他们可以在这个菜单中为像 grbl 这样的项目添加这样的选项:

它更有可能在“主题”菜单中。这由category库的 library.properties 文件的字段决定。

不管怎样,我坚持我的提议,尽可能多地做一些工作来实现这一目标。我只等待此回购协议的一位管理员的一些指示,如果我提交它们,他们将考虑合并我的 PR 以进行必要的更改。

请为 Arduino IDE 添加 library.properties / package_index.json #590
作者
哈维 评论了 2019 年 1 月 11 日  

version – 库的版本。版本应符合 semver。1.2.0 是正确的;1.2 被接受;r5、003、1.1c 无效

这对于当前的 grbl 版本控制方案(例如 1.1f)来说不是很好,但是根据https://semver.org/应该可以在 arduino 中使用以下版本格式:

1.1-f、1.1-g 等……甚至 1.1+f、1.1+g……都有一些注意事项。

请为 Arduino IDE 添加 library.properties / package_index.json #590
作者

这个有消息吗?这应该很容易实现……

请为 Arduino IDE 添加 library.properties / package_index.json #590 哈维 改了标题 请为 Arduino IDE 添加 package_index.json 请为 Arduino IDE 添加 library.properties / package_index.json 2019 年 6 月 30 日
请为 Arduino IDE 添加 library.properties / package_index.json #590
作者

我可以提出拉取请求吗?它将需要以下重命名:

grbl/示例 –> 示例
grbl –> src

喜欢 (0)