webserviceinterface2
Differences
This shows you the differences between two versions of the page.
|
webserviceinterface2 [2013/09/11 12:02] mysmartgrid |
webserviceinterface2 [2016/01/13 15:48] (current) mysmartgrid [Messages Reference] |
||
|---|---|---|---|
| Line 59: | Line 59: | ||
| | 477 | Invalid Event | The request cannot be fulfilled because it contains invalid an invalid event id. Please check the message structure. | | | 477 | Invalid Event | The request cannot be fulfilled because it contains invalid an invalid event id. Please check the message structure. | | ||
| | 478 | Unupgradable Firmware | The current device firmware can not be upgraded via the API. Please, flash the [[http://openwrt.mysmartgrid.de/flm02/atheros|latest mySmartGrid image]] to your device manually. | | | 478 | Unupgradable Firmware | The current device firmware can not be upgraded via the API. Please, flash the [[http://openwrt.mysmartgrid.de/flm02/atheros|latest mySmartGrid image]] to your device manually. | | ||
| + | | 479 | Invalid Sensor External Id | The request cannot be fulfilled because it contains invalid sensor external id. Please check the message structure. If the problem persists, the id might be taken. In this case, please inform a new one. | | ||
| + | | 480 | Invalid Characters | The request cannot be fulfilled because it contains a string with non-printable characters. | | ||
| | 500 | Internal Server Error | The request was aborted due to an unspecified error on the server. This incident has been reported to the mySmartGrid team. | | | 500 | Internal Server Error | The request was aborted due to an unspecified error on the server. This incident has been reported to the mySmartGrid team. | | ||
| | 501 | Not Implemented | The server does not provide the requested operation. Please check the X-Version header and the URL structure. | | | 501 | Not Implemented | The server does not provide the requested operation. Please check the X-Version header and the URL structure. | | ||
| Line 76: | Line 78: | ||
| | Hectopascal | hPa | hPa | | | Hectopascal | hPa | hPa | | ||
| | Relative Humidity | %r.h. | rh | | | Relative Humidity | %r.h. | rh | | ||
| + | | Internal Control Unit | _hsbs | _hsbs | | ||
| \\ | \\ | ||
| Line 94: | Line 97: | ||
| key: <string(32) - SHA-1 key used for device authentication>, | key: <string(32) - SHA-1 key used for device authentication>, | ||
| description: <string(60) - the description of the device (optional)>, | description: <string(60) - the description of the device (optional)>, | ||
| - | type: <the device type (flukso2, vzlogger, libklio, raspberrypi) (optional)> | + | memtotal: <integer - total RAM in MB (optional)>, |
| + | memcached: <integer - total cache memory in MB (optional)>, | ||
| + | membuffers: <integer - total buffer memory in MB (optional)>, | ||
| + | memfree: <integer - total free memory in MB (optional)>, | ||
| + | uptime: <integer - total time the device has been up and running, in seconds>, | ||
| + | reset: <integer - number of times the device has been reset (optional)>, | ||
| + | version: <integer - deprecated field, currently being ignored by the server>, | ||
| + | firmware: (optional) { | ||
| + | version: <string(11) - firmware version, using the | ||
| + | format: 9.9.9-9, for example: 2.3.1-1>, | ||
| + | releasetime: <string(14) - firmware release date and time, using the | ||
| + | format: YYYYmmmdd_HHii, for example: 20120524_1158>, | ||
| + | build: <string(40) - firmware release identifier, | ||
| + | for example: f0ba69e4fea1d0c411a068e5a19d0734511805bd>, | ||
| + | tag: <string(32) - firmware release tag in Git repository, | ||
| + | for example: flukso-2.0.3-rc1-19-gf0ba69e> | ||
| + | }, | ||
| + | type: <the device type (flukso2, vzlogger, libklio, raspberrypi) | ||
| + | (mandadory if firmware is informed)> | ||
| } | } | ||
| | | | | ||
| Line 137: | Line 158: | ||
| ^ Request Body | | ^ Request Body | | ||
| { | { | ||
| - | memtotal: <integer - total RAM in MB (optional)>, | + | description: <string(60) - the description of the device (optional)>, |
| - | memcached: <integer - total cache memory in MB (optional)>, | + | memtotal: <integer - total RAM in MB (optional)>, |
| - | membuffers: <integer - total buffer memory in MB (optional)>, | + | memcached: <integer - total cache memory in MB (optional)>, |
| - | memfree: <integer - total free memory in MB (optional)>, | + | membuffers: <integer - total buffer memory in MB (optional)>, |
| - | uptime: <integer - total time the device has been up and running, in seconds (optional)>, | + | memfree: <integer - total free memory in MB (optional)>, |
| - | reset: <integer - number of times the device has been reset (optional)>, | + | uptime: <integer - total time the device has been up and running, in seconds>, |
| - | version: <integer - deprecated field, currently being ignored by the server>, | + | reset: <integer - number of times the device has been reset (optional)>, |
| + | version: <integer - deprecated field, currently being ignored by the server>, | ||
| firmware: (optional) { | firmware: (optional) { | ||
| version: <string(11) - firmware version, using the | version: <string(11) - firmware version, using the | ||
| Line 149: | Line 171: | ||
| releasetime: <string(14) - firmware release date and time, using the | releasetime: <string(14) - firmware release date and time, using the | ||
| format: YYYYmmmdd_HHii, for example: 20120524_1158>, | format: YYYYmmmdd_HHii, for example: 20120524_1158>, | ||
| - | build: <string(32) - firmware release identifier, | + | build: <string(40) - firmware release identifier, |
| for example: f0ba69e4fea1d0c411a068e5a19d0734511805bd>, | for example: f0ba69e4fea1d0c411a068e5a19d0734511805bd>, | ||
| tag: <string(32) - firmware release tag in Git repository, | tag: <string(32) - firmware release tag in Git repository, | ||
| for example: flukso-2.0.3-rc1-19-gf0ba69e> | for example: flukso-2.0.3-rc1-19-gf0ba69e> | ||
| }, | }, | ||
| - | description: <string(60) - the description of the device (optional)> | + | type: <the device type (flukso2, vzlogger, libklio, raspberrypi) |
| + | (mandadory if firmware is informed)>, | ||
| } | } | ||
| | | | | ||
| Line 190: | Line 213: | ||
| { | { | ||
| description: <string(60) - the device description>, | description: <string(60) - the device description>, | ||
| + | type: <the device type (flukso2, vzlogger, libklio, raspberrypi)> | ||
| sensors: [ | sensors: [ | ||
| { meter: <string(32) - sensor id>, | { meter: <string(32) - sensor id>, | ||
| Line 247: | Line 271: | ||
| | 105 | Firmware Upgraded | The device has successfully performed a firmware upgrade. | | | 105 | Firmware Upgraded | The device has successfully performed a firmware upgrade. | | ||
| | 106 | Failed Firmware Upgrade | The device has failed to performed a firmware upgrade. | | | 106 | Failed Firmware Upgrade | The device has failed to performed a firmware upgrade. | | ||
| + | | 107 | Networkconfiguration OK | The device has successfully configured the network. | | ||
| + | | 108 | Networkconfiguration failed | The device has failed to configure the network.| | ||
| \\ | \\ | ||
| Line 262: | Line 288: | ||
| config : { | config : { | ||
| device: <string(32) - device id>, | device: <string(32) - device id>, | ||
| - | externalid: <string(32) - sensor id given by the client>, | + | externalid: <string(64) - sensor id given by the client>, |
| function: <string(16) - sensor name>, | function: <string(16) - sensor name>, | ||
| unit: <string(16) - sensor unit>, | unit: <string(16) - sensor unit>, | ||
| Line 354: | Line 380: | ||
| unit = <the unit in which the measurement results will be shown> | unit = <the unit in which the measurement results will be shown> | ||
| interval = <an alternative way of representing a period of time that ends right now | interval = <an alternative way of representing a period of time that ends right now | ||
| - | (minute, 15min, day, week)> | + | (15min, hour, day, week)> |
| | | | | ||
| ^ Response Body | | ^ Response Body | | ||
webserviceinterface2.1378893757.txt.gz · Last modified: 2013/09/11 12:02 by mysmartgrid
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
