Skip to content

Library to support PLCOpen commands in a OOP way

License

Notifications You must be signed in to change notification settings

simatic-ax/commands

Repository files navigation

@simatic-ax.commands

Description

This library provides abstract base classes for PLC Open handling.

Install this package

Enter:

apax add @simatic-ax/commands

Namespace

Simatic.Ax.Commands;

Object

Base Objects for cyclic calls and initialize method.

 classDiagram
      Object <|-- itfObject
      class itfObject
      class Object{
          + RunCyclic
      }
Loading

Command Interface/Classes

Classes for PlcOpen support

 classDiagram
      ExecuteCommand <|-- Command
      Command <|-- itfCommand
      class itfCommand{
        + Busy() BOOL
        + Done() BOOL
        + CommandAborted() BOOL
        + Error() BOOL
        + ErrorID() WORD
      }
Loading

itfCommand

NAMESPACE Simatic.Ax.Commands

    INTERFACE itfCommand
        METHOD Busy : BOOL
        END_METHOD
        METHOD Done : BOOL
        END_METHOD
        METHOD CommandAborted : BOOL
        END_METHOD
        METHOD Error : BOOL
        END_METHOD
        METHOD ErrorID : WORD
        END_METHOD
    END_INTERFACE

END_NAMESPACE

Command IMPLEMENTS itfCommand

Simple PlcOpen Command for enabling commands

ExecuteCommand EXTENDS Command

Simple PlcOpenCOmmand for

Contribution

Thanks for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section or, even better, is free to propose any changes to this repository using Merge Requests.

Markdownlint-cli

This workspace will be checked by the markdownlint-cli (there is also documented ho to install the tool) tool in the CI workflow automatically.
To avoid, that the CI workflow fails because of the markdown linter, you can check all markdown files locally by running the markdownlint with:

markdownlint **/*.md --fix

License and Legal information

Please read the Legal information