Merge branch '2030_5_wip' of github.com:craig8/volttron into 2030_5_wip

.gitignore

@@ -39,3 +39,4 @@ rabbitmq-server.download.tar.xz
 /docs/source/volttron_api/
 *ecobee_*.json
 .env*
+dist/

services/core/IEEE_2030_5/AGENTDEMO.md

@@ -0,0 +1,117 @@
+# 2030.5 Agent Demo
+
+This readme walks through a demo of an inverter publishing points to the VOLTTRON message bus where the 2030.5 agent will receive it.  The 2030.5 agent will then create MirrorUsagePoints and POST MirrorMeterReadings to the 2030.5 server.  In addition, the demo will also allow the user to create a DERControl event.  During the activation of the event, the agent will log messages to the 2030.5 server.
+
+The demo will require three terminal windows to be open.  The first will be for executing the main VOLTTRON process.  The second will be for executing the 2030.5 server.  The third will be for executing the agent demo through a web interface.  For the rest of this document, VOLTTRON_ROOT is assumed to be where one has cloned the volttron repository.
+
+First configure the server then the VOLTTRON instance and findally the web based demo.
+
+## 2030.5 Server
+
+For the server software we will be using a server from a team at PNNL.  The GridAPPS-D team has created a 2030.5 server and it is available at <https://pypi.org/project/gridappsd-2030-5/>.  The source code is still in a private repo, but will be released at some time in the future.
+
+1. In a new terminal create a new virtual environment and install the gridappsd server.  **This directory should be outside the main volttron tree**
+
+    ```bash
+    > mkdir 2030_5_server
+    > cd 2030_5_server
+
+    # creates an environment 'env' in the current directory
+    > python3 -m venv serverenv
+
+    > source serverenv/bin/activate
+
+    (serverenv)> pip install gridappsd-2030-5
+    ```
+
+1. The server is now installed.  Next copy the openssl.cnf and server.yml file from the $VOLTTRON_ROOT/services/core/IEEE_2030_5/demo directory to the newly created 2030_5_server directory.  After copying the current directory should look like the following.
+
+    ```bash
+    (serverenv)> ls -l
+        serverenv
+        openssl.cnf
+        server.yml
+    ```
+
+1. Modify the openssl.cnf to include the correct values for [req_distinguished_name].  Or use the defaults.  The server will create self-signed certificates for the client to use.
+
+1. Modify the server.yml file.  The default server.yml file contains a device (id: dev1) and DERProgram.  **dev1 must be present for the demo to run smoothly.**
+
+1. Start the server from the activated serverenv **This step will create development certificates for you**.  By default the certificates will be generated and stored in ~/tls.  One can change this location in the server.yml configuration file.
+
+    ```bash
+    (serverenv)> 2030_5_server server.yml --no-validate
+
+    # without creating certificates
+    # (serverenv)> 2030_5_server server.yml --no-validate --no-create-certs
+    ```
+
+## Demo Requirements
+
+For this demo, start a VOLTTRON default instance from the command line.  The following command will start VOLTTRON in the background writing to a volttron.log file.
+
+1. Activate and start the volttron instance.
+
+    ```bash
+    > cd $VOLTTRON_ROOT
+    > source env/bin/activate
+    (volttron)> ./start-volttron
+    # Watch the volttron log
+    (volttron)> tail -f volttron.log
+    ```
+
+1. Open another terminal to install the 2030.5 agent and add it's property map to the configuration store.
+
+    ```bash
+    > cd $VOLTTRON_ROOT
+    > source env/bin/activate
+    (volttron)> vctl install services/core/IEEE_2030_5/ --vip-identity ed1 --agent-config services/core/IEEE_2030_5/example.config.yml
+    (volttron)> vctl config store ed1 inverter_sample.csv services/core/IEEE_2030_5/inverter_sample.csv --csv
+    ```
+
+    <mark>Note ed1 is the identity that needs to be in the configuration on the web demo</mark>
+
+1. Open another terminal to run a simulated platform.driver.  In this case, an inverter with a connected battery is being simulated.
+    
+    ```bash
+    > cd $VOLTTRON_ROOT
+    > source env/bin/activate
+    (volttron)> python services/core/IEEE_2030_5/demo/inverter_runner.py
+    ```
+
+    This process will start publishing "all" messages for the inverter to the VOLTTRON message bus.
+
+1. Open another terminal to start the demo server in.  
+
+    ```bash
+    > cd $VOLTTRON_ROOT
+    > source env/bin/activate
+    (volttron)> cd services/core/IEEE_2030_5
+    (volttron)> pip install -r requirements_demo.txt
+    ...
+    ```
+
+1. Run the webgui.py script using the python interpretor.  This should open a webpage allowing one to test the functionality of the 2030.5 agent.  By default it will open at <http://0.0.0.0:8080>.
+
+    ```bash
+    (volttron)> python demo/webgui.py
+    ```
+
+## The Demo
+
+The demo starts with local time in the top followed by 2030.5's GMT time as a intenger.  The integer is how 2030.5 communicates datetimes within the protocol.  Five tabs are displayable and are
+pictured below:
+
+![Configuration Tab](./demo/images/configuration.png)
+
+![DER Default Control](./demo/images/default_control.png)
+
+![New DER Control](./demo/images/control_entry.png)
+
+![DER Control List - No Events](./demo/images/control_list_no_events.png)
+
+![DER Control List - Scheduled](./demo/images/control_list_scheduled.png)
+
+![DER Control List - Active](./demo/images/control_list_active.png)
+
+![DER Control List - Complete](./demo/images/control_list_complete.png)

services/core/IEEE_2030_5/README.md

@@ -19,19 +19,24 @@ The following diagram illistrates the data flow for the 2030.5 agent from the Pl
     Agent->>PlatformDriverAgent: Publishes Event Controls
 ```
 
-To see this process in action, please try out the [Agent Demo](AGENT_DEMO.md).
+To see this process in action, please try out the [Agent Demo](AGENTDEMO.md).
 
 ## Agent Config File
 
-<details>
-<summary>An example configuration file is at the root of the agent directory (example.config.yml)</summary>
+An example configuration file is at the root of the agent directory (example.config.yml)
 
 ```yaml
 # required parameters
-cacertfile: ~/tls/certs/ca.crt
-keyfile: ~/tls/private/dev1.pem
-certfile: ~/tls/certs/dev1.crt
+# A host ip address or a resolvable dns entry is required for connecting to.
+# The agent will connect to this during the startup of the agent.
 server_hostname: 127.0.0.1
+
+# The client and ca paramenters are required for bi-directional
+# verification of certificates/keys.
+cacertfile: ~/tls/certs/ca.pem
+keyfile: ~/tls/private/dev1.pem
+certfile: ~/tls/certs/dev1.pem
+
 # the pin number is used to verify the server is the correct server
 pin: 111115
 
@@ -40,15 +45,18 @@ log_req_resp: true
 
 # SSL defaults to 443
 server_ssl_port: 8443
-# http port defaults to none
-#server_http_port: 8080
-# Number of seconds to poll for new default der settings.
-default_der_control_poll: 60
 
+# The following is the definition of the MirrorUsagePoints
 MirrorUsagePointList:
   # MirrorMeterReading based on Table E.2 IEEE Std 2030.5-18
   # note the mRID in the MirrorMeterReading is the same that is in the
   #      MirrorUsagePoint.
+  # 
+  # NOTE: The subscription point will be a member of an "all" message from
+  #       the PlatformDriverAgent.
+  #
+  # NOTE: MRID must be hex digits meaning A-F and numeric values only and the
+  #       mRID for the MirrorUsagePoint and MirrorMeterReading are the same.
   - subscription_point: p_ac
     mRID: 5509D69F8B3535950000000000009182
     description: DER Inverter Real Power
@@ -65,6 +73,8 @@ MirrorUsagePointList:
         intervalLength: 300
         powerOfTenMultiplier: 0
         uom: 38
+  # NOTE: The subscription point will be a member of an "all" message from
+  #       the PlatformDriverAgent.
   - subscription_point: q_ac
     mRID: 5509D69F8B3535950000000000009184
     description: DER Inverter Reactive Power
@@ -87,35 +97,7 @@ MirrorUsagePointList:
 # 2030.5 server.
 subscriptions:
   - devices/inverter1/all
-
-# Nameplate ratings for this der client will be put to the
-# server during startup of the system.
-DERCapability:
-  # modesSupported is a HexBinary31 representation of DERControlType
-  # See Figure B.34 DER info types for information
-  # conversion in python is as follows
-  #   "{0:08b}".format(int("500040", 16))
-  #   '10100000000000001000000'  # This is a bitmask
-  # to generate HexBinary
-  #   hex(int('10100000000000001000000', 2))
-  #   0x500040
-  modesSupported: 500040
-  rtgMaxW:
-    multiplier: 0
-    value: 0
-  type: 0
-
-DERSettings:
-  modesEnabled: 100000
-  setGradW: 0
-  setMaxW:
-    multiplier: 0
-    value: 0
-
-# Note this file MUST be in the config store or this agent will not run properly.
-point_map: config:///inverter_sample.csv
 ```
-</details>
 
 ## Agent Installation