First release

.clang-format

@@ -0,0 +1,8 @@
+BasedOnStyle: LLVM
+IndentWidth: 4
+UseTab: Never
+ColumnLimit: 100
+BreakBeforeBraces: Allman   # (ou Attach, Linux, etc.)
+AllowShortFunctionsOnASingleLine: Empty
+SpaceBeforeParens: ControlStatements
+AlignConsecutiveAssignments: true

.github/workflows/docker.yml

@@ -0,0 +1,42 @@
+name: Build and Publish Multi-Arch Docker Image
+
+on:
+  push:
+    branches: [ main, development ]
+  pull_request:
+    branches: [ main, development ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ secrets.GHCR_USERNAME }}
+          password: ${{ secrets.GHCR_TOKEN }}
+
+      - name: Build and Push Multi-Arch Image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          tags: |
+            ghcr.io/autonomy-logic/openplc-runtime:latest
+            ghcr.io/autonomy-logic/openplc-runtime:${{ github.sha }}

.gitignore

@@ -0,0 +1,26 @@
+# Ignore all files in the build output directory
+/build*/
+/core/generated/
+/memory-bank
+
+.vscode/
+#.*/
+/venvs/
+.venv/
+__pycache__/
+.clinerules
+
+# Temporary files
+*.txt
+*.log
+*.env
+*.pem
+*.db
+*.socket
+*.installed
+*.egg-info
+*.pytest_cache/
+
+# Ignore all object files and shared libraries
+*.o
+*.so

.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+repos:
+  - repo: https://github.com/pycqa/pylint
+    rev: v3.3.8
+    hooks:
+      - id: pylint
+        # args: [--fail-on=F,E]
+        args: [
+            "--disable=C0114,C0411,C0115,C0116,C0412,E0401,W0718,R1702,R0911,R0912,R0915,R1705,W0404,W0603,W0613,W0511",
+          ] # example: disable missing-docstring
+        additional_dependencies:
+          [flask, flask-sqlalchemy, flask_jwt_extended, werkzeug]
+        entry: pylint
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 6.0.1
+    hooks:
+      - id: isort
+        args: ["--profile=black", "--filter-files"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.11
+    hooks:
+      - id: ruff
+        args: ["--fix"]
+      - id: ruff-format
+        args: []
+  # - repo: https://github.com/pre-commit/mirrors-mypy
+  #   rev: v1.17.1
+  #   hooks:
+  #     - id: mypy
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v21.1.0 # Let autoupdate find the latest
+    hooks:
+      - id: clang-format
+        files: \.(c|h)$
+        args: [--style=file] # Assumes a .clang-format file is present
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0 # Use this specific modern version
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+        args: ["--maxkb=500"]
+      # The following hooks are very stable and widely available
+      - id: check-ast # Check that files contain valid syntax (for any language)
+      - id: check-case-conflict # Check for files that would conflict in case-insensitive filesystems
+      - id: check-json # Check JSON files for validity
+      - id: check-yaml # Check YAML files for validity
+      - id: destroyed-symlinks # Check for destroyed symlinks
+      - id: detect-private-key # Detect the presence of private keys

.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+    "files.associations": {
+        "sched.h": "c",
+        "scan_cycle_manager.h": "c",
+        "dlfcn.h": "c",
+        "utils.h": "c",
+        "plc_state_manager.h": "c",
+        "unix_socket.h": "c",
+        "plugin_driver.h": "c"
+    },
+    "editor.rulers": [
+        80
+    ],
+    "[c]": {
+        "editor.defaultFormatter": "xaver.clang-format"
+    },
+    "editor.formatOnSave": true
+}

CMakeLists.txt

@@ -0,0 +1,5 @@
+cmake_minimum_required(VERSION 3.10)
+project(plc_project C)
+
+# add_subdirectory(./core/generated)
+add_subdirectory(./core/src)

Dockerfile

