Jump to main content
WinCC OA Documentation
WinCC OA Documentation
LANG
  • Versionsinformationen
  • Konzepte
  • Deployment
  • Sicherheit
  • Engineering
  • Datenmanagement
  • Business Logic / Control
  • Datenvisualisierung
  • Southbound Interfaces
  • Northbound Interfaces
  • Konnektivität / Netzwerk Schnittstellen
  • Benutzerverwaltung
  • Verfügbarkeit
  • Reporting
  • Erweiterungen
  • Referenztabellen
  • Videos & Tutorials
  • eLearning
  • Dokumentation
  • Support & Services
  • Disclaimer
  • SIMATIC WinCC OA World
  1. Home
  2. Konnektivität / Netzwerk Schnittstellen

    Datenaustausch, APIs und moderne (Web) Technologien.

  3. Python Manager

    The Python Manager enables you to write WinCC OA managers in Python.

  4. WinCC OA Python API

    The Python API for WinCC OA provides access to the WinCC OA runtime system from Python scripts. It enables reading and writing datapoints, subscribing to value changes, executing queries, and integrating with the WinCC OA logging system.

  5. Guide

    In-depth explanations of the Python API’s core concepts.

  • Versionsinformationen

    Release Notes, Update-Informationen, Zertifizierungen and häufig gestellte Fragen.

  • Konzepte

    Ihr erster Schritt in die moderne und leistungsstarke Prozessvisualisierung.

  • Deployment

    Themen, die Sie vor der Nutzung von WinCC OA wissen sollten.

  • Sicherheit

    Wachsen sie in Bezug auf Cybersecurity über die Norm hinaus.

  • Engineering

    Leistungsstarke Tools für einfache sowie komplexe Engineering-Aufgaben.

  • Datenmanagement

    Klassifizieren, strukturieren und archivieren sie Ihre Daten.

  • Business Logic / Control

    Endlose Möglichkeiten in der Datenverarbeitung für Ihre Projekte.

  • Datenvisualisierung

    User Interfaces, Trends und Reports für jeden Zweck und jedes Gerät.

  • Southbound Interfaces

    Der Prozessanschluss zu den echten Maschinen/Sensoren.

  • Northbound Interfaces

    Ihr Portal zur Cloud oder übergeordneten Systemen.

  • Konnektivität / Netzwerk Schnittstellen

    Datenaustausch, APIs und moderne (Web) Technologien.

    • APIs

      Eine Übersicht der in WinCC OA verfügbaren APIs (Application Programming Interface).

    • Manager Service API (MSA) – Überblick

      Die Manager Service API (MSA) ist das Rückgrat für nahtlose, protokollunabhängige Kommunikation und Wiederverwendung von Logik zwischen WinCC OA Managern und unterstützt moderne, verteilte und webintegrierte SCADA-Architekturen.

    • COM

      COM - Microsoft Interface steht für Component Object Model, eine Spezifikation für die Entwicklung modularer Softwarekomponenten, die von jeder COM-kompatiblen Anwendung verwendet werden können. COM-Komponenten lassen sich leicht in solche Anwendungen integrieren und können sogar während der Laufzeit aus einer Anwendung entfernt werden. COM-Komponenten können in verschiedenen Programmiersprachen programmiert werden, wobei C++ am häufigsten verwendet wird. Die Spezifikationen OLE, ActiveX und DirectX basieren auf der COM-Technologie

    • Prometheus Interface

      Die Prometheus-Schnittstelle (auch als Prometheus-Client bezeichnet) dient als Brücke zwischen WinCC OA und Prometheus. Er erleichtert das Abrufen, Verarbeiten und Freigeben von Daten aus dem System in ein Prometheus-kompatibles Format. Dies ermöglicht Prometheus die Überwachung und Alarmierung auf der Grundlage vom WinCC OA-System.

    • SIMATIC PLC Discovery

      In immer dynamischeren Automatisierungsumgebungen und der Verschmelzung von IT mit OT kann SIMATIC PLC Discovery bei der Anbindung von neu hinzugekommenen S7/S7+ Geräten helfen, indem es Ihnen alle im Netzwerk befindlichen Geräte anzeigt.

    • WinCC OA JavaScript Manager für Node.js

      Der WinCC OA JavaScript Manager für Node.js ist ein Manager, welcher die Einbindung der TypeScript/JavaScript Runtime-Umgebung in WinCC OA erlaubt.

    • Python Manager

      The Python Manager enables you to write WinCC OA managers in Python.

      • WinCC OA Python API

        The Python API for WinCC OA provides access to the WinCC OA runtime system from Python scripts. It enables reading and writing datapoints, subscribing to value changes, executing queries, and integrating with the WinCC OA logging system.

        • Getting Started

          This guide walks you through running your first Python script inside a WinCC OA project. The script is registered as a WinCC OA manager and is started, stopped and monitored by the process monitor (PMON) — just like a CTRL or ECMAScript manager.

        • Installation

          Detailed installation instructions for the WinCC OA Python API. For a quick start, see Getting Started.

        • Development Environment

          This page describes how to develop a Python application for WinCC OA on a workstation, keep it under source control, and verify it on a build node that has no WinCC OA installation. For running a finished script inside a project, see Getting Started.

        • Troubleshooting

          Common problems when running a Python manager, and how to resolve them.

        • Guide

          In-depth explanations of the Python API’s core concepts.

          • Data Access Patterns

            Reading, writing and observing datapoint values follows four patterns. Which one to use is a decision about confirmation and timing, not about the value itself. Historical values are a topic of their own and are covered at the end of the page.

          • Data Types

            WinCC OA has its own type system. The Python API maps between Python native types and WinCC OA types automatically where possible.

          • Error Handling

            Errors are reported as exceptions. A call that returns has succeeded, a call that fails raises. There is no return code to inspect and no equivalent of the CTRL function getLastError() that has to be queried after every statement.

          • Logging

            The Python API does not define a log API of its own. Messages are written with the standard logging module of Python, and the manager forwards them to the WinCC OA log system.

          • Manager Lifecycle

            The Manager class is the entry point for all interactions with WinCC OA. It manages the connection to the runtime system, the event loop, and graceful shutdown.

          • CTRL Interoperation

            A Python manager can run CTRL code. This gives access to the CTRL function set and to the script libraries that already exist in a project, without having to port them.

          • Manager Service API (MSA)

            The Manager Service API (MSA) lets managers call each other. One manager offers a service, another manager calls its methods through a stub. MSA works across all manager programming languages, so a Python manager can call a service written in CTRL, C++, C# or TypeScript, and vice versa.

          • Security

            This page collects the security topics that are specific to writing and running Python code in WinCC OA. It is an orientation, not a complete treatment. The WinCC OA Security Guideline is the authoritative document for securing a project. Most of the mechanisms described here belong to the project configuration rather than to the Python code.

        • API Reference

          This page contains auto-generated API reference documentation 1.

    • SIMATIC Unified AR (Augmented Reality)

      SIMATIC Unified AR ist eine industrielle Augmented Reality-App, die es ermöglicht, HMI-Screens (WinCC Unified / WinCC V8) und Webanwendungen (WinCC OA Dashboard) in realen Produktionsumgebungen anzuzeigen.

    • webserver.js

      ist ein Node.js-basierter Webserver, der ein modernes, erweiterbares Backend für Full-Stack-Webanwendungen in WinCC OA bereitstellt.

    • HTTP-Server

      Der HTTP-Server stellt eine direkte Integration von Internettechnologien in WinCC OA dar. Implementiert als Erweiterung für Control-Manager bieten sich vielfältige Anwendungsmöglichkeiten an. Zum einen kann der HTTP-Server als Webserver für statische HTML-Seiten inklusive Downloadmöglichkeit dienen, zum anderen können dynamisch HTML-Seiten generiert werden.

    • XML-RPC

      Über XML-RPC (Extensible Markup Language Remote Procedure Call) kann Software auf verschiedenen Betriebssystemen Prozeduraufrufe über das Internet machen. XML-RPC verwendet HTTP für Transport und XML für die Verschlüsselung. Es sendet ein Prozeduraufruf an einen abgesetzten Server über HTTP. Der Aufruf ist ein XML-Dokument und es erhält die Antwort als XML.

    • REST Reporting API

      Die REST Reporting API ist in den Standard-Webserver integriert und kann über den Config-Eintrag [restReporting] enabled aktiviert werden.

    • Verteilte Systeme

      Verteilte Systeme in WinCC OA ermöglichen die Kopplung von zwei oder mehreren autonomen WinCC OA-Systemen über ein Netzwerk.

    • Dist-Verwaltung

      Ein verteiltes System stellt in WinCC OA immer einen erhöhten Engineering Aufwand dar, da viele Einstellungen und Konfigurationsschritte auf mehreren Systemen ausgeführt werden müssen.

    • XMPP

      XMPP (früher Jabber) wird meistens in Chats (Instant messaging)-Applikationen verwendet und ermöglicht nahezu Echtzeit-Kommunikation zwischen einem oder mehreren Teilnehmern. Es kann verwendet werden, um von einem WinCC OA-Server Informationen an einer oder an mehreren Personen zu senden und eine Bestätigung beim Erhalt der Nachricht zurückzusenden.

  • Benutzerverwaltung

    Alles über Autorisierung, Authentifizierung und Login-Anpassung.

  • Verfügbarkeit

    Wie sie maximale Systemverfügbarkeit erreichen können.

  • Reporting

    Erstellen sie "State of the art"-Reports ohne Limits.

  • Erweiterungen

    Nützliche Werkzeuge und Erweiterungen für spezielle Anforderungen.

  • Referenztabellen

    Detaillierte und umfangreiche Inhalte für spezielle Projektanpassungen.

  • Videos & Tutorials

    Erkunden Sie die Möglichkeiten von WinCC OA mit unserer sorgfältig ausgewählten Sammlung von Video-Tutorials und Anleitungen.

  • eLearning

    Bauen Sie Ihre Expertise Schritt für Schritt auf

  • Dokumentation

    Grundlegende Informationen über Bezeichnungen und Funktionsweisen innerhalb der Dokumentation.

  • Support & Services

    Ein erfahrenes Team von Support-Mitarbeitern, Beratern und Trainern steht bereit, aktive Partnerschaften mit Kunden zu fördern, die von unserem umfassenden Service profitieren.

  • Disclaimer

    Erläuterungen zu Haftungsausschlüssen oder rechtlichen Hinweisen.

  • SIMATIC WinCC OA World

    Entdecken Sie die Welt von WinCC OA und bleiben Sie über die neuesten Produktneuigkeiten informiert.

