plc4x

工業物聯網適配器

PLC4X的最終目標是建立一組庫，允許統一存取任何類型的PLC

---

目錄

• 關於PLC4X
• 入門
• 開發商
• 社群
• 貢獻
• 授權

---

關於阿帕契 PLC4X

Apache PLC4X 致力於建立一組函式庫，以統一的方式與工業級可程式邏輯控制器 (PLC) 進行通訊。我們計劃將庫用於：

1. 爪哇
2. 去
3. C（未準備好使用）
4. Python（尚未準備好使用）
5. C# (.Net)（尚未準備好使用 - 已放棄）

PLC4X 也與其他 Apache 專案集成，例如：

• 阿帕契方解石
• 阿帕契駱駝
• Apache Kafka 連接
• 阿帕契·卡拉夫
• 阿帕契NiFi

並帶來獨立（Java）實用程序，例如：

• OPC-UA 伺服器：使您能夠使用帶有 OPC-UA 的 PLC4X 與傳統設備進行通訊。
• PLC4X 伺服器：使您能夠與中央 PLC4X 伺服器通信，然後中央 PLC4X 伺服器透過 PLC4X 與裝置通訊。

它還提供了在應用程式內部使用的 (Java) 工具：

• 連接快取：用於重複使用和共享 PLC 連接的框架的新實現
• 連接池：我們框架的舊實現，用於重複使用和共享 PLC 連接
• OPM：Object-Plc-Mapping：允許將 PLC 欄位綁定到類似 JPA 的 java POJO 中的屬性
• Scraper：用於進行規劃和重複資料收集的實用程式。

入門

根據程式語言的不同，用法也會有所不同，因此請造訪 PLC4X 網站上的入門指南以尋找所選語言。

爪哇

注意：目前支援建置 Apache PLC4X 所有部分的 Java 版本至少是 Java 19（我們已經測試了 Java 21 之前的所有版本），但現在只有 Java 工具 UI 需要此功能。所有其他模組至少需要 Java 11。

請參閱網站上的 PLC4J 使用者指南，開始在 Java 應用程式中使用 PLC4X：https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4j.html

開發商

環境

目前，該專案配置為需要以下軟體：

1. Java 11 JDK：用於一般運行 Maven 以及編譯配置為指向該JAVA_HOME Java 和 Scala 模組。
2. Git（即使在原始碼發行版上工作時）
3. （可選，用於運行所有測試）libpcap/Npcap 用於 Java 中的原始套接字測試或使用passive-mode驅動程式
4. （可選，用於建立網站） Graphviz ：用於產生文件中的圖表

警告：程式碼產生使用的實用程式需要一些額外的 VM 設定。從根目錄執行建置時，會自動套用.mvn/jvm.config中的設定。僅建構子模組時，設定 vm 參數非常重要： --add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED 。例如，在 Intellij 中，在 IDE 設定中設定這些設定：Preferences |建置、執行、部署 |建構工具| Maven |運行器：JVM 選項。

更詳細的描述可以在我們的網站上找到：

https://plc4x.apache.org/plc4x/latest/developers/preparing/index.html

為了建構PLC4C我們還需要：

所有需求均由建置本身檢索

為了建構PLC4Go我們還需要：

所有需求均由建置本身檢索

為了建構PLC4Py我們還需要：

1. Python 3.7 或更高版本
2. Python pyenv

為了建構PLC4Net我們還需要：

1. 點網 SDK 6.0

透過此設置，您將能夠建立 PLC4X 的 Java 部分。

在進行完整建置時，我們會自動執行先決條件檢查，如果未滿足所有要求，則建置失敗並給予解釋。

使用 Docker 建置

如果你不想在普通系統上設定環境，並且已經安裝了 Docker，那麼你也可以在 Docker 容器中建置所有內容：

   docker compose up

這將建置一個本機 Docker 容器，能夠建置 PLC4X 的所有部分，並將運行該容器內本機目錄的 Maven 建置。

預設構建將運行本地發布構建，因此它也可用於確保發佈時構建的可重現構建。

預設情況下它將在本地存儲文件：

• 下載的 Maven 工件將轉到out/.repository
• 部署的工件將轉到out/.local-snapshots-dir

這樣做的原因是，否則這些工件將與來源發布工件一起打包，從而產生 12GB 或更多的 zip 檔案。但是，將其保存在主target目錄中將使建置在每次執行mvn clean時刪除本機儲存庫。然而， out目錄預設從組件描述符中排除，因此它不包含在來源 zim 中。

入門

您的系統上必須至少安裝 Java 11 並連線至 Maven Central（用於下載外部第三方相依性）。建置需要 Maven 3.6，因此請確保它已安裝並在您的系統上可用。

注意：目前使用 Java 21 時，Apache Kafka 整合模組被排除在建置之外，因為它所需的外掛程式之一已被證明與此版本不相容。

注意：在儲存庫中安裝了一個方便的 Maven-Wrapper，使用時，它會自動下載並安裝 Maven。如果您想使用它，請使用./mvnw或mvnw而不是普通的mvn命令。

注意：從sources-zip執行時， mvnw可能無法在Mac或Linux上執行。透過在目錄中執行以下命令可以輕鬆修復此問題。

 $ chmod +x mvnw

注意：如果您使用的是Windows系統，請在以下建置命令中使用mvnw.cmd而不是./mvnw 。

建置 PLC4X Java jar 並將其安裝在本機 Maven 儲存庫中

 ./mvnw install

現在您可以建立使用 PLC4X 的 Java 應用程式。 PLC4X 範例是一個很好的起點，可以在plc4j/examples目錄中找到。

可以透過啟用with-go設定檔來建立Go驅動程式：

 ./mvnw -P with-go install 

可以透過啟用with-java設定檔來建立Java驅動程式：

 ./mvnw -P with-java install 

C# / .Net實作目前處於work in progress狀態。為了能夠建立C# / .Net模組，您目前需要啟動： with-dotnet設定檔。

 ./mvnw -P with-dotnet install

Python 實作目前處於某種不乾淨的狀態，仍然需要重構。為了能夠建立 Python 模組，您目前需要啟動： with-python設定檔。

 ./mvnw -P with-python install

為了建構所有內容，以下命令應該會起作用：

 ./mvnw -P with-c,with-dotnet,with-go,with-java,with-python,enable-all-checks,update-generated-code install

社群

使用以下管道之一加入 PLC4X 社群。我們很樂意提供協助！

郵件清單

訂閱以下郵件清單：

• Apache PLC4X 開發人員清單：[email protected]
• Apache PLC4X 提交清單：[email protected]
• Apache PLC4X 問題通知清單：[email protected]

嘰嘰喳喳

在 Twitter 上獲取最新的 PLC4X 新聞：https://twitter.com/ApachePlc4x

貢獻

您可以透過多種形式參與 PLC4X 專案。

這些是但不限於：

• 提供資訊和見解
• 測試 PLC4X 並提供回饋
• 提交拉取請求
• 提交錯誤報告
• 我們的郵件清單上的積極溝通
• 推廣專案（文章、部落格文章、會議演講）
• 文件

我們是一群非常友好的人，所以不要害怕向前邁出一步。如果您想為 PLC4X 做出貢獻，請查看我們的貢獻指南！

授權

Apache PLC4X 根據 Apache 授權版本 2.0 發布。