@@ -0,0 +1,24 @@
+# syntax=docker/dockerfile:1
+
+FROM debian:bookworm-slim
+
+WORKDIR /workdir
+
+# Copy source code
+COPY . .
+
+# Setup runtime directory and permissions
+RUN mkdir -p /var/run/runtime && \
+    chmod +x install.sh scripts/* start_openplc.sh
+
+# Clean any existing build artifacts to ensure clean Docker build
+RUN rm -rf build/ venvs/ .venv/ 2>/dev/null || true
+
+# Run installation script
+RUN ./install.sh
+
+# Expose webserver port
+EXPOSE 8443
+
+# Default execution - Start OpenPLC Runtime
+CMD ["bash", "./start_openplc.sh"]

Dockerfile.dev

@@ -0,0 +1,19 @@
+# Dockerfile
+FROM debian:bookworm-slim
+
+RUN apt-get update && apt-get install -y \
+    python3 python3-venv python3-pip bash \
+    pkg-config \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /workdir
+COPY . .
+RUN mkdir -p /var/run/runtime
+# Clean any existing build artifacts to ensure clean Docker build
+RUN rm -rf build/ venvs/ 2>/dev/null || true
+RUN chmod +x install.sh scripts/* start_openplc.sh
+RUN ./install.sh
+
+EXPOSE 8443
+
+CMD ["bash", "./scripts/setup-tests-env.sh"]

README.md

@@ -1,2 +1,192 @@
-# openplc-runtime
+# OpenPLC Runtime v4
+
 OpenPLC Runtime v4 designed to run programs built on OpenPLC Editor v4
+
+## Prerequisites
+
+### Linux
+
+- GCC compiler
+- Make
+- CMake
+- Python (for xml2st tool)
+
+### Windows
+
+- Python (required to run xml2st)
+- Docker Desktop (contains GCC and Make internally)
+
+## Run project
+
+### Docker
+
+1. Build image
+
+```
+   sudo bash ./scripts/build-docker-image.sh
+```
+
+2. Run image
+
+```
+   sudo bash ./scripts/run-image.sh
+```
+
+### Linux
+
+1. Installation
+
+```
+   sudo bash ./install.sh
+```
+
+2. Start
+
+```
+   sudo bash ./start_openplc.sh
+```
+
+## Unit Tests
+
+1. Run locally
+
+```
+   sudo bash ./scripts/setup-tests-env.sh
+```
+
+ or
+
+2. Build development docker image
+
+```
+   sudo bash ./scripts/build-docker-image-dev.sh
+```
+
+3. Run development docker image
+
+```
+   sudo bash ./scripts/run-image-dev.sh
+```
+
+## Pre-commit setup
+
+1. Install
+
+```
+   pip install pre-commit
+   pre-commit install
+```
+
+2. Normal commit
+
+   ```
+   git add .
+   git commit -m "Your commit message"  # Pre-commit checks run automatically
+
+   ```
+
+3. Skip pre-commit checks
+
+   ```
+   git commit --no-verify -m "Your commit message"
+   ```
+
+Use the --no-verify flag for quick fixes or when pre-commit checks aren't necessary. This bypasses all pre-commit validation for that specific commit.
+
+## 🛠️ Build Instructions
+
+### Step 1: Build Application in OpenPLC IDE
+
+1. Create your PLC program in the **OpenPLC IDE**
+2. **Important**: Your project must include **Location Variables (IEC 61131-3)** to compile successfully
+3. Click **Compile** in the IDE
+4. This will generate a `LOCATED_VARIABLES.h` file in `{projectfolder}/build/OpenPLC Runtime/src/`
+
+### Step 2: Generate glueVars.c with XML2ST
+
+1. Clone and setup xml2st:
+
+   ```bash
+   git clone https://github.com/Autonomy-Logic/xml2st.git
+   cd xml2st
+   git switch development
+   ```
+
+2. Run xml2st with the path to your LOCATED_VARIABLES.h:
+
+   ```bash
+   xml2st --generate-gluevars /path/to/LOCATED_VARIABLES.h
+   ```
+
+3. Copy **all generated files** from `{projectfolder}/build/OpenPLC Runtime/src/` to `core/generated/` directory in this project
+
+### Step 3: Build Runtime
+
+#### 🐧 Linux Build
+
+```bash
+# Build the runtime core
+mkdir build
+cd build
+cmake ..
+make
+```
+
+#### 🪟 Windows Build (Docker)
+
+1. **Build Docker image** (run from project root):
+
+   ```bash
+   docker build -t openplc-runtime .
+   ```
+
+2. **Run Docker container** in interactive mode:
+
+   ```bash
+   docker run -it --rm -v ${PWD}:/workspace openplc-runtime bash
+   ```
+
+3. **Inside the Docker container**, build the project:
+
+   ```bash
+   mkdir build
+   cd build
+   cmake ..
+   make
+   ```
+
+## 🚀 Running the Application
+
+After successful compilation, you can run the OpenPLC Runtime:
+
+```bash
+./plc_main
+```
+
+## 📁 Project Structure
+
+```
+openplc-runtime/
+├── core/
+│   ├── src/              # Core runtime source files
+│   └── generated/        # Generated files from OpenPLC IDE (copy here)
+├── scripts/              # Build scripts
+├── Dockerfile            # Docker configuration for Windows builds
+└── CMakeLists.txt        # CMake build configuration
+```
+
+## 🔧 Troubleshooting
+
+### Common Issues
+
+- **Missing Location Variables**: Ensure your OpenPLC IDE project includes IEC 61131-3 location variables
+- **Docker not found**: Install Docker Desktop on Windows
+- **Build failures**: Verify all generated files are copied to `core/generated/`
+
+### File Requirements
+
+The `core/generated/` directory should contain:
+
+- `glueVars.c` (generated by xml2st)
+- `LOCATED_VARIABLES.h` (from OpenPLC IDE compilation)
+- Other generated files from OpenPLC IDE build process