This crate provides type definitions and utilities for working with the S2 energy flexibility standard in Rust. S2 is a communication standard for energy flexibility and energy management in homes and buildings, designed to simplify the use of energy flexibility of smart devices. To learn more about the S2 standard:
- Read the documentation for a detailed explanation of S2
- Visit the website for a high-level explanation of S2
- Read the whitepaper to learn why it's important to expose and utilise energy flexibility
This crate provides Rust types for all types specified by S2. It also provides utilities that help you manage an S2 connection over websockets with JSON as the format, including functions to easily set up a WebSocket server/client to send/receive S2 messages.
JSON over WebSockets is a common and recommended way to implement S2, but you're free to choose a different format and communication protocol. In that case, the types in this crate should still be useful but you may wish to disable the websockets-json feature.
You can find the crate documentation at docs.rs. The crate documentation assumes that you are familiar with S2; if this is not the case, it may be useful to refer to the S2 documentation website. That documentation explains S2 concepts in more detail, and contains a reference of all messages and types in the S2 specification.