Guide

In-depth explanations of the Python API’s core concepts.

  • Manager Lifecycle
  • Data Access Patterns
  • Data Types
  • Logging
  • Error Handling
  • CTRL Interoperation
  • Manager Service API (MSA)
  • Security
  • Data Access Patterns
    Reading, writing and observing datapoint values follows four patterns. Which one to use is a decision about confirmation and timing, not about the value itself. Historical values are a topic of their own and are covered at the end of the page.
  • Data Types
    WinCC OA has its own type system. The Python API maps between Python native types and WinCC OA types automatically where possible.
  • Error Handling
    Errors are reported as exceptions. A call that returns has succeeded, a call that fails raises. There is no return code to inspect and no equivalent of the CTRL function getLastError() that has to be queried after every statement.
  • Logging
    The Python API does not define a log API of its own. Messages are written with the standard logging module of Python, and the manager forwards them to the WinCC OA log system.
  • Manager Lifecycle
    The Manager class is the entry point for all interactions with WinCC OA. It manages the connection to the runtime system, the event loop, and graceful shutdown.
  • CTRL Interoperation
    A Python manager can run CTRL code. This gives access to the CTRL function set and to the script libraries that already exist in a project, without having to port them.
  • Manager Service API (MSA)
    The Manager Service API (MSA) lets managers call each other. One manager offers a service, another manager calls its methods through a stub. MSA works across all manager programming languages, so a Python manager can call a service written in CTRL, C++, C# or TypeScript, and vice versa.
  • Security
    This page collects the security topics that are specific to writing and running Python code in WinCC OA. It is an orientation, not a complete treatment. The WinCC OA Security Guideline is the authoritative document for securing a project. Most of the mechanisms described here belong to the project configuration rather than to the Python code.
Related information
  • Data Access Patterns
    Reading, writing and observing datapoint values follows four patterns. Which one to use is a decision about confirmation and timing, not about the value itself. Historical values are a topic of their own and are covered at the end of the page.
  • Data Types
    WinCC OA has its own type system. The Python API maps between Python native types and WinCC OA types automatically where possible.
  • Error Handling
    Errors are reported as exceptions. A call that returns has succeeded, a call that fails raises. There is no return code to inspect and no equivalent of the CTRL function getLastError() that has to be queried after every statement.
  • Logging
    The Python API does not define a log API of its own. Messages are written with the standard logging module of Python, and the manager forwards them to the WinCC OA log system.
  • Manager Lifecycle
    The Manager class is the entry point for all interactions with WinCC OA. It manages the connection to the runtime system, the event loop, and graceful shutdown.
  • CTRL Interoperation
    A Python manager can run CTRL code. This gives access to the CTRL function set and to the script libraries that already exist in a project, without having to port them.
  • Manager Service API (MSA)
    The Manager Service API (MSA) lets managers call each other. One manager offers a service, another manager calls its methods through a stub. MSA works across all manager programming languages, so a Python manager can call a service written in CTRL, C++, C# or TypeScript, and vice versa.
  • Security
    This page collects the security topics that are specific to writing and running Python code in WinCC OA. It is an orientation, not a complete treatment. The WinCC OA Security Guideline is the authoritative document for securing a project. Most of the mechanisms described here belong to the project configuration rather than to the Python code.

SIMATIC WinCC Open Architecture Version 3.21.7 - © ETM professional control GmbH - | | | - Privacy Policy - Cookie Policy - Terms of use - Whistleblowing - Imprint