OpenIndustryProject

Free and Open-source warehouse/manufacturing development framework and simulator made with open62541, libplctag, and Godot.

The goal is to provide an open framework to create software and simulations using industrial equipment/devices and for people to be able to test their ideas or simply educate themselves while using standard industrial platforms.

Scroll down to the Getting Started section for information on how to work with this project.

Join our discord group: Open Industry Project

Supported Communication Protocols:

• OPC UA via open62541
• Ethernet/IP via libplctag
• Modbus TCP via libplctag

Demo

demo.mp4

Out of the Box Features

Customizable Equipment

2024-08-25.11-02-30.mp4

2024-08-25.11-05-58.mp4

Dynamic Devices

2024-03-24.08-41-58.mp4

Getting Started

It is recommended to download the latest package here: https://github.com/Open-Industry-Project/Open-Industry-Project/releases

It comes with a fork that contains functions and features that are not avaliable in regular Godot.

The contents of this repo are parts of a regular Godot project. You can open this project via the project manager, just like any other Godot project.

Use the Project Manager to create a new project.

All objects used in a simulation scene will be in the Parts tab.

A simulation can be created by adding a new scene, and selecting "New Simulation".

This creates a new scene with the top node labelled "Simulation":

Parts can be dragged into the viewport to instantiate it. Once they're in the scene they can be modified.

2024-04-06.11-00-38.mp4

Most parts have properties that can be setup to communicate to a PLC or OPC Server (see communications below). In this example Ignition was used as an OPC server to write to the conveyor tag.

2025-03-31.12-40-33.mp4

Communications

Configure the communication to PLCs or an OPC UA server via the "Comms" panel on the bottom of the editor:

The simulator will not communicate with any device until the "Enable Comms" checkbox is checked.

Tag Groups are a logical way to organize sets of tags. Each Tag Group is associated with one PLC or or one OPC UA client. When connecting to multiple PLCs or OPC UA endpoints, create a separate tag group for each one.

The "Polling Rate" indicates how often OIPComms will read all the tags which are a part of that tag group. The simulation does not read directly from the devices, it reads from a thread-safe data buffer that holds the value retained from the last poll. Writing values from the simualtion occurs as soon as possible, and is also thread-safe.

In the event that a write operation is queued by the simulation and a poll is half-way through completing (for example 100 out of 200 tags in the group have been read), the write operation will not complete until the poll completes.

The "Gateway" is the IP address of the target controller, and the path is the typically the rack/slot location of the PLC. The "CPU" dropdown contains the following options:

Selecting the Protocol dropdown provides three options:

• ab_eip - Ethernet/IP communication via the libplctag library
• modbus_tcp - Modbus TCP communication via the libplctag library
• opc_ua - OPC UA communication via the open62541 library

When changing the Protocol to opc_ua, the options change to reflect the connection parameters for an OPC UA endpoint:

The "Endpoint" is the OPC UA protocol address which includes the IP address and port of the server. The "Namespace" is typically 1 unless otherwise specified by the OPC UA server.

Devices typically have these settings: Enable Comms, Tag Group and Tag Name (Diffuse Sensor shown).

The communication API (OIPComms) is contained within a separate GDextension plugin. Instructions to build and update it are located in its own repository.

Importing Models

Although this project has a few models, you maybe interested in adding more.

This is a good resource for free industrial parts CAD models: 3dfindit

It is recommened to export the files in their native format (usually STEP), modify them if needed for usage in Godot in any CAD software and then export as FBX for additional work in Blender, or to be imported straight into Godot.

Alternatively most manufacturers provide the CAD files directly on their own website.

Help Wanted

• More equipment and devices
• Better exception handling
• Review code
• Documentation
• Training videos?