Manual¶
The manual is the reference narrative for o6\Python. It is written as a book: each chapter builds on the vocabulary introduced by the ones before it, so the examples grow shorter as those concepts become familiar. It therefore reads best from top to bottom, following the order of the navigation, through to Server.
Contents¶
| # | Chapter | What it gives you |
|---|---|---|
| 1 | OPC UA Fundamentals | The specification's concepts — protocol, services, information modelling, datatypes, namespaces, nodesets. Independent of any SDK. |
| 2 | Node API | The pythonic object model that the rest of the manual uses in nearly every example. |
| 3 | o6\Python SDK Fundamentals | How the SDK maps the specification onto Python: built-in types, the namespace registry, writing and compiling nodesets. |
| 4 | Client | The complete story of o6.Client — lifecycle, address space, subscriptions and history, raw services. |
| 5 | Server | The complete story of o6.Server — lifecycle, building an address space, declared types, behaviour and callbacks, events, access control, operations. |
If you already know OPC UA, chapter 1 is a refresher you can skim — chapters 2 and 3 are worth reading even then, as they establish the notation and the type vocabulary that the Client and Server chapters use without further comment.
Chapters 4 and 5 are written so that you can read either without knowing the other. if you only write clients, read Client and stop; if you only build servers, Server stands on its own after chapter 3.
Advanced topics¶
The remaining two chapters are reference material rather than part of the reading path. Neither is required to use the SDK, their order carries no meaning, and each page stands alone and lists its own prerequisites.
- Performance — end-to-end benchmarks against native open62541 C and asyncua, for both the client and the server role. Consult it when you need numbers, or when sizing a design's throughput budget.
- Implementation details — how the binding itself works: memory management, variable callbacks, namespace matching, GIL and event-loop bridging, wire-format mapping. Consult it to diagnose a non-obvious failure, to extend the binding, or to judge whether an unusual use case is supported.
Release notes¶
The final chapter, Release Notes, lists new features, improvements, bug fixes, and breaking changes by release.