Documentation Overview

Welcome to the SmartGridready documentation. This guide provides a comprehensive overview of the SmartGridready ecosystem, its concepts, and available resources. The documentation is organized into chapters, each tailored to specific audiences such as planners, suppliers, grid operators, and developers.

Note

Each chapter in the documentation is labeled with icons representing the intended target audience. Refer to Table 1 below for an explanation of these icons. This will help you quickly identify the sections most relevant to your interests and needs.

Table 1 Target audience icon explanation

Symbol	Description
	Planners & Architects
	Product and Communicator suppliers
	Distribution System Operators
	Developers (Communicator devices, SGr libraries)

To help you navigate the documentation, the following overview Table 2 lists all main chapters, describes their content, and shows which target audiences each chapter is intended for using the icons explained above. Use this table to quickly find the sections most relevant to your needs.

Table 2 Documentation Overview

Chapter	Description	Target Audience
Introduction	Describes the basic idea and concepts of SmartGridready.
Getting Involved	There are many ways to get involved and contribute to the SmartGridready project. This chapter describes how you can participate in SmartGridready projects based on your interests and expertise.
Functional Profiles	Explains the central role of Functional Profiles in SmartGridready. Describes the Functional Profiles in detail. Provides a link to the official SmartGridready library where all available Functional Profiles are listed.
Product Description File	Describes the structure of External Interface Definition files. Gives instructions on how to create an EID file. Provides a link to the official SmartGridready libary where all available Functional Profiles are listed.
SmartGridready Declaration	Guides you through the steps needed to get your Product SmartGridready declared.
SmartGridready Communication Handler Libraries	Describes the Communication Handler libraries and API’s in detail. Provides installation and getting started instructions. There are currently libraries in Python and Java.
SmartGridready Device Driver Libraries	Describes the Device Driver Adapter and the device driver adapter API in detail.
SmartGridready Intermediary	Describes the SmartGridready Intermediary. The intermediary provides a REST service to communicate with SmartGridready declared Products through a REST API. It can be deployed within a Docker container and is a good solution where no native library (Python, Java) is available.
OpenAPI Specifications	Provides OpenAPI specification templates for selected SmartGridready use cases. These specifications define standardized REST interfaces and machine-readable data models that support interoperable integration of services such as dynamic tariff APIs.