ziver/hal
1
1
Fork 0
Code Pull requests Releases Activity

Added architecture description

Browse source
This commit is contained in:
Ziver Koc 2021-03-21 19:37:17 +01:00
parent c0188cd5cc
commit 8d51526481
1 changed files with 30 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -38,13 +38,14 @@ The project is currently in alpha state, and as such things will change and brea
## Installing
To run the Hal server you first need to clone the git repository and then run the
ant command to build and run:
gradle command to build and run the server:
```
./gradlew run
```
Check `hal.conf.example` for available configuration options.
By default, HAL server will be listening to http://localhost:8080.
## Running the tests
@ -55,6 +56,33 @@ test-cases run:
./gradlew test
```
## Architecture
```
HalAbstractControlerManager
|
| HalAbstractController
| |
| | HalAbstractDevice
| | |
.-----------. .------------. .--------.
| | | | | |
| | | | ----> | Device |
| | | | | |
| | ----> | Controller | '--------'
| | | | .--------.
| | | | | |
| Manager | | | ----> | Device |
| | | | | |
| | '------------' '--------'
| | .------------. .--------.
| | | | | |
| | ----> | Controller | ----> | Device |
| | | | | |
'-----------' '------------' '--------'
```
## Authors
* **Daniel Collin**