Sensor Service Methods

[EcoStruxureIT]

Sensor Service WSDL

A sensor represents any measurable value or state within a device or probe. It is easy to confuse the terms sensors and probes. In the Data Center Expert domain, a probe is a physical entity for measuring an aspect of the physical environment, while a sensor is a conceptual entity which simply references any device or probe value or state.

Sensors themselves have an associated state value. This value indicates whether the sensor is connected or not (for sensors associated with probes) and whether there is an alarm condition associated with the value of the sensor. Alarms are generally triggered when a sensor’s value exceeds a threshold defined by the user on the device or on Data Center Expert.

Sensors are organized by a pre-defined set of sensor types. Most devices support a DEVICE_STATUS sensor.

Some devices will support multiple instances of a particular sensor type such as the BREAKER_CURRENT sensor on a PDU. When a device does have multiple instances of a sensor, each instance will be identified by a sequential index number.

Some devices consist of modules or sub-systems and sometimes these modules have multiple instances of a certain type of sensor. In these cases, the sensor instances are double-indexed; once for the module instance and once for the sensor instance.

When referencing a NetBotz probe sensor, the sensor index often represents the port that the probe is plugged into.

The following methods are available through the Sensor web service.

initializeSensorService

This optional method serves two purposes. First, it allows the sensor web service to be customized using a string of parameter values (NYI). Secondly, it provides a mechanism for isolating the 2-3 second set up time required for the first (and only the first) invocation of the sensor service; otherwise, a client has to endure that set up time during the processing of that first sensor service request. Returns true if successful.

Service: ISXCentralSensorService

Parameter	Type	Description
initialParameters	String	Ignored

getSensorByID

Returns an ISXCSensor object that represents a sensor being monitored by the Data Center Expert server and is identified by the specified ID. 

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID	String	The unique identifier of a sensor being monitored by the Data Center Expert server.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getSensorsByIDs

Returns a list of ISXCSensor objects that represent sensors being monitored by the Data Center Expert server and are identified by the specified IDs. 

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID list	String	A list of unique identifiers of sensors being monitored by the Data Center Expert server.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getSensorsByType

Returns a list of ISXCSensor objects that represent sensors being monitored by the Data Center Expert server and are of the specified type. 

Service: ISXCentralSensorService

Parameter	Type	Description
sensorType	ISXCSensorType	The specific type of the sensors to return.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getSensorsForDevice

 Returns a list of ISXCSensor objects that represent sensors connected to the DCE-server-monitored device that is identified by the specified ID. 

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID	String	The unique ID of the device to return sensors for.
sensorType (optional)	ISXCSensorType	The sensor type to filter the results on.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getDeviceForSensor

Returns an ISXCDevice object that represents the DCE-server-monitored device that the sensor with the specified ID is connected to.

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID	String	The unique ID of the sensor to return the device for.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getSensorData

Returns an ISXCSensorData object that represents the current value data for the sensor with the specified ID.

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID	String	The unique ID of the sensor to return the data for.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

For the getMultiple<X> methods, it is important to realize that specifying large sensor ID lists or “wide” date ranges can cause excessive CPU and/or memory utilization resulting in overall performance degradation. To prevent this, specify as few sensors and/or as narrow a date range as is reasonable for your application.

getMultipleSensorData

Returns a list of ISXCSensorDataSet objects that represent the current value data for a list of sensors with the specified IDs. Recommended when querying for data for 4 or more sensors. For 3 or less sensors, it may be more efficient to use the getSensorData method.

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID list	String	The unique IDs of the sensors to return the data for.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getMultiplePeakSensorData

Returns a list of ISXCSensorDataSet objects that represent the peak value data for a list of sensors with the specified IDs. Recommended when querying for data for 4 or more sensors. For 3 or less sensors, it may be more efficient to use the getSensorDataRange method.

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID list	String	The unique IDs of the sensors to return the data for.
startDateTime (optional)	xsd:datetime	The start date-time of the range to return data for, or null to return data from start of recorded data.
endDateTime (optional)	xsd:datetime	The end date-time of the range to return data for, or null to return data until the end of recorded data.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getMultipleAverageSensorData

Returns a list of ISXCSensorDataSet objects that represent the average value data for a list of sensors with the specified IDs. Recommended when querying for data for 4 or more sensors. For 3 or less sensors, it may be more efficient to use the getAverageSensorData method.

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID list	String	The unique IDs of the sensors to return the data for.
startDateTime (optional)	xsd:datetime	The start date-time of the range to return data for, or null to return data from start of recorded data.
endDateTime (optional)	xsd:datetime	The end date-time of the range to return data for, or null to return data until the end of recorded data.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getHistoricalSensorData

Returns a list of ISXCSensorData objects that represent the recorded value data for a sensor with the specified ID. 

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID	String	The unique ID of the sensor to return the data for.
startDateTime (optional)	xsd:datetime	The start date-time of the range to return data for, or null to return data from start of recorded data.
endDateTime (optional)	xsd:datetime	The end date-time of the range to return data for, or null to return data until the end of recorded data.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.
maxDataPoints (optional)	integer	The max number of data points to return in the request. Value cannot exceed 1000.

Note: ISXCSensorData objects contain timestamps corresponding to when the sensor data was captured. Since these timestamps can be used to determine/enforce sample order, there is no guarantee of any order in the returned list of samples.

getAverageSensorData

Returns an ISXCSensorData object that represents the average value of recorded data for a sensor with the specified ID. 

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID	String	The unique ID of the sensor to return the data for.
startDateTime (optional)	xsd:datetime	The start date-time of the range to return data for, or null to return data from start of recorded data.
endDateTime (optional)	xsd:datetime	The end date-time of the range to return data for, or null to return data until the end of recorded data.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getAverageSensorRange

Returns the ISXCSensorData objects that represent the highest and lowest values of recorded data for a sensor with the specified ID. 

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID	String	The unique ID of the sensor to return the data for.
startDateTime (optional)	xsd:datetime	The start date-time of the range to return data for, or null to return data from start of recorded data.
endDateTime (optional)	xsd:datetime	The end date-time of the range to return data for, or null to return data until the end of recorded data.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

Note: Normally ISXCSensorData objects contain timestamps corresponding to when the sensor data was captured. In the case of min/max sensor data, the timestamps are set to the user-specified EndDateTime. Because each min/max value could appear multiple times within a given date range, it is not possible to ascribe a specific collection date to either of the two returned min/max values.

getSensorEnumerations

Returns a list of localized strings that correspond to possible values for a sensor that returns an enumeration index as its current data value and is identified by the specified ID. 

Service: ISXCentralSensorService

Parameter	Type	Description
ISXCElementID	String	The unique ID of the sensor to return the enumerations for.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

Note: For sensors with enumerated value-types, the enumerated value definitions can vary from device model to device model. For example, an enumerated value of “0” for BATTERY_STATUS may mean “OK” on one UPS but may represent “Unknown” on another. Data Center Expert strives to normalize these values so they are consistent across devices. The number of supported devices makes this difficult to guarantee.

Verify sensor enumerations for all device models your application supports.