SMA SUNNY WEBBOX RPC - Manual (Page 3)

SMA Solar Technology AG Table of Contents
User Manual SWebBoxRPC-BA-en-14 3
Table of Contents
1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1 Validity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2 Nomenclature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3 Acronyms and Abbreviations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.4 Referenced Documents and Sources . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2 System Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1 Sunny WebBox RPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2 Differences between Sunny WebBox and Sunny WebBox with
Bluetooth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3 JavaScript Object Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.1 Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4 Procedure Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.1 Procedure Call (Request). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2 Return Value (Response) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.2.1 JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.3 Query Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5 Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.1 RPC via UDP Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.2 RPC via HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
6 Object Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
6.1 Device Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
6.2 Channel Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
7 Service Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
7.1 RPC_GET_PLANT_OVERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
7.1.1 Version 1.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
7.2 RPC_GET_DEVICES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
7.2.1 Version 1.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16