envoy-schema 2.0.0

Envoy Schema - a collection of pydantic models compatible with the Envoy utility server

envoy-schema - forked for Synergy storage extension

This is a forked project with a long lived branch which implements the CSIP-Aus storage extension (https://csipaus.org/ns/v1.3-beta/storage) proposed by Synergy

The original project, which focuses implementation on the current accepted CSIP-Aus standards, is developed by BSGIP here

Assumed workflow

This repository's main branch is intended to always follow the original BSGIP main e.g. using GitHub's built in "Sync Fork" feature

Whenever a "sync" occurs, efforts should be made to merge these into the longlived csipaus.org/ns/v1.3-beta/storage branch

All changes that can apply to both repositories/branches is preferred to be resolved by raising a pull request against the original BSGIP main and then merging this into main. Of course this could be too slow for implementation purposes and should be reviewed on a case by case basis.

All remaining sections should reflect the original documentation as part of the original repository.

envoy-schema

Public schema for the models/schema associated all envoy API endpoints.

This repository was built as a shared dependency for the envoy utility server and any external clients wishing to integrate.

Envoy: https://github.com/bsgip/envoy

Envoy Server Models

The models served under envoy_schema.server are derived from the following standards:

• IEEE: Smart Energy Profile (2030.5-2018)
• Sunspec: Common Smart Inverter Profile
• Common Smart Inverter Profile (Australia)

Versioning

The main branch is the active development branch. Releases will be tagged off the associated release branch.

CSIP-Aus Version	envoy-schema versions	release branches
v1.1a	v0.*, v1.*	csipaus.org/ns/v1.2
v1.2	v0.*, v1.*	csipaus.org/ns/v1.2
v1.3	v2.*	csipaus.org/ns/v1.3

Envoy Admin Models

The models served under envoy_schema.admin are typically only used for services directly integrating with the envoy utility server (via the admin server). This is for machine-machine services that are not typically exposed externally.

Installation

Install directly from pypi

pip install envoy_schema

Development

To install envoy-schema for development purposes, after cloning this repository:

pip install -e .[dev, test]
pytest

We use the following linting/formatting tools:

• bandit
• flake8
• mypy

Contributions via a pull request are welcome but will be validated using the above tools.

Tests can be run with: pytest from the root directory.