frappy/README.md
Alexander Zaft 819026659a Fix forge link in README
Change-Id: Ie428f1814edc2685d03590da4e0635d0b100bbdf
Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/30538
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Alexander Zaft <a.zaft@fz-juelich.de>
2023-03-06 08:24:15 +01:00

30 lines
913 B
Markdown

Frappy: Framework for programming secnodes in Python
====================================================
Frappy is a Pyhthon-framework for writing SECoP servers (called SECNodes or Nodes) and Clients.
It comes with its own Graphical client and a collection of example Nodes.
It is able to use TCP and Serial connections.
To get started, look at the provided demo, the provided examples, or have a look at the INTRODUCTION section.
Main development is done [here](https://forge.frm2.tum.de/review/q/project:secop%252Ffrappy) and a readonly GitHub-mirror for easier access is available [here](https://github.com/SampleEnvironment/frappy)
Requirements
------------
See `requirements.txt`.
Demo
----
Use the following command after installing the dependencies:
```
$ make frappy-demo
```
Documentation
-------------
[See here for documentation of Frappy](https://forge.frm2.tum.de/public/doc/frappy/html/)