Skip to content

Commit

Permalink
JSON RPC2 implementation
Browse files Browse the repository at this point in the history
This is an initial commit to start development of this feature in its own feature branch
  • Loading branch information
DerAndereAndi committed Oct 28, 2024
1 parent ad314b8 commit 7f7579a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The supported functionality contains:
## Packages

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

```sh
go run cmd/hems/main.go 4715
go run examples/hems/main.go 4715
```

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

```sh
Usage: go run cmd/hems/main.go <serverport> <remoteski> <certfile> <keyfile>
Usage: go run examples/hems/main.go <serverport> <remoteski> <certfile> <keyfile>
```

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

```sh
go run cmd/hems/main.go 4715
go run examples/hems/main.go 4715
```

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

```sh
Usage: go run cmd/evse/main.go <serverport> <remoteski> <certfile> <keyfile>
Usage: go run examples/evse/main.go <serverport> <remoteski> <certfile> <keyfile>
```

- `remoteski` is the SKI of the remote device or service you want to connect to
Expand Down
3 changes: 3 additions & 0 deletions com/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Overview

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.
1 change: 1 addition & 0 deletions com/jsonrpc2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This is currently a placeholder file as this folder will host the jsonrpc2 API interface and implementation

0 comments on commit 7f7579a

Please sign in to comment.