OpenSMI API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Module Index

  • server - Server implementation of Skill-based Production using OPC-UA.
    • access_control - Client authentication & authorization.
    • base_callable - Abstract base class for all callables, i.e. skills (BaseSkill) and methods (BaseMethod).
    • base_feasibility_check - Base class for feasibility checks for skills.
    • base_machine - Abstract base class for a Smart Machine.
    • base_machinery_item - No module docstring; 0/3 type variable, 2/2 classes documented
    • base_method - Abstract base class for all methods.
    • base_precondition_check - Base class for precondition checks for skills.
    • base_skill - Abstract base skill without state machine logic.
    • base_startup_skill - No module docstring; 1/1 class documented
    • common - No module docstring; 1/2 constant, 5/5 functions documented
    • config - Configuration data classes and functions to load them from TOML files.
    • interfaces - All abstract interfaces used in the server.
    • lock - UaObject for managing exclusive access to its parent and its children.
    • mixins - Mixins for UaObject and its subclasses.
      • description_mixin - Mixin for initializing the OPC UA description of UaObject using their Python docstrings.
      • lockable_mixin - Mixin for providing a Lock to an UaObject.
      • notification_mixins - Mixins providing standard AbstractUaLogger implementations for BaseMachineryItem. Use at most one.
      • parent_mixin - (Optional) Mixin for typing the parent of an UaObject.
      • requirements_mixin - Mixin providing requirement/dependency management capabilities for UaObject.
      • skill_logic_mixins - State machine logic for both finite & continuous skills.
      • spatial_object_mixin - Mixins related to OPC UA spatial objects (Relative Spatial Location information model).
      • ua_object_container_mixins - Mixins for various UaObjectContainer containing UaObject.
      • ua_variable_container_mixins - Generic mixins for providing an UaObject with Attributes, Monitoring, ParameterSet and FinalResultData.
    • nodesets - Autogenerated OPC UA node identifiers.
      • di - Node identifiers from the OPC UA 'Di' nodeset. Auto-generated.
      • machinery - Node identifiers from the OPC UA 'Machinery' nodeset. Auto-generated.
      • rsl - Node identifiers from the OPC UA 'RSL' nodeset. Auto-generated.
      • smart_factory_machine_set - Node identifiers from the OPC UA 'SmartFactoryMachineSet' nodeset. Auto-generated.
      • smart_factory_skill_set - Node identifiers from the OPC UA 'SmartFactorySkillSet' nodeset. Auto-generated.
    • notification - Implementation of the AbstractUaLogger interface with a Notification OPC UA object and event sources.
    • protocols - No module docstring; 8/15 classes documented
    • resource - Everything related to resources.
    • spatial_object - Classes related to OPC UA Relative Spatial Location Information Model.
    • ua_dictionary_entry - OPC UA dictionary entries (semantic identifiers) as defined in OPC 10000-19.
    • ua_fsm - Finite state machine with OPC-UA representation based on transitions library.
    • ua_object - Base class for all server-side PyUaAdapter-managed OPC UA objects.
    • ua_object_containers - Generic container for UaObject. Is itself an UaObject.
    • ua_variable - Abstraction-layer for OPC UA variables our framework users interacts with.
    • ua_variable_containers - Container implementation for UaVariable.
    • user - User (role), authentication and OPC UA representation.
    • _server - No module docstring; 0/1 type variable, 0/1 function, 2/4 classes documented

API Documentation for OpenSMI, generated by pydoctor 25.10.1 at 2026-10-29 17:03:00.