You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-7Lines changed: 33 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,23 +29,47 @@ The supported functionality contains:
29
29
-`service`: central package which provides access to SHIP and SPINE. Use this to create the EEBUS service, its configuration and connect to remote EEBUS services
30
30
-`usecases`: containing actor and use case based implementations with use case scenario based APIs and events
31
31
32
-
## Usage
32
+
## Examples
33
33
34
-
The included small demo applications do not implement any usecases and thus will end the connection once it reached exchanging usecase information.
34
+
The examples folder contains a few demo applications using this stack. These do **not** provide complete implementations of any use case, but are intended as usage guidelines for the eebus-go stack in general and to have a quick demo.
35
35
36
-
Services with implemented use cases will be implemented in different repositories and are also early work in progress:
36
+
Therefore, please do not expect any of these examples to provide any meaningful functionality on their own, but instead view them as rough guidelines on the functionality you could implement using the eebus-go stack.
37
37
38
-
-[HEMS](https://github.com/enbility/cemd)
38
+
### Controlbox
39
+
40
+
This includes example code for sending an LPC limit 5 seconds after connecting to a compatible device that can receive LPC limits.
41
+
42
+
#### First Run
43
+
44
+
```sh
45
+
go run cmd/controlbox/main.go 4713
46
+
```
47
+
48
+
`4713` is the example server port that this process should listen on
49
+
50
+
The certificate and key and the local SKI will be generated and printed. You should then save the certificate and the key to a file.
51
+
52
+
#### General Usage
53
+
54
+
```sh
55
+
Usage: go run cmd/controlbox/main.go <serverport><remoteski><certfile><keyfile>
56
+
```
57
+
58
+
-`remoteski` is the SKI of the remote device or service you want to connect to
59
+
-`certfile` is a local file containing the generated certificate in the first usage run
60
+
-`keyfile` is a local file containing the generated key in the first usage run
39
61
40
62
### HEMS
41
63
64
+
This includes example code for accepting LPC and LPP limits from a control box, receiving and printing data to the console from battery (VABD) and pv inverters (VAPD) and grid connection point data (MGCP).
65
+
42
66
#### First Run
43
67
44
68
```sh
45
-
go run cmd/hems/main.go 4715
69
+
go run cmd/hems/main.go 4714
46
70
```
47
71
48
-
`4715` is the example server port that this process should use
72
+
`4714` is the example server port that this process should listen on
49
73
50
74
The certificate and key and the local SKI will be generated and printed. You should then save the certificate and the key to a file.
51
75
@@ -61,13 +85,15 @@ Usage: go run cmd/hems/main.go <serverport> <remoteski> <certfile> <keyfile>
61
85
62
86
### EVSE
63
87
88
+
This includes example code for accepting LPC from a control box.
89
+
64
90
#### First Run
65
91
66
92
```sh
67
93
go run cmd/hems/main.go 4715
68
94
```
69
95
70
-
`4715` is the example server port that this process should use
96
+
`4715` is the example server port that this process should listen on
71
97
72
98
The certificate and key and the local SKI will be generated and printed. You should then save the certificate and the key to a file.
0 commit comments