Skip to content

Commit c35ab07

Browse files
Add clarity for examples code (#153)
1 parent 1edb43f commit c35ab07

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,47 @@ The supported functionality contains:
2929
- `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
3030
- `usecases`: containing actor and use case based implementations with use case scenario based APIs and events
3131

32-
## Usage
32+
## Examples
3333

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.
3535

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.
3737

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
3961

4062
### HEMS
4163

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+
4266
#### First Run
4367

4468
```sh
45-
go run cmd/hems/main.go 4715
69+
go run cmd/hems/main.go 4714
4670
```
4771

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
4973

5074
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.
5175

@@ -61,13 +85,15 @@ Usage: go run cmd/hems/main.go <serverport> <remoteski> <certfile> <keyfile>
6185

6286
### EVSE
6387

88+
This includes example code for accepting LPC from a control box.
89+
6490
#### First Run
6591

6692
```sh
6793
go run cmd/hems/main.go 4715
6894
```
6995

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
7197

7298
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.
7399

0 commit comments

Comments
 (0)