Documentation Overview

The following table gives you a documentation overview and the targeted audience for each section.

Table 1 Documentation Overview

Chapter

Description

Target Audience

Introduction

Describes the basic idea and concepts of SmartGridready.

  • Everybody

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.

  • Everybody

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 Suppliers

  • Communicator Suppliers

  • Architects and Planners

  • Network Operators

  • All Developers

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 Code Samples

Provides sample code to help you get started with integrating the Communication Handler libraries into Communicator code.

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.