pioreactor-custom-dosing-automation 0.0.1

如何包含自定义剂量/LED/温度自动化的示例

这是一个为Pioreactor创建自定义自动化的示例存储库。通过将您的自动化转换为存储库，它可以更容易地安装到您的Pioreactor集群中，并且可以与他人共享

如果可在PyPI上找到

pio install-plugin <plugin-name>

（以及pios，可以在整个集群中安装。）

如果可在GitHub上找到

pio install-plugin <plugin-name> --url <git+ url>

制作自己的自动化插件所需的组件

Python逻辑

这是与pioreactor软件交互的核心逻辑。有关详细信息，请参阅类MyCustomDosingAutomation。请注意以下内容

• 从DosingAutomationContrib，LEDAutomationContrib或TemperatureAutomationContrib派生
• 需要key
• 需要execute

在我们的核心存储库中还有许多其他自动化示例

类必须放在此主__init__.py中，因为这是DosingController发现它的方式。

setup.py

可以将此内容复制到您的项目中，并更新字段。最重要的字段是

  entry_points={'pioreactor.plugins': 'pioreactor_custom_dosing_automation = pioreactor_custom_dosing_automation'},

这是必需的，并且您的代码应更新为您的插件的正确名称。

在config.ini中添加特定设置

使用文件additional_config.ini（必须位于源代码文件夹中），您可以添加用户可编辑的设置以供您的自动化使用。这将合并到config.ini中。

将您的自动化添加到UI中

您可以在UI中的自动化下拉菜单中指定自动化，并指定要显示给用户的字段和默认值。

在源代码文件夹中创建一个名为 ui 的文件夹。在其内部，创建一个名为 contrib 的文件夹。然后，根据您的自动化类型创建一个相应的文件夹：dosing、led 或 temperature。下面是示例目录结构。

MANIFEST.in

为了让 Python 包含 ui 和/或 additional_config.ini，我们需要在 MANIFEST.in 文件中指定它们。复制并粘贴此项目的 MANIFEST.in，并根据内容进行适当的替换。

您的插件示例目录结构

 plugin_name/
    __init__.py
    other_python_files.py
    additional_config.ini
    ui/
      contrib/
        automations/
          dosing/
            plugin_name.yaml        OR
          led/
            plugin_name.yaml        OR
          temperature/
            plugin_name.yaml
setup.py
MANIFEST.in