
wattdepot-cli
Provides a simple command line interface for obtaining information from a WattDepot service.
The Command Specification page provides documentation on the acceptable commands.
Here is a sample session that gives the flavor of the system. Note that the sources all return simulated data for the Oahu power grid.
``` [~] java -jar wattdepot-cli.jar http://server.wattdepot.org:8182/wattdepot/ Connecting to WattDepot server. Connected to http://server.wattdepot.org:8182/wattdepot/ Starting command interface.
help help This message quit Exits the system carboncontent {source} {timestamp} sampling-interval {interval} Computes the carbon content of the source. carbonstats {source} from {start} to {end} Finds the max/min/average carbon content for a source over a time period. chart power [generated|consumed] {source} {startday} {endday} sampling-interval {minutes} file {file} Writes out an html file that will display a chart illustrating the carbon or energy for the source over the interval. dailysensordata {source} day {day} Prints a table listing all of the sensor data instances for the specified day. energystats generated {source} from {start} to {end} {hourly|daily} Find the max/min/average energy consumption by a source between the given dates.fueltypes {source} Prints information about sources generating power using different fuel types. power [generated|consumed] {source} timestamp {timestamp} Prints the power generated by the source at the given timestamp. powerstats [generated|consumed] {source} day {day} sampling-interval {minutes} statistic {max|min|average} Returns the maximum, minimum, or average power generated by the source for the day. sensordata {source} timestamp {timestamp} Prints information about a single sensor data instance. sources Prints a table summarizing the public sources in the system, one per line. summary {source} Prints information about a single source. total [carbon|energy] generated {source} day {day} sampling-interval {minutes} Returns the total amount of carbon (or energy) emitted by this source for the given day. totalpower {source} {timestamp} fueltype {fueltype} Prints information about the power generated by a source given a fueltype.
sources Name Parent Description
SIM_AES SIM_IPP AES Hawaii is an independent power producer on Oahu's grid that uses coal as its fuel. SIM_HONOLULU SIM_OAHU_GRID Virtual resource for all Honolulu power plants.
SIM_HONOLULU_8 SIM_HONOLULU Honolulu 8 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_HONOLULU_9 SIM_HONOLULU Honolulu 9 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_HPOWER SIM_IPP HPOWER is an independent power producer on Oahu's grid that uses municipal waste as its fuel. SIM_IPP SIM_OAHU_GRID Virtual resource for all independent power producers (non-HECO). SIM_KAHE SIM_OAHU_GRID Virtual resource for all Kahe power plants.
SIM_KAHE_1 SIM_KAHE Kahe 1 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_KAHE_2 SIM_KAHE Kahe 2 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_KAHE_3 SIM_KAHE Kahe 3 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_KAHE_4 SIM_KAHE Kahe 4 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_KAHE_5 SIM_KAHE Kahe 5 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_KAHE_6 SIM_KAHE Kahe 6 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_KAHE_7 SIM_KAHE Kahe 7 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_KALAELOA SIM_IPP Kalaeloa is an independent power producer on Oahu's grid that uses LSFO as its fuel. SIM_OAHU_GRID Virtual resource for all Oahu power plants.
SIM_WAIAU SIM_WAIAU Virtual resource for all Waiau power plants.
SIM_WAIAU_10 SIM_WAIAU Waiau 10 is a HECO plant on Oahu's grid that uses diesel as its fuel. SIM_WAIAU_5 SIM_WAIAU Waiau 5 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_WAIAU_6 SIM_WAIAU Waiau 6 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_WAIAU_7 SIM_WAIAU Waiau 7 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_WAIAU_8 SIM_WAIAU Waiau 8 is a HECO plant on Oahu's grid that uses LSFO as its fuel. SIM_WAIAU_9 SIM_WAIAU Waiau 9 is a HECO plant on Oahu's grid that uses diesel as its fuel.summary SIM_OAHU_GRID SubSources: SIM_KAHE ,SIM_WAIAU ,SIM_HONOLULU ,SIM_IPP Description: Virtual resource for all Oahu power plants. Owner: oscar@wattdepot.org Location: To be looked up later Coordinates: 0,0,0 Properties:
Earliest data: 2009-10-25T00:00:00.000-10:00 Latest data: 2009-12-31T23:45:00.000-10:00 Total data points: 117504total energy generated SIM_OAHU_GRID day 2009-11-01 sampling-interval 60 14089.0 MWh quit Exiting Wattdepot CLI [~]->
```