webserviceinterface21
Differences
This shows you the differences between two versions of the page.
|
webserviceinterface21 [2014/05/16 11:00] mysmartgrid |
webserviceinterface21 [2015/04/09 11:56] (current) paalsteek added port as optional sensor setting |
||
|---|---|---|---|
| Line 62: | Line 62: | ||
| | 480 | Invalid Characters | The request cannot be fulfilled because it contains a string with non-printable characters. | | | 480 | Invalid Characters | The request cannot be fulfilled because it contains a string with non-printable characters. | | ||
| | 481 | Invalid Network Configuration | The request cannot be fulfilled because it contains invalid network configuration properties. Please check the message structure. | | | 481 | Invalid Network Configuration | The request cannot be fulfilled because it contains invalid network configuration properties. Please check the message structure. | | ||
| + | | 499 | Client Closed Request | The connection has been closed by client while the server is still processing its request, making server unable to send a status code back. | | ||
| | 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 184: | Line 185: | ||
| ip: <string(15) - iff protocol is static>, | ip: <string(15) - iff protocol is static>, | ||
| netmask: <string(15) - iff protocol is static>, | netmask: <string(15) - iff protocol is static>, | ||
| - | gateway: <string(15) - iff protocol is static> | + | gateway: <string(15) - iff protocol is static>, |
| + | nameserver: <string(15) - iff protocol is static> | ||
| }, | }, | ||
| wifi: (optional) { | wifi: (optional) { | ||
| Line 194: | Line 196: | ||
| ip: <string(15) - iff protocol is static>, | ip: <string(15) - iff protocol is static>, | ||
| netmask: <string(15) - iff protocol is static>, | netmask: <string(15) - iff protocol is static>, | ||
| - | gateway: <string(15) - iff protocol is static> | + | gateway: <string(15) - iff protocol is static>, |
| + | nameserver: <string(15) - iff protocol is static> | ||
| } | } | ||
| } | } | ||
| Line 225: | Line 228: | ||
| ip: <string(15) - iff protocol is static>, | ip: <string(15) - iff protocol is static>, | ||
| netmask: <string(15) - iff protocol is static>, | netmask: <string(15) - iff protocol is static>, | ||
| - | gateway: <string(15) - iff protocol is static> | + | gateway: <string(15) - iff protocol is static>, |
| + | nameserver: <string(15) - iff protocol is static> | ||
| }, | }, | ||
| wifi: (optional) { | wifi: (optional) { | ||
| Line 234: | Line 238: | ||
| ip: <string(15) - iff protocol is static>, | ip: <string(15) - iff protocol is static>, | ||
| netmask: <string(15) - iff protocol is static>, | netmask: <string(15) - iff protocol is static>, | ||
| - | gateway: <string(15) - iff protocol is static> | + | gateway: <string(15) - iff protocol is static>, |
| + | nameserver: <string(15) - iff protocol is static> | ||
| } | } | ||
| }, | }, | ||
| Line 260: | Line 265: | ||
| { | { | ||
| 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 331: | Line 337: | ||
| { | { | ||
| config : { | config : { | ||
| - | device: <string(32) - device id>, | + | device: <string(32) - device id>, |
| - | externalid: <string(64) - 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>, | + | class: <string(10) - sensor class (either analog or pulse)>, |
| - | class: <string(10) - sensor class (one of analog, pulse)>, | + | voltage: <integer - sensor voltage in Volts (only if class is analog)>, |
| - | voltage: <integer - sensor voltage (iff class is analog and type is electricity)>, | + | current: <integer - sensor current in Amperes (only if class is analog)>, |
| - | current: <integer - sensor current (iff class is analog and type is electricity)>, | + | constant: <integer - sensor constant in pulses/kWh (only if class is pulse)>, |
| - | constant: <integer - sensor constant (iff class is pulse)>, | + | description: <string(64) - a user defined description of the sensor>, |
| - | type: <string(16) - sensor type (one of electricity, water, gas)>, | + | unit (optional): <string(16) - sensor unit>, |
| - | description: <string(64) - a user defined description of the sensor> | + | port (optional): <integer - physical port of the sensor> |
| } | } | ||
| } | } | ||
| Line 363: | Line 369: | ||
| { | { | ||
| config : { | config : { | ||
| - | device: <string(32) - device id>, | + | device: <string(32) - device id>, |
| - | externalid: <string(64) - 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>, |
| - | class: <string(10) - sensor class (one of analog, pulse)>, | + | class: <string(10) - sensor class (one of analog, pulse)>, |
| - | voltage: <integer - sensor voltage (iff class is analog and type is electricity)>, | + | voltage: <integer - sensor voltage (iff class is analog and type is electricity)>, |
| - | current: <integer - sensor current (iff class is analog and type is electricity)>, | + | current: <integer - sensor current (iff class is analog and type is electricity)>, |
| - | constant: <integer - sensor constant (iff class is pulse)>, | + | constant: <integer - sensor constant (iff class is pulse)>, |
| - | type: <string(16) - sensor type (one of electricity, water, gas)>, | + | type: <string(16) - sensor type (one of electricity, water, gas)>, |
| - | description: <string(64) - a user defined description of the sensor> | + | description: <string(64) - a user defined description of the sensor>, |
| + | port (optional): <integer - physical port of the sensor> | ||
| } | } | ||
| } | } | ||
| Line 450: | Line 457: | ||
| 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 | | ||
webserviceinterface21.1400230806.txt.gz · Last modified: 2014/05/16 11:00 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
