README.md 3.94 KB
Newer Older
Udo Eisenbarth's avatar
Udo Eisenbarth committed
1
modbox2_cspp README
Holger Brand's avatar
Holger Brand committed
2
====================
Udo Eisenbarth's avatar
Udo Eisenbarth committed
3
_modbox2_cspp.lvproj_ is used to develop an application based on NI ActorFramework and CS++ libraries. Currently used development SW is LabVIEW 2019.
Holger Brand's avatar
Holger Brand committed
4

Udo Eisenbarth's avatar
Udo Eisenbarth committed
5
This text will be inserted into README.md.
Holger Brand's avatar
Holger Brand committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

Related documents and information
=================================
- README.md
- Release_Notes.md
- EUPL v.1.1 - Lizenz.pdf & EUPL v.1.1 - Lizenz.rtf
- Contact: your email
- Download, bug reports... : Git Repository URL
- Documentation:
  - Refer to Documantation folder 
  - NI Actor Framework: https://ni.com/actorframework
  - CS++
	- https://git.gsi.de/EE-LV/CSPP/CSPP/wikis/home
    - https://git.gsi.de/EE-LV/CSPP/CSPP_Documentation
  
Included Submodules
===================
- [Packages/CSPP_Core](https://git.gsi.de/EE-LV/CSPP/CSPP_Core): This package is used as submodule.
- [Packages/CSPP_ObjectManager](https://git.gsi.de/EE-LV/CSPP/CSPP_ObjectManager): This package is used as submodule.
- [Packages/CSPP_DSC](https://git.gsi.de/EE-LV/CSPP/CSPP_DSC): Containing DSC Alarm- & Trend-Viewer
- [Packages/CSPP_Utilities](https://git.gsi.de/EE-LV/CSPP/CSPP_Utilities): Providing some usefull utility classes. 

Optional Submodules
-------------------
- [Packages/CSPP_DeviceBase](https://git.gsi.de/EE-LV/CSPP/CSPP_DeviceBase): Definition of CS++Device ancestor classes
- [Packages/CSPP_IVI](https://git.gsi.de/EE-LV/CSPP/CSPP_IVI): Implementations of derived CS++Device classes using IVI driver
- [Packages/CSPP_LNA](https://git.gsi.de/EE-LV/CSPP/CSPP_LNA): Extends the Linked Network Actor to support zero coupled messages.
- [Packages/CSPP_RT](https://git.gsi.de/EE-LV/CSPP/CSPP_RT): Providing a librarie supporting LabVIEW-RT features. 
- [Packages/CSPP_PVConverter](https://git.gsi.de/EE-LV/CSPP/CSPP_PVConverter): Providing support for e.g. log-scaling of PV or conversion to array. 
- [Packages/CSPP_Syslog](https://git.gsi.de/EE-LV/CSPP/CSPP_Syslog): Providing a Syslog based Message Handler 
Holger Brand's avatar
Holger Brand committed
36
- [Packages/CSPP_Vacuum](https://git.gsi.de/EE-LV/CSPP/CSPP_Vacuum): Providing a DeviceActors dealing with vacuum. 
Holger Brand's avatar
Holger Brand committed
37
38
39
40
41
42
43
44
45

Refer to https://git.gsi.de/EE-LV/CSPP for more available CS++ submodules.

Optional External Dependencies
=================================
- Monitored Actor; Refer to
  - https://decibel.ni.com/content/thread/18301 and
  - http://lavag.org/topic/17056-monitoring-actors

Holger Brand's avatar
Holger Brand committed
46
47
Start Implementing YourProject
===================================
Holger Brand's avatar
Holger Brand committed
48
- Extend `YourProject.lvproj` to your needs.
Holger Brand's avatar
Holger Brand committed
49
  - Edit copyright information in description of `YourProject.lvproj` and README.md
Holger Brand's avatar
Holger Brand committed
50
51
52
53
54
55
56
57
58
  - Add more submodules
    - Template configuration ini-files and Shared Variable libraries should be included in all submodules.
    - Add more actors to configuration ini-file by copying from templates and renaming.
    - You need to create and deploy your project specific shared variable libraries.
         - e.g. copy Shared Variables from `CSPP_Core_SV.lvlib` to `YourProject.lvlib` and rename.
  - Develop your project specific actor classes.
    - Provide template configuration ini-files and Shared Variable libraries
  - If Data Logging and Supervisory Control Module is available
    - Configure DSC settings, alarming and trending, for Shared Variables and libraries.
Holger Brand's avatar
Holger Brand committed
59
60
61
62

Known issues:
=============

Udo Eisenbarth's avatar
Udo Eisenbarth committed
63
Author: u.eisenbarth@gsi.de
Holger Brand's avatar
Holger Brand committed
64

65
Copyright 2020  GSI Helmholtzzentrum für Schwerionenforschung GmbH
Holger Brand's avatar
Holger Brand committed
66
67
68
69
70
71
72
73
74
75

EEL, Planckstr.1, 64291 Darmstadt, Germany

Lizenziert unter der EUPL, Version 1.1 oder - sobald diese von der Europäischen Kommission genehmigt wurden - Folgeversionen der EUPL ("Lizenz"); Sie dürfen dieses Werk ausschließlich gemäß dieser Lizenz nutzen.

Eine Kopie der Lizenz finden Sie hier: http://www.osor.eu/eupl

Sofern nicht durch anwendbare Rechtsvorschriften gefordert oder in schriftlicher Form vereinbart, wird die unter der Lizenz verbreitete Software "so wie sie ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN - ausdrücklich oder stillschweigend - verbreitet.

Die sprachspezifischen Genehmigungen und Beschränkungen unter der Lizenz sind dem Lizenztext zu entnehmen.