Presentation Topics ESPI / DMD deeper dive o Atom feeds o ESPI Usage schema o Ontario Guidelines CMD Technical Overview o Protocols and underlying technologies o API overview o Ontario Reference Architecture Specifics Useful Resources and Recommended Approach
Composition of Energy Usage Information UsagePoint ServiceCategory MeterReading IntervalBlock IntervalReading ReadingQuality ReadingType ElectricPowerSummary ElectricPowerQuality Summary Note: This information is multidimensional. Many different reading types, summaries, and readings possible. i.e. not “flat” EUI comes from and to residences and businesses Source: David Wollman (NIST)
DMD: EUI Composition and Atom Feeds UsagePointUsagePoint ServiceCategory MeterReadingMeterReadingIntervalBlockIntervalBlock IntervalReading ReadingQuality ReadingTypeReadingType ElectricPower Usage Summary ElectricPower Quality Summary 1 0..* 1 Syntactic Model Atom Feed View Information Model Profile View 0..1 LocalTime Parameters AtomFeedAtomFeed Entry:UsagePointEntry:UsagePoint Entry:MeterReadingEntry:MeterReading Entry:ReadingTypeEntry:ReadingType Entry:IntervalBlockEntry:IntervalBlock Entry:ElectricPowerUs ageSummary links entry’s LocalTime Parameters Source: David Wollman, Martin Burns (NIST)
ESPI Usage Schema
DMD: Ontario Guidance Pertains to electricity customers that are covered by the Ontario Smart Meter Initiative and whose data are VEE’d through the IESO’s MDM/R o SeviceCategory::ServiceKind = 0 (electricity) o Data is delayed TOU information can only be expressed at the MeterReading level, and not at the IntervalBlock / IntervalReading level. o TOU information is optional o Two forms of XML may be constructed depending on the LDC. o ReadingType::tou field, 1=on-peak, 2=mid-peak, 3=off-peak Optional summary elements will not be present o ElectricPowerUsageSummary o ElectricPowerQualitySummary Temperature data MAY also be provided, as a separate MeterReading
Ontario DMD TOU File Composition Source: Green Button Download My Data – Ontario Guidance Document
Sample Data File – London Hydro UsagePoint MeterReading IntervalBlock IntervalReading LocalTimeParameters
DMD: Ontario Draft XSLT UsagePoint MeterReading IntervalBlock IntervalReading’s Rendered using XSLT file from: greenbuttondata.ca
TOU Sample – Multiple MeterReading’s
CMD: Leveraging DMD For Greater Opportunity 10 Data CustodianThird Party Web Service Provider Web Service Consumer Retail Customer Web Portal User (agent) Green Button Download My Data Green Button Connect My Data One-time Authorization Automated Transfer Source: David Wollman, Martin Burns (NIST)
Service Calls – Ontario Reference Architecture Registration o Register a third party application (generates client_id, client_secret) o Revoke a registered third party application (by Data Custodian) Authorization o Create Authorization / Create Access Token (generates access token) o Revoke Authorization (by Customer, Data Custodian, Third Party) o Modify Authorization (by Customer) Synchronous Data Access o Request Synchronous Pull of Data Asynchronous Data Access o Request Asynchronous Pull of Data o Create Subscription, Delete Subscription o Asynchronous Pull of Data (after notification – subscription or async read request) o Notification Administrative ReadServiceStatus ReadAuthorizationStatus
CMD Ontario Reference Architecture Security o SSL / TLS – all communications are encrypted o OAuth 2.0 – third party applications provisioned access and refresh tokens for each Customer authorization Web Service Endpoints o RESTful style - verb identified by HTTP method, resource identified by URI (opaque) o Data Custodian’s endpoints (and related URL’s) discoverable from central directory o Third Party Application’s endpoints discoverable from fields in ApplicationInformation element (specified during registration). o Calls to endpoints make use of HTTP method employed and particular parameters included in order to determine the action being requested. E.g. create new subscription -> POST request on the Data Custodian’s ”Subscription” endpoint deleting subscription -> HTTP DELETE method. o Customer’s Shared Resource (i.e. usage point) identified implicitly via the access token included in the HTTP Authorization header. o Data required by the operation may be included in the body of the HTTP request or as query parameters.
Mobile Applications – Ontario RA Typically unable to expose endpoints for Data Custodian originated service calls Restricted to Synchronous Data Access Registration and Authorization workflows currently presume / require a third party portal infrastructure Mobile app developers can use the Test Lab’s ATP simulator for this during the event OAuth 2.0 token refresh mechanism utilized Multiple devices sharing the same authorization (e.g. a Customer using the same application on their mobile phones, tablets) requires refreshed access tokens to be distributed to each device through a Third Party mechanism.
Ontario Architectural Overview – Why LDC centric? MDM/R Has EUI Customer Information System Web Portal Green Button Data GUI Web Interface RESTful Web Services Utility Enterprise Web Green Button Download My Data Green Button Connect My Data Edge Derived from: David Wollman, Martin Burns (NIST) IESO Edge
Useful Reference Materials / Resources ESPI UML model file (Enterprise Architect) – o 30 day trial version of EA is available from DMD Ontario Guidance Document o Available from Sample XML data files o Available from o XML data file generator spreadsheet e/SampleDataGenerator e/SampleDataGenerator Ontario Reference Architecture Document o Available from Dropbox link with data sets for hackathon: o Test-lab user manual o
Recommended Approach Develop “new and novel” concept Work with sample / generated XML to start o Create means to consume this standardized data in your application Add in CMD API service calls to gain automated and programmatic access to required data o Likely synchronous data reads only to start o Might leverage Test Lab WADL to auto-generate code stubs