4 prozedur-konventionen, 1 prozeduraufruf (request) – SMA SUNNY WEBBOX RPC Benutzerhandbuch

Seite 10

Advertising
background image

4  Prozedur-Konventionen

SMA Solar Technology AG

10

SWebBoxRPC-BA-de-14

Bedienungsanleitung

4 Prozedur-Konventionen

Alle verwendeten Bezeichner sind case-sensitiv. Das heißt, "Power" und "power" bezeichnen
beispielsweise zwei verschiedene Objekte. Alle Zeichen werden als Unicode im UTF-8 Format
übertragen.

4.1 Prozeduraufruf (Request)

Jeder Request besteht aus einem serialisierten JSON-Objekt, welches folgende obligatorische
Mitglieder besitzt:

version — Eine Zeichenfolge, welche die zugrunde liegende RPC-Version festlegt.
proc — Eine Zeichenfolge, die den Namen der aufzurufenden Prozedur enthält.
id — Eine beliebige Zeichenfolge (max. 16 Zeichen), welche der Zuordnung einer Antwort zur

Anfrage dient.

format — Eine Zeichenfolge, die das Datenaustauschformat des Prozedurergebnisses festlegt

(siehe Kapitel 4.2 „Rückgabewert (Response)“, Seite 11).

passwd — Eine Zeichenfolge, die den Hashwert des Passworts für den gewünschten

Zugriffs-Level (Benutzer, Installateur) enthält. Der Hashwert wird mittels MD5-Algorithmus (siehe
[4]) berechnet. Die Passwortvergabe erfolgt über die Sicherheitseinstellungen der Sunny
WebBox. Wenn das Objekt nicht übertragen wird, wird automatisch der Benutzer-Level
angenommen.

params — Ein Objekt, dessen Elemente der Prozedur als Argumente übergeben werden. Jeder

Parameter muss in Form eines benannten JSON-Objekts vorliegen. Die Reihenfolge ist somit
beliebig. Die Anzahl der Parameter hängt von der jeweiligen Service-Prozedur ab
(siehe Kap. 7). Wenn die aufgerufene Prozedur keine Argumente erwartet entfällt der Eintrag.

Advertising