README.md 3.13 KB
Newer Older
Manuel Sebald's avatar
Manuel Sebald committed
1
# HSE Libraries 
Joerg Hampel's avatar
Joerg Hampel committed
2

Manuel Sebald's avatar
Manuel Sebald committed
3 4
The _HSE Libraries_ are a collection of useful LabVIEW libraries developed over the years for and within our real-life projects. 
These libraries form the basis of all our applications, similar to a very basic framework.
Joerg Hampel's avatar
Joerg Hampel committed
5

Manuel Sebald's avatar
Manuel Sebald committed
6
This repository contains the following libraries:
Joerg Hampel's avatar
Joerg Hampel committed
7

Manuel Sebald's avatar
Manuel Sebald committed
8 9 10 11 12 13 14
* hse-application
  
  Bsic VIs and classes to manage the fundamental properties of an application like version, application paths and general infos.
  
* hse-configuration
  
  Classes for reading and writing configuration sources like .ini files.
Joerg Hampel's avatar
Joerg Hampel committed
15

Manuel Sebald's avatar
Manuel Sebald committed
16 17 18 19 20 21
* hse-db
  
  Database interfaces for various DB systems (eg Microsoft ADO and MySQL/MariaDB). An additional DQMH module, which capsules the DB interfaces, 
  can be used in DQMH projects.
  
* hse-dqmh
Joerg Hampel's avatar
Joerg Hampel committed
22

Manuel Sebald's avatar
Manuel Sebald committed
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
  This library contains helpers for loading and using DQMH modules. 
  It caters to the HSE-specific events and supports programmatic features of our 
  [Windows Application Template](https://gitlab.com/hampel-soft/dqmh/hse-application-template) applications.
  
* hse-gennet
  
  The _DQMH Generic Networking Module_ is a DQMH Singleton module altered to allow for (near) zero-coupled networking functionality.
  
* hse-misc
  
  This is a collection of useful VIs developed over the years for and within our real-life projects.
  
* hse-ui
  
  Useful helper VIs and tools for creating and manipulating user interfaces.
  
Joerg Hampel's avatar
Joerg Hampel committed
39

Manuel Sebald's avatar
Manuel Sebald committed
40
For a more detailed documentation please have a look at our DokuWiki https://dokuwiki.hampel-soft.com/code/open-source/hse-libraries.
Joerg Hampel's avatar
Joerg Hampel committed
41 42 43 44


## :rocket: Installation

Joerg Hampel's avatar
Joerg Hampel committed
45
> Don't go looking for a VI Package - there is none! If you're wondering why, read more about [how we work with reuse code at HSE](https://dokuwiki.hampel-soft.com/code/common/dependency-structure).
Joerg Hampel's avatar
Joerg Hampel committed
46

Manuel Sebald's avatar
Manuel Sebald committed
47 48
Just copy everything under the folder `Source` into your project structure and use it. You are free to remove any libs you don't want to 
use from the `Source` directory as long as this doesn't break the code!
Joerg Hampel's avatar
Joerg Hampel committed
49

Joerg Hampel's avatar
Joerg Hampel committed
50 51
The hse-libraries work best when used from a project based on the HSE [repository](https://dokuwiki.hampel-soft.com/code/common/repository-structure) 
and [project](https://dokuwiki.hampel-soft.com/code/common/project-structure) structure. 
Joerg Hampel's avatar
Joerg Hampel committed
52

Manuel Sebald's avatar
Manuel Sebald committed
53
The latest release version can be found at https://dokuwiki.hampel-soft.com/code/open-source/hse-libraries/releases.
Joerg Hampel's avatar
Joerg Hampel committed
54 55


Joerg Hampel's avatar
Joerg Hampel committed
56 57 58 59
### :wrench: LabVIEW 2014

The VIs are maintained in LabVIEW 2014.

Manuel Sebald's avatar
Manuel Sebald committed
60
### :link: Dependencies
Joerg Hampel's avatar
Joerg Hampel committed
61

Manuel Sebald's avatar
Manuel Sebald committed
62
These libraries depend on the HSE-Logger: https://dokuwiki.hampel-soft.com/code/open-source/hse-logger.
Joerg Hampel's avatar
Joerg Hampel committed
63 64


Manuel Sebald's avatar
Manuel Sebald committed
65
## :bulb: Usage
Joerg Hampel's avatar
Joerg Hampel committed
66

Manuel Sebald's avatar
Manuel Sebald committed
67
If you want to use the framework helpers (hse-application and hse-configuration), you can find more information about our file 
Joerg Hampel's avatar
Joerg Hampel committed
68
and project structure at https://dokuwiki.hampel-soft.com/code/common/project-structure.
Joerg Hampel's avatar
Joerg Hampel committed
69 70 71 72


## :busts_in_silhouette: Contributing 

Manuel Sebald's avatar
Manuel Sebald committed
73 74 75 76
We welcome every and any contribution. On our Dokuwiki, we compiled detailed information on 
[how to contribute](https://dokuwiki.hampel-soft.com/processes/collaboration). 
Please get in touch at ([email protected]) for any questions.

Joerg Hampel's avatar
Joerg Hampel committed
77 78 79 80 81 82

##  :beers: Credits

* Joerg Hampel
* Manuel Sebald

Manuel Sebald's avatar
Manuel Sebald committed
83

Joerg Hampel's avatar
Joerg Hampel committed
84 85
## :page_facing_up: License 

Manuel Sebald's avatar
Manuel Sebald committed
86
This project is licensed under a modified BSD License - see the [LICENSE](LICENSE) file for details.