Copyright ? 2011 Green Energy Corp. All Rights Reserved.
?
Document Control #: 02.004.000.000.000
Release Date: 20111220
Remove an application from list. If we try to remove a running application it will cause that app to restart. (experts-only!)
View a calculations details including its current values. Examples: Show just the calculationd details: calculation:view --no-values System.AverageStoredEnergy Show and subscribe to only the calculation output: calculation:view -w -o System.AverageStoredEnergy Show the calculation and only the immedate input points: calculation:view --no-indirect-parentsn System.AverageStoredEnergy Show the calculation and all of its related points: calculation:view --show-children System.AverageStoredEnergy
| -w | Subscribe to measurement updates and continuously display new values coming in. Press cntrl-c to stop |
| -o | Show only calculation output. Equivilant to "--no-indirect-parents --no-direct-parents" |
| --show-children | Don't show the values of child points |
| --no-indirect-parents | Dont show values for indirect parents |
| --no-values | Display current values of inputs and calculation |
| --no-direct-parents | Dont show values for direct parents |
Upload a config file. If the file already exists in reef overwrite the data in the file.
| configFileName | Name for config file in reef, this needs to match what is in configfile:list exactly to replace a file. |
| inputFile | Local File name to load data from, defaults to configFileName. Needs to be specified if local filename doesn't match reef configFileName. |
| Parent Entity Name | Parent entity name. |
| relType | Relationship type. |
| subType | Sub entity type. |
Prints the results of complex tree queries on the entity system. Each relationship descriptor is made of 4 parts seperated by colons. Examples: Get all child points regardless of depth: entity:relations Root owns:*:true:Point Get all points and commands organized by equipment: entity:relations Root owns:*:true:Equipment owns:*:true:Point,Command Get all Equipment organized by EquipmentGroup: entity:relations Root owns:1:true:EquipmentGroup owns:1:true:Equipment Get all of an Endpoints commands and their owning equipment: entity:relations -name NullEndpoint source:*:true:Command owns:1:false:Equipment Stars can be used as a wildcard for depth and types.
| Entity Type | Entity name. |
| Relationship descriptor | [relationship]:[depth]:[child]:[type1,type2,..] |
| Entity Type | Entity name. |
| Relationship | Name of relationship type |
| Depth | Show entities that are up to depth level children from parent. |
| types | List of types we want in returned list |
| eventType | Event Type |
| resourceString | Resource string we use to render event messsage |
Block a point so it does recieve measurement updates from the field (aka. Not in Service).
Download all measurements for a point to CSV file. Ex: meas:download -s "2012-02-10 00:00" PV.csv LV.Line_PV.kW_tot
| -s | Start time as "yyyy-MM-dd HH:mm" or milliseconds, defaults to 0 |
| -oh | Offest Hours, number of hours before end time |
| -e | End time as "yyyy-MM-dd HH:mm" or milliseconds, defaults to now |
| -om | Offest Minutes, number of minutes before end time |
| -c | Columns in CSV file (defaults to name,longTime,shortTime,value,shortQuality,longQuality,unit) |
| -block | Show only operator blocked measurements (aka. Not in Service). |
| -good | Show only measurements with validity good. |
| -override | Show only overridden measurements (aka. Substituted). |
| -invalid | Show only measurements with validity invalid. |
| -questionable | Show only measurements with validity questionable. |
Unblock a point so it recieves measurement updates from the field (aka. In Service).
| -dryRun | Just analyze file, don't actually send data to reef |
| -benchmark | Override endpoint protocol to force all endpoints in configuration file to be simulated |
| -batchSize | Upload batch size, 0 disables all batching (defaults to 25) |
| -ignoreWarnings | Still attempt upload even if configuration is invalid |
| userName | User name, if not specified we try looking for user settings in etc directory. |
Example?2.1.?Viewing Events
karaf@root> event:list -l 5 Uid Type Alarm Sev User Entity ------------------------------------------------------------------- 3980 | System.UserLogin | true | 8 | core | | 3981 | System.UserLogin | true | 8 | core | | 3984 | System.UserLogin | true | 8 | core | | 4077 | System.UserLogout | true | 8 | core | | 4087 | System.UserLogin | true | 8 | core | | -> Message Time -> ------------------------------------- -> User logged in | 13:57:45 06-16-11 -> User logged in | 13:57:45 06-16-11 -> User logged in | 13:57:59 06-16-11 -> User logged out | 14:03:22 06-16-11 -> User logged in | 14:03:38 06-16-11 karaf@root> event:list -t System.UserLogin -l 5 Uid Type Alarm Sev User Entity ------------------------------------------------------------------- 3980 | System.UserLogin | true | 8 | core | | 3981 | System.UserLogin | true | 8 | core | | 3984 | System.UserLogin | true | 8 | core | | 4077 | System.UserLogout | true | 8 | core | | 4087 | System.UserLogin | true | 8 | core | | -> Message Time -> ------------------------------------- -> User logged in | 13:57:45 06-16-11 -> User logged in | 13:57:45 06-16-11 -> User logged in | 13:57:59 06-16-11 -> User logged out | 14:03:22 06-16-11 -> User logged in | 14:03:38 06-16-11
Example?2.2.?Creating a test event with custom error string
karaf@root> event-config:create Test.Event "Test event with attrs: {a} {b}"
Type Designation Sev Audible Resources
--------------------------------------------------------------------------------
Test.Event | EVENT | 4 | true | Test event with attrs: {a} {b}
karaf@root> event:publish -a a:one -a b:two Test.Event
Uid | 4241
Type | Test.Event
Alarm | false
Sev | 4
User | core
Subsystem | proto-shell
Entity |
Rendered | Test event with attrs: one two
Time | 14:13:58 06-16-11
Device Time |
Arguments | 2
b | two | STRING
a | one | STRING
karaf@root> event-config:delete Test.Event
Type Designation Sev Audible Resources
--------------------------------------------------------------------------------
Test.Event | EVENT | 4 | true | Test event with attrs: {a} {b}
Example?2.3.?Standard Event Configurations
karaf@root> event-config:list
Type Designation Sev
---------------------------------------------------
System.UserLogin | ALARM | 8 |
System.UserLoginFailure | ALARM | 8 |
System.UserLogout | ALARM | 8 |
System.SubsystemStarting | ALARM | 8 |
System.SubsystemStarted | ALARM | 8 |
System.SubsystemStopping | ALARM | 8 |
System.SubsystemStopped | ALARM | 8 |
Scada.ControlExe | ALARM | 8 |
Scada.UpdatedSetpoint | ALARM | 8 |
Scada.OutOfNominal | ALARM | 8 |
Scada.OutOfReasonable | ALARM | 8 |
Scada.SetOverride | ALARM | 8 |
Scada.SetNotInService | ALARM | 8 |
Scada.RemoveOverride | ALARM | 8 |
Scada.RemoveNotInService | ALARM | 8 |
-> Audible Resources
-> -----------------------------------------------------
-> false | User logged in
-> false | User login failed {reason}
-> false | User logged out
-> false | Subsystem is starting
-> false | Subsystem has started
-> false | Subsystem is stopping
-> false | Subsystem has stopped
-> false | Executed control {command}
-> false | Updated setpoint {command} to {value}
-> false | Measurement not in nominal range: {value}
-> false | Measurement not reasonable: {value}
-> false | Point overridden
-> false | Point removed from service
-> false | Removed override on point
-> false | Returned point to service