|
UserGuide
User guide to download, install, and use hale-aloha-cli-jz.
Introductionhale-aloha-cli-jz is a command line interface program that interacts with WattDepot, an “open source system for collecting and storing data from electricity meters for smart grid research and experimentation”, a system developed at the University of Hawaii at Manoa. Using the hale-aloha-cli-jz command line interface can help you to understand various aspects of energy use in the Hale Aloha UH residence halls, without having to write your own code against the wattdepot API. Basic UseThe program accepts commands on the command line and runs until the quit command is entered. Commandscurrent-power [tower | lounge]This command displays the current power in kW for the requested tower or lounge. daily-energy [tower | lounge] [date]This command displays the energy in kWh used by the requested tower or lounge for the specified date. energy-since [tower | lounge] [date]This command displays the energy used from date specified to now. rank-towers [start date] [end date]This command displays a list in sorted order from least to most energy consumed between the start and end dates specified. set-baseline [tower | lounge] [date]This command defines date as the "baseline" day for [tower | lounge] , and obtains and saves the amount of energy used during each of the 24 hours of that day for the given [tower | lounge] . [date] is an optional argument in YYYY-MM-DD format and defaults to yesterday. monitor-power [tower | lounge] [interval]This command prints out a timestamp and the current power for [tower | lounge] every [interval] seconds. [interval] is an optional integer greater than 0 and defaults to 10 seconds. Entering any character (such as a carriage return) stops this monitoring process and returns the user to the command loop. monitor-goal [tower | lounge] goal intervalThis command prints out a timestamp, the current power being consumed by the a [tower | lounge] , and whether or not the [tower | lounge] is meeting its power conservation goal, where goal is an integer between 1 and 99 that specifies the desired percentage reduction from the baseline for this [tower | lounge] during this hour of the day, and interval is an integer greater than 0. This command is also interrupted by entering any character (such as a carriage return). quitThis command terminates the program. helpThis command displays useful help text for the program. How to Specify Tower Names in CommandsThe tower names that are accepted by the program are: Mokihana, Ilima, Lehua, and Lokelani. How to Specify Lounge Names in CommandsThe lounge names that are accepted by the program are the tower names followed by a "-", followed by one of A, B, C, D, E. For example, Ilima -A How to Specify Dates in CommandsThe only date format accepted by the program is yyyy-mm-dd, for example: 2011-11-09. Downloading the ProgramGo to the Downloads page and download the latest zip file. Installing the Program
Running the ProgramFrom the install directory where you placed the jar file, you should be able to type: java -jar hale-aloha-cli-jz.jar and you will see the prompt: cli > Requirements
|