Skip to content

Commit 44ada35

Browse files
committed
JSON RPC2 implementation
This is an initial commit to start development of this feature in its own feature branch
1 parent 7e021df commit 44ada35

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The supported functionality contains:
2424
## Packages
2525

2626
- `api`: global API interface definitions and eebus service configuration
27+
- `com/jsonrpc2`: provides an JSON RPC2 implementation, to communicate with systems not written in Golang
2728
- `features/client`: provides feature helpers with the local SPINE feature having the client role and the remote SPINE feature being the server for easy access to commonly used functions
2829
- `features/server`: provides feature helpers with the local SPINE feature having the server role for easy access to commonly used functions
2930
- `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
@@ -42,7 +43,7 @@ Services with implemented use cases will be implemented in different repositorie
4243
#### First Run
4344

4445
```sh
45-
go run cmd/hems/main.go 4715
46+
go run examples/hems/main.go 4715
4647
```
4748

4849
`4715` is the example server port that this process should use
@@ -52,7 +53,7 @@ The certificate and key and the local SKI will be generated and printed. You sho
5253
#### General Usage
5354

5455
```sh
55-
Usage: go run cmd/hems/main.go <serverport> <remoteski> <certfile> <keyfile>
56+
Usage: go run examples/hems/main.go <serverport> <remoteski> <certfile> <keyfile>
5657
```
5758

5859
- `remoteski` is the SKI of the remote device or service you want to connect to
@@ -64,7 +65,7 @@ Usage: go run cmd/hems/main.go <serverport> <remoteski> <certfile> <keyfile>
6465
#### First Run
6566

6667
```sh
67-
go run cmd/hems/main.go 4715
68+
go run examples/hems/main.go 4715
6869
```
6970

7071
`4715` is the example server port that this process should use
@@ -74,7 +75,7 @@ The certificate and key and the local SKI will be generated and printed. You sho
7475
#### General Usage
7576

7677
```sh
77-
Usage: go run cmd/evse/main.go <serverport> <remoteski> <certfile> <keyfile>
78+
Usage: go run examples/evse/main.go <serverport> <remoteski> <certfile> <keyfile>
7879
```
7980

8081
- `remoteski` is the SKI of the remote device or service you want to connect to

com/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Overview
2+
3+
This folder contains multiple communication APIs for services that are not written in Golang and need to communicate with a Go service running this stack and use the public API for interaction.

com/jsonrpc2/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This is currently a placeholder file as this folder will host the jsonrpc2 API interface and implementation

0 commit comments

Comments
 (0)