protocol, Firmata协议的文档

分享于 

6分钟阅读

GitHub

  繁體 雙語
Documentation of the Firmata protocol.
  • 源代码名称:protocol
  • 源代码网址:http://www.github.com/firmata/protocol
  • protocol源代码文档
  • protocol源代码下载
  • Git URL:
    git://www.github.com/firmata/protocol.git
    Git Clone代码到本地:
    git clone http://www.github.com/firmata/protocol
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/firmata/protocol
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    Firmata协议文档

    Join the chat at https://gitter.im/firmata/protocol

    Firmata是一种协议,用于与计算机( 或者智能手机/平板电脑等) 上的软件通信。 协议可以在任何微控制器架构的固件中实现,也可以在任何计算机软件包( 请参阅下面的客户端库列表) 上的软件上实现。

    Firmata基于 midi消息格式 commands commands字节为 8字节,数据字节为 7位。 例如midi通道压力( 命令: 0 xD0 ) 消息为 2字节,在Firmata中,命令 0 xD0用于启用数字端口( 8引脚集合)的报告。 midi和Firmata版本长 2字节,但意义明显不同。 在Firmata中,消息中的字节数必须与相应的midi消息一致。 但是,在整个Firmata协议中,可以使用任何长度,因此使用最多的是 Midi 系统 Exclusive。

    这里存储库包含Firmata协议的文档。 协议的核心在 protocol.md 文件文件中描述。 功能特定的文档在单个 Markdown 文件( ,等) 中。 添加到提案目录的文件是还没有完成的新功能的建议。 查看 firmata-registry.md 以获得已经记录的firmata功能的完整列表。

    在理论上,Firmata协议可以在任何微控制器平台上实现。 然而,目前最完整的实现是 Arduino ( 包括Arduino兼容微控制器)。 以下是已知的Firmata微控制器平台实现:

    请注意:我相信还有其他的实现。 如果你知道它的他人,请提交请求请求更新这里自述文件,或者打开提供这里文档链接的问题。

    Firmata客户端库

    有几个客户端库。 这些是实现Firmata协议以便与在微控制器平台上运行Firmata固件的( 从电脑。智能手机或者平板电脑等) 通信的库。 以下是Firmata客户端库实现的列表:

    因此,每个客户端库可能不支持最新版本的协议,以及这里reposity中描述的所有特性。

    要提交新特性的建议,为你的建议创建一个 Markdown 插件文件,并将追加到文件名。 提交拉请求以添加建议。

    要更改现有协议,请提交请求请求,并提交所建议的更改。 请确保在请求请求描述中提供了任何理由。

    有关草拟新建议的一些提示:

    • 有关建议提供新功能和请求功能ID的信息,请参阅 feature-registry.md
    • 如果有多个消息,则根据需要使用子命令( 3rd 字节)。 有关示例,请参见 accelStepperFirmata.md 文件。 注意对要素of使用 0x62 以及每个节如何有一个枚举子命令( 0 x00 = 配置,0 x01 = 零,02 = 步骤,等等)的集合。
    • 只要sysex消息中的值都位于消息的末尾,就可以在消息中具有可选值。 请参见 serial-1.0.mdSERIAL_CONFIG 消息的6 & 7.
    • 尽量保持你的sysex消息尽可能短。
    • 如有必要,打包位。请参见响应消息,以获取在 encoder.md 中编码器的报告位置( 也请注意在响应消息之后如何记录这里文档。 如果你在建议中使用位包装,请包含类似的文档。
    • 如果建议使用任何可用非sysex消息,则消息中的字节数必须与midi消息中的字节数相对应。 然而,意义不需要是相同的。 但是,如果midi消息使用通道( 例如关闭( 0 x80 ) ) ),那么Firmata消息也必须使用通道,因为midi解析器可能希望这样做。

    DOC  proto  protocol  protoc  firmata  
    相关文章