Skip to content

GepElectric/wincc-unified-module-template

Repository files navigation

WinCC Unified Module Template

Repo Release

This repository is a clean starting template for a new WinCC Unified Companion module.

It is structured so the same module can run:

  • standalone
  • as a hosted Companion module
  • as a packaged .exe module for the host modules/ folder

Repository Contents

  • main.py: hosted and standalone entrypoint
  • hosted_runtime.py: minimal Companion runtime helper
  • example_module/app.py: starter UI and business logic
  • module.json: module manifest used by the host
  • build_module_exe.bat: PyInstaller build script and package output flow
  • MODULE_TEMPLATE_MEMORY.md: extra implementation notes

Getting Started

  1. Copy this folder to a new location for your module.
  2. Rename the following placeholders:
    • example_module
    • ExampleModule
    • example_module inside module.json
  3. Implement your UI and logic in example_module/app.py.
  4. Run locally:
python main.py
  1. Build the packaged module:
.\build_module_exe.bat
  1. Install the result in the host:
modules/<your_module_id>/

Or use the packaged ZIP from dist/ with the host Install Module flow.

Notes

  • this repository is meant to stay clean and reusable as a base template
  • build output folders are ignored by git
  • line endings and editor behavior are already standardized for Windows-based development

About

Clean WinCC Unified Companion module template for standalone, hosted, and packaged module development.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors