Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion website/docs/learn/communication-layer/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@ S2 was designed as a semantic protocol, which can have multiple, mutually compat

S2 Connect specifies the discovery, pairing, communication and unpairing process between two S2 Connect capable devices.

Refer to [specification](/s2-connect/1.0.0/discovery-pairing-authentication) to read the S2-Connect specification.
Refer to [specification](/s2-connect/1.0.0/discovery-pairing-authentication) to read the S2-Connect specification.

If you are looking for implementations of S2 Connect, head over to the [implementation status](s2-connect-implementations.md) page.
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Implementations
sidebar_position: 2
---

# S2 Connect implementations

S2 Connect allows for full interoperability between Resource Managers and Energy Management Systems in local, cloud and hybrid deployments. It is quite some work to implement the [S2 Connect specification](/s2-connect/1.0.0/discovery-pairing-authentication/). Therefore, S2 Connect is implemented in libraries for several programming languages. The goal is to have libraries with a clean API for the discovery, pairing and S2 session initiation process that shields all the implementation details from the users of the libraries such that they can focus on the real work of creating Resource Managers and Energy Management systems.

## Language overview
- **Rust**: currently the most complete implementation. S2 Connect is implemented in the [S2-Rust library](https://github.com/flexiblepower/s2-rust).
- **Python**: a work in progress. The implementation is currently in a private repository but if you are a Python developer and interested in contributing, please reach out on [discord](https://discord.com/invite/NyFMEPmuDw).
- **C**: a work in progress by [Inversable](https://inversable.com/). Will be published open source soon.
- **Go**: a work in progress.

## Feature overview
The main efforts have been put into the implementation of S2 Connect in Rust and Python. Below is an overview of the current implementation status.

| Feature | **Rust** | **Python**|
|---|---|---|
| WAN discovery | ❌ | ❌ |
| LAN discovery | ✅ | ❌ |
| Pairing Client | ✅ | ✅ |
| Pairing Server | ✅ | 🚧|
| Pairing API | ✅ | ❌ |
| Session initiation | ✅ | 🚧 |
| Unpairing | ✅ | 🚧 |

There is important note about Rust implementation: the specification says that there must be a rate limiting on the pairing process of one pairing per node_id per second. This is not yet implemented in Rust.

## Help wanted
There is still a lot of work to do. So if you like to contribute, have a look at the open issues, pick one, start the implementation and open a pull request. We would also like to get in touch with you on [discord](https://discord.com/invite/NyFMEPmuDw) where we can also discuss technical decision for the implementation of S2 Connect.
1 change: 1 addition & 0 deletions website/docs/learn/communication-layer/why-not-oauth.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Why not OAuth 2.0?
sidebar_position: 3
---

Since OAuth 2.0 is the industry standard to authorize clients for accessing protected server resources, it is very reasonable to question why the authorization of S2 clients do not use OAuth 2.0. This chapter addresses that question.
Expand Down
9 changes: 8 additions & 1 deletion website/docs/specs/specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import LinkCard from '@site/src/components/LinkCard';
import ThemedImage from '@theme/ThemedImage';
import useBaseUrl from '@docusaurus/useBaseUrl';
import CodeJsonIcon from '@iconify-react/mdi/code-json';
import FileCodeIcon from '@iconify-react/mdi/file-code';

# Overview of specifications

Expand Down Expand Up @@ -32,11 +33,17 @@ S2 Connect is a protocol specification enabling communication between an Energy
title="S2 Connect specification"
description="Read the full specification about interoperable device discovery, secure pairing, and authentication mechanisms"
icon={<ThemedImage
alt="My image"
alt="s2 logo"
sources={{
light: useBaseUrl('/img/Logo-S2-no-text.svg'),
dark: useBaseUrl('/img/s2-logo-dark.svg'),
}}
/>}
/>

<LinkCard
href="/docs/learn/communication-layer/s2-connect-implementations/"
title="S2 Connect implementations"
description="Status overview of S2 Connect implementations"
icon={<FileCodeIcon/>}
/>