The WattDepot3 HTTP API accepts measurements about the physical world.

In WattDepot3's model there are:

• Sensors - Sensors represent the device that measures the physical universe. Sensors have:
  • URIs - A Internet address where sensor processes can access their measurements. (Note: Sensor processes are not modeled by WattDepot3.)
  • Locations - The location on the earth of the sensor (e.g. Latitude, Longitude, Altitude, Description).
  • Models A description of the type of sensor, the protocol and version it is using.
  • List of Properties - A potentially empty list of properties that describe the individual sensor.
• Sensor Groups - Are groups of sensors. WattDepot uses these groups for aggregation. We can group all the energy sensors in a building into a single group.
• Collector Metadata Collectors are processes that contact a Sensor and produce measurements. Collector Metadata is a representation of how often to poll a Sensor and which WattDepository to store the Measurements in. Collectors should use the Collector Metadata to control their activities.
• WattDepositories - Are responsible for storing the measurements made by the Sensors. They have an associated measurement type.
• Measurements - Are made by Sensors and consist of the sensor that made the measurement, the time the measurement was made, the value of the measurement and the measurement type.
• Measured Values - Are values often interpolated from sensor measurements. There are two primary Measured Values, point values and difference values.
  1. Point values are calculated at a single point in time. If the time corresponds to a measurement then WattDepot returns the measurement's value. If the time is between two measurements WattDepot calculates the linear interpolated value and returns it.
  2. For Difference values WattDepot get the value for the start and end points then subtracts the start value from the end value and returns the result.

The individual pages to the left describe the HTTP API for Creating, Reading, Updating, and Deleting these entities.

GET

• GET /wattdepot/{group_id}/ Returns the Group's administration user interface.
• GET /wattdepot/{group_id}/locations/ Get a full list of the defined Locations.
• GET /wattdepot/{group_id}/location/{location_id} Get the Location with the given id.
• GET /wattdepot/{group_id}/sensorgroups/ Get a full list of the defined SensorGroups.
• GET /wattdepot/{group_id}/sensorgroup/{sensorgroup_id} Get the SensorGroup with the given id.
• GET /wattdepot/{group_id}/sensormodels/ Get a full list of the defined SensorModels.
• GET /wattdepot/{group_id}/sensormodel/{sensormodel_id} Get the SensorModel with the given id.
• GET /wattdepot/{group_id}/collectormetadatas/ Get a full list of the defined Collector Metadatas.
• GET /wattdepot/{group_id}/collectormetadata/{collectormetadata_id} Get the Collector Metadata with the given id.
• GET /wattdepot/{group_id}/sensors/ Get a full list of the defined Sensors.
• GET /wattdepot/{group_id}/sensor/{sensor_id} Get the Sensor with the given id.
• GET /wattdepot/{group_id}/depositories/ Get a full list of the defined WattDepositories.
• GET /wattdepot/{group_id}/depository/{wattdepository_id} Get the WattDepository with the given id.
• GET /wattdepot/{group_id}/depository/{wattdepository_id}/sensors/ Get a list of sensors that sent measurements to the WattDepository with the given id.
• GET /wattdepot/{group_id}/depository/{wattdepository_id}/value/?sensor={sensor_id}&{timestamp} Get measurement value for the given sensor at the given time. This is most likely an interpolated value.
• GET /wattdepot/{group_id}/depository/{wattdepository_id}/value/?sensor={sensor_id}&start={timestamp}&end={timestamp} Get measurement value for the given sensor over the time period. The value at start is subtracted from the value at end.
• GET /wattdepot/{group_id}/depository/{wattdepository_id}/measurements/?sensor={sensor_id}&start={timestamp}&end={timestamp} Get measurements for the given sensor over the time period.

POST

• POST /wattdepot/{group_id}/location/ Create a new Location. It must have a unique id.
• POST /wattdepot/{group_id}/sensorgroup/ Create a new SensorGroup. It must have a unique id.
• POST /wattdepot/{group_id}/sensormodel/ Create a new SensorModel. It must have a unique id.
• POST /wattdepot/{group_id}/collectormetadata/ Create a new SensorProcess. It must have a unique id.
• POST /wattdepot/{group_id}/sensor/ Create a new Sensor. It must have a unique id.
• POST /wattdepot/{group_id}/depository/ Create a new WattDepository. It must have a unique id.
• POST /wattdepot/{group_id}/depository/{wattdepository_id}/measurement/ Add the measurement to the given WattDepository.

DEL

• DEL /wattdepot/{group_id}/location/{location_id} Remove the Location with the given id.
• DEL /wattdepot/{group_id}/sensorgroup/{sensorgroup_id} Remove the SensorGroup with the given id.
• DEL /wattdepot/{group_id}/sensormodel/{sensormodel_id} Remove the SensorModel with the given id.
• DEL /wattdepot/{group_id}/collectormetadata/{collectormetadata_id} Remove the Collector Metadata with the given id.
• DEL /wattdepot/{group_id}/sensor/{sensor_id} Remove the Sensor with the given id.
• DEL /wattdepot/{group_id}/depository/{wattdepository_id} Remove the WattDepository with the given id.