-
Notifications
You must be signed in to change notification settings - Fork 0
/
TermsOfUse.html
791 lines (738 loc) · 33.5 KB
/
TermsOfUse.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
<!DOCTYPE html>
<html>
<head>
<title>Green Button Developer's Guide</title>
<meta charset='utf-8' />
<meta http-equiv="X-UA-Compatible" content="chrome=1" />
<meta name="description" content="Openespi-greenbuttondeveloper : A repository for the Green Button Connect My Data API Documentation" />
<script src="jquery-ui-1.10.3.custom/js/jquery-1.9.1.js"></script>
<script src="jquery-ui-1.10.3.custom/js/ui/jquery-ui.custom.js"></script>
<link rel="stylesheet" href="jquery-ui-1.10.3.custom/css/GB_2/jquery-ui.css" />
<link rel="stylesheet" href="resources/demos/style.css" />
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<script>
$(function() {
$( "#accordion" ).accordion({
collapsible: true,
active: false
});
});
</script>
<script>
$(function() {
var icons = {
header: "ui-icon-circle-arrow-e",
activeHeader: "ui-icon-circle-arrow-s"
};
$( "#accordion" ).accordion({
icons: icons
});
$( "#toggle" ).button().click(function() {
if ( $( "#accordion" ).accordion( "option", "icons" ) ) {
$( "#accordion" ).accordion( "option", "icons", null );
} else {
$( "#accordion" ).accordion( "option", "icons", icons );
}
});
});
</script>
<script>
$(function() {
$( "#accordion1" ).accordion({
collapsible: true,
active: false
});
});
</script>
<script>
$(function() {
var icons = {
header: "ui-icon-circle-arrow-e",
activeHeader: "ui-icon-circle-arrow-s"
};
$( "#accordion1" ).accordion({
icons: icons
});
$( "#toggle" ).button().click(function() {
if ( $( "#accordion1" ).accordion( "option", "icons" ) ) {
$( "#accordion1" ).accordion( "option", "icons", null );
} else {
$( "#accordion1" ).accordion( "option", "icons", icons );
}
});
});
</script>
<script>
$(function() {
$( "#accordion2" ).accordion({
collapsible: true,
active: false
});
});
</script>
<script>
$(function() {
var icons = {
header: "ui-icon-circle-arrow-e",
activeHeader: "ui-icon-circle-arrow-s"
};
$( "#accordion2" ).accordion({
icons: icons
});
$( "#toggle" ).button().click(function() {
if ( $( "#accordion2" ).accordion( "option", "icons" ) ) {
$( "#accordion2" ).accordion( "option", "icons", null );
} else {
$( "#accordion2" ).accordion( "option", "icons", icons );
}
});
});
</script>
<script>
$(function() {
$( "#accordion2_2" ).accordion({
collapsible: true,
active: false
});
});
</script>
<script>
$(function() {
var icons = {
header: "ui-icon-circle-arrow-e",
activeHeader: "ui-icon-circle-arrow-s"
};
$( "#accordion2_2" ).accordion({
icons: icons
});
$( "#toggle" ).button().click(function() {
if ( $( "#accordion2_2" ).accordion( "option", "icons" ) ) {
$( "#accordion2_2" ).accordion( "option", "icons", null );
} else {
$( "#accordion2_2" ).accordion( "option", "icons", icons );
}
});
});
</script>
<script>
$(function() {
$( "#accordion3" ).accordion({
collapsible: true,
active: false
});
});
</script>
<script>
$(function() {
var icons = {
header: "ui-icon-circle-arrow-e",
activeHeader: "ui-icon-circle-arrow-s"
};
$( "#accordion3" ).accordion({
icons: icons
});
$( "#toggle" ).button().click(function() {
if ( $( "#accordion3" ).accordion( "option", "icons" ) ) {
$( "#accordion3" ).accordion( "option", "icons", null );
} else {
$( "#accordion3" ).accordion( "option", "icons", icons );
}
});
});
</script>
<script>
$(function() {
$( "#accordion4" ).accordion({
collapsible: true,
active: false
});
});
</script>
<script>
$(function() {
var icons = {
header: "ui-icon-circle-arrow-e",
activeHeader: "ui-icon-circle-arrow-s"
};
$( "#accordion4" ).accordion({
icons: icons
});
$( "#toggle" ).button().click(function() {
if ( $( "#accordion4" ).accordion( "option", "icons" ) ) {
$( "#accordion4" ).accordion( "option", "icons", null );
} else {
$( "#accordion4" ).accordion( "option", "icons", icons );
}
});
});
</script>
<!-- menu stuff -->
<script>
$( "#menu" ).menu();
</script>
<style>
#nav li { width: auto; clear: none; }
</style>
<!-- end menu stuff -->
<script>
$(function() {
$( "#tabs" ).tabs();
});
</script>
</head>
<body>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/energyos/OpenESPI-GreenButtonDeveloper">View on GitHub</a>
<img style="float:left; width:48px; margin-top:0px; margin-right:20px; border:0px;"
src="images/GreenButton_only_64x64.png"/>
<h1 id="project_title">Green Button Developer's Guide</h1>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/energyos/OpenESPI-GreenButtonDeveloper/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/energyos/OpenESPI-GreenButtonDeveloper/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<div id="tabs">
<ul>
<li><a href="#tabs-1">Home</a></li>
<li><a href="#tabs-2">Concepts</a></li>
<li><a href="#tabs-3">Data Elements</a></li>
<li><a href="#tabs-4">Example Code</a></li>
<li><a href="#tabs-5">API Documentation</a></li>
<li><a href="#tabs-6">Support</a></li>
</ul>
<div id="tabs-1">
<h3>
<img style="float:left; width:24px; margin-top:0px; border:0px;" src="images/GreenButton_only_64x64.png"/>
<a name="welcome-to-green-button-developer" class="anchor" href="#welcome-to-github-pages"><span class="octicon octicon-link"></span></a>
Welcome to Green Button Developer</h3>
<p>The Green Button API provides flexible access to Energy Usage
Information through a set of RESTful interfaces. These APIs provide access to
Green Button resources.</p>
<p>Green Button uses the <a href="http://www.odata.org"><span style="color:blue;">Open Data(OData)</span></a>
standardized protocol for creating and consuming data APIs. OData
builds on core protocols like HTTP and commonly accepted methodologies
like REST. This results in a uniform way to expose full-featured data APIs.
Green Button utilizes OData and the ATOM Publishing standard
to encapsulate Energy Usage Information.</p>
<p>Green Button uses <a href="API">RESTful APIs</a> to provide
standard access to information for metered resources such as
electricity, gas, and water. These interfaces may be used to access and
manage the metered data by using atom+xml based streams of Energy
Usage Information (EUI) encapsulated within an Atom Feed. The tabs
above allow you to explore more deeply into the Green Button API by
reviewing example API calls.</p>
<h3>
<img style="float:left; width:24px; margin-top:0px; border:0px;" src="images/GreenButton_only_64x64.png"/>
<a name="designer-templates" class="anchor" href="#designer-templates"><span class="octicon octicon-link"></span></a>RetailCustomer, DataCustodian & ThirdParty Actors</h3>
<p>A bit of nomenclature:
<dl>
<dt>RetailCustomer</dt>
<dd>Any person or enterprise that is provided services such as
electricity, water, or gas from a resource service provider.
RetailCustomers may be residential, commercial, or industrial.</dd>
<dt>DataCustodian</dt>
<dd>Any enterprise that is holding metered data obtained during the
course of providing resources to a <em>RetailCustomer</em>. A <em>DataCustodian</em>
holds that data as part of the service they provide and may, with the authorization of the
RetailCustomer, allow that data to be shared with a third party.</dd>
<dt>ThirdParty</dt>
<dd>Any person or enterprise that is authorized to have access to metered data held by a <em>DataCustodian</em>. A <em>ThirdParty</em>, when authorized, may <em>subscribe</em> to a <em>RetailCustomer's</em> data and provide additional services as desired.</dd>
</dl>
</div>
<div id="tabs-2">
<p>Green Button uses the <a href="http://www.odata.org"><span style="color:blue;">Open Data (OData)</span></a> standardized protocol for creating and consuming data APIs. OData builds on core protocols
like HTTP and commonly accepted methodologies like REST. This results in a uniform way to expose full-featured data APIs. Green Button utilizes OData and the ATOM Publishing standard
to encapsulate Energy Usage Information.</p>
<div id="accordion2" class="accordion">
<h3>Atom Wrappers</h3>
<div>
<p>OData works by placing data within the <em><entry></em> tags of the Atom stream. Data records are placed within the <em><content></em> tags, and relationships between tables are represented in the <em>≶link></em>tags. For example:</p>
OData.org will provide you with part of the background you need. It describes the usage of the Atom entities, in particular <entry>, <link> and <contents>.The second thing to note is that an Atom <feed> <entry> .... <contents> <espi entity> </contents></entry></feed>.
So all the espiDerived.xsd entities are always contained in a feed and the entry/contents describe the espi entity itself. In addtion, you need to construct (during the parse if possible for you:) the associations that need to exist between the espi entities. For example, the:
<pre>
<link rel="self" href="...." />
and
<link rel="related" href="...." />
</pre>
<lin
are quite important for use during fixup of the espi entities,
(making sure MeterReadings always point to a UsagePoint for example).
So re: espi objects, you need to think of the feed as a collection of n <entry> ... </entry> entities, each of which you might use to create a espi entity.
hth
jt
<pre><code>
<feed xmlns="http://www.w3.org/2005/Atom"
xsi:schemaLocation="http://naesb.org/espi espiDerived.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>urn:uuid:728B5594-414E-471A-A230-08FCCDAC655C</id>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
<title>ThirdPartyX Batch Feed</title>
<updated>2012-10-24T00:00:00Z</updated>
<link rel="self" href="/ThirdParty/83e269c1/Batch"/>
<entry>
<id>urn:uuid:97EAEBAD-1214-4A58-A3D4-A16A6DE718E1</id>
<link rel="self"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01"/>
<link rel="up"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint"/>
<link rel="related"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01/MeterReading"/>
<link rel="related"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01/ElectricPowerUsageSummary"/>
<link rel="related"
href="/espi/1_1/resource/UsagePoint/01/LocalTimeParameters/01"/>
<title>my house</title>
<content>
<UsagePoint xmlns="http://naesb.org/espi">
<ServiceCategory>
<kind>0</kind>
</ServiceCategory>
</UsagePoint>
</content>
</entry>
</feed>
</code></pre>
</div>
<h3>Relationships</h3>
<div>
<p>OData uses the atom <link> tag to reflect relationships within data. For example, if I have a data base table with a column that contains a index key to an additional table, then I would use the </p><link%gt; tag to represent that association.
</p><p>
This allows (normally hierarchic) XML representations to contain pointers. Additionally, OData uses the atom ≶entry> tag to represent the a data base row. The actual data table is generally refered to through the <type> entitiy or within the <content> tag.
</p><p>
An atom <feed> is then the container that is used to contain these entries.
<pre><code>
==========================================================================================
re: <link> ... </link>
that allows the relationships (of UsagePoint to MeterReading for example) to be represented in the XML. it is an alternative to the normal hierarchical structure in XML, such as:
===
<UsagePoint>
<link rel="self" href="/espi/RetailCustomer/{RetailCustomerID/UsagePoint/{UsagePointID}" />
<MeterReading>
<IntervalBlock>
...
</IntervalBlock>
...
</MeterReading>
...
</UsagePoint>
===
Rather, the odata representation uses the <link> tag to represent the relationships. so an equivalent representation would be:
===
<entry>
<link rel="self" href="/espi/RetailCustomer/{RetailCustomerID/UsagePoint/{UsagePointID}/MeterReading/{MeterReadingID}" />
<link rel="related" href="/espi/RetailCustomer/{RetailCustomerID/UsagePoint/{UsagePointID}" />
<content>
<MeterReading>
...
</MeterReading>
</content>
</entry>
<entry>
...
<link rel="self"
href="/espi/RetailCustomer/{RetailCustomerID/UsagePoint/{UsagePointID}/MeterReading/{MeterReadingID}/IntervalBlock/{IntervalBlockID}" />
<link rel="related" href="/espi/RetailCustomer/{RetailCustomerID/UsagePoint/{UsagePointID}/MeterReading/{MeterReadingID}" />
<content>
<IntervalBlock>
...
</IntervalBlock>
</content>
</entry>
...
===
</code></pre>
</p>
</div>
<h3>Atom Containers</h3>
<div>
<p>Each of the atom entities is used to describe portions of the Green Button data structure. For example, the ≶title> contains the <em>description</em> of the Green Button entity. The <id> contains the entities <em>UUID</em>. The following gives an overview of each related tag:</p>
<div id="accordion2_2">
<h3>feed</h3>
<div>
<p>description</p>
<p>The <description> is used to provide a human readable discription of the feed. An example might be:</p>
<pre><code>
<description>Bulk Transfer of Energy Usage Information: mm/dd/yyyy 02:22:03 ...</description>
</code>
</pre>
</div>
<h3>id</h3>
<div>
<p>description</p>
</div>
<h3>link</h3>
<div>
<p>description</p>
</div>
<h3>title</h3>
<div>
<p>description</p>
</div>
<h3>entry</h3>
<div>
<p>description</p>
</div>
</div>
</div>
<h3>Example</h3>
<div>
<p>description</p>
<pre><code>
<feed xmlns="http://www.w3.org/2005/Atom"
xsi:schemaLocation="http://naesb.org/espi espiDerived.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>urn:uuid:728B5594-414E-471A-A230-08FCCDAC655C</id>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
<title>ThirdPartyX Batch Feed</title>
<updated>2012-10-24T00:00:00Z</updated>
<link rel="self" href="/ThirdParty/83e269c1/Batch"/>
<entry>
<id>urn:uuid:97EAEBAD-1214-4A58-A3D4-A16A6DE718E1</id>
<link rel="self"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01"/>
<link rel="up"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint"/>
<link rel="related"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01/MeterReading"/>
<link rel="related"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01/ElectricPowerUsageSummary"/>
<link rel="related"
href="/espi/1_1/resource/UsagePoint/01/LocalTimeParameters/01"/>
<title>my house</title>
<content>
<UsagePoint xmlns="http://naesb.org/espi">
<ServiceCategory>
<kind>0</kind>
</ServiceCategory>
</UsagePoint>
</content>
</entry>
</feed>
</code></pre>
</div>
</div>
</div>
<div id="tabs-3">
<p>A <em>DataCustodian</em> will, when authorized by a <em>RetailCustomer</em>, publish a GreenButton data stream. A <em>ThirdParty</em> may then subscribe to that stream. Green Button uses the <a href="http://www.odata.org"><span style="color:blue;">Open Data Protocol (OData)</span></a> standard to serialize the data and the <a href="http://oauth.net/"><span style="color:blue;">OAuth 2.0 Authorization Framework</span></a> protocol to provide secure authorization for accessing the published data stream.
<div id="accordion1">
<!--
<h3>Subscription</h3>
<div>
<p></p>
<pre><code><Subscription>
<\Subscription>
</code></pre>
</div>
-->
<h3>Authorization</h3>
<div>
<p></p>
<pre><code><entry>
<id>urn:uuid:97EAEBAD-1214-4A58-A3D4-A16A6DE718E1</id>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
<link rel="self"
href="/espi/1_1/resource/Authorization/01"/>
<link rel="up"
href="/espi/1_1/resource/Authorization"/>
<title>An Authorization to exchange data</title>
<content>
<Authorization xmlns="http://naesb.org/espi">
<kind>0</kind>
</Authorization>
</content>
</entry>
</code></pre>
</div>
<h3>ApplicationInformation</h3>
<div>
<p></p>
<pre><code><entry>
<id>urn:uuid:97EAEBAD-1214-4A58-A3D4-A16A6DE718E1</id>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
<link rel="self"
href="/espi/1_1/resource/ApplicationInformation/01"/>
<link rel="up"
href="/espi/1_1/resource/ApplicationInformation"/>
<title>ApplicationInformation Describing a DataCustodian and ThirdParty relationship</title>
<content>
<ApplicationInformation xmlns="http://naesb.org/espi">
<kind>0</kind>
</ApplicationInformation>
</content>
</entry>
</code></pre>
</div>
</div>
<p>Green Button APIs are designed to support data flows that are both large and small. Many Utilities will schedule bulk transfers of hundreds of thousands of 24 hour data as a batch process. In this case, the Green Button APIs must be able to accomodate blocked transfers, recovery, and restarts. Other use-cases are more driven by frequent transmissions of smaller data sets, for example the hourly usage of a single outlet in your home. Green Button is designed to handle both!</p>
<h3>
<img style="float:left; width:24px; margin-top:0px; border:0px;" src="images/GreenButton_only_64x64.png"/>
<span class="octicon octicon-link"></span></a>Green Button Data Elements</h3>
<div id="accordion">
<h3>UsagePoint</h3>
<div>
<p>A <em>UsagePoint</em> is where a resource is measured. Typically, it is your Utility Smart Meter, but it could be the outlet on the wall as well. UsagePoints provide the reference for all meter readings that are contained within the Green Button data. UsagePoints have a <em>ServiceCategory</em> that defines what <em>kind</em> of resource, such as electricity, gas, or water measurement is being reported. </p>
<pre><code><entry>
<id>urn:uuid:97EAEBAD-1214-4A58-A3D4-A16A6DE718E1</id>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
<link rel="self"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01"/>
<link rel="up"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint"/>
<link rel="related"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01/MeterReading"/>
<link rel="related"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01/ElectricPowerUsageSummary"/>
<link rel="related"
href="/espi/1_1/resource/UsagePoint/01/LocalTimeParameters/01"/>
<title>my house</title>
<content>
<UsagePoint xmlns="http://naesb.org/espi">
<ServiceCategory>
<kind>0</kind>
</ServiceCategory>
</UsagePoint>
</content>
</entry>
</code></pre>
</div>
<h3>ReadingType</h3>
<div>
<p>A <em>ReadingType</em> provides detail as to the specifics of the reading data that is being obtained. Green Button follows international standards and has the ability to represent large industrial resources as well as those used in a residence.</p>
<pre><code><entry>
<id>urn:uuid:97EAEBAD-1214-4A58-A3D4-A16A6DE718E1</id>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
<link rel="self"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/ReadingType/01"/>
<link rel="up"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/ReadingType"/>
<link rel="related"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01/MeterReading"/>
<title>my house</title>
<content>
<ReadingType xmlns="http://naesb.org/espi">
<accumulationBehaviour>4</accumulationBehaviour>
<commodity>1</commodity>
<currency>840</currency>
<dataQualifier>12</dataQualifier>
<flowDirection>1</flowDirection>
<intervalLength>86400</intervalLength>
<kind>12</kind>
<phase>769</phase>
<powerOfTenMultiplier>0</powerOfTenMultiplier>
<timeAttribute>0</timeAttribute>
<uom>72</uom>
</ReadingType>
</content>
</entry>
</code></pre>
</div>
<h3>MeterReading</h3>
<div>
<p>A MeterReading is a container for all of the measured <em>IntervalBlocks</em> within the Green Button data captured at a <em>UsagePoint</em>.</p>
<pre><code><MeterReading>
<\MeterReading>
</code></pre>
</div>
<h3>IntervalBlock</h3>
<div>
<p><em>IntervalBlock</em>s are the primary data carrier within the Green Button data. IntervalBlocks may have one or more Intervals, each with a start and duration, as well as the specific <em>IntervalReading</em></p>
<pre><code><entry>
<id>urn:uuid:97EAEBAD-1214-4A58-A3D4-A16A6DE718E1</id>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
<link rel="self"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/IntervalBlock/01"/>
<link rel="up"
href="/espi/1_1/resource/RetailCustomer/9b6c7063IntervalBlock"/>
<link rel="related"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01/MeterReading/01"/>
<title>my house</title>
<content>
<IntervalBlock xmlns="http://naesb.org/espi">
<interval>
<duration>86400</duration>
<start>1330578000</start>
<!-- start date: 3/1/2012 5:00:00 AM -->
</interval>
<IntervalReading>
<cost>539919</cost>
<timePeriod>
<duration>86400</duration>
<start>1330578000</start>
<!-- 3/1/2012 5:00:00 AM -->
</timePeriod>
<value>57751</value>
</IntervalReading>
</IntervalBlock>
</content>
</entry>
</code></pre>
</div>
<h3>LocalTimeParameters</h3>
<div>
<p>The <em>LocalTimeParameters</em> provide a flexible manner to enable <em>Energy Usage Information (EUI)</em> to be provided with a reference to local time, without including any <em>Personal Identifiable Information</em>. </p>
<pre><code><entry>
<id>urn:uuid:97EAEBAD-1214-4A58-A3D4-A16A6DE718E1</id>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
<link rel="self"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/LocalTimeParameters/01"/>
<link rel="up"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/LocalTimeParameters"/>
<link rel="related"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/UsagePoint/01"/>
<title>my house</title>
<content>
<LocalTimeParameters xmlns="http://naesb.org/espi">
<dstEndRule>B40E2000</dstEndRule>
<dstOffset>3600</dstOffset>
<dstStartRule>360E2000</dstStartRule>
<tzOffset>-18000</tzOffset>
</LocalTimeParameters>
</content>
</entry>
</code></pre>
</div>
<h3>ElectricPowerUsageSummary</h3>
<div>
<p></p>
<pre><code><entry>
<id>urn:uuid:97EAEBAD-1214-4A58-A3D4-A16A6DE718E1</id>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
<link rel="self"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/ElectricPowerUsageSummary/01"/>
<link rel="up"
href="/espi/1_1/resource/RetailCustomer/9b6c7063/ElectricPowerUsageSummary"/>
<title>my house</title>
<content>
<ElectricPowerUsageSummary xmlns="http://naesb.org/espi">
<billingPeriod>
<duration>2588400</duration>
<start>1330578000</start>
</billingPeriod>
<billLastPeriod>20810000</billLastPeriod>
<billToDate>8145000</billToDate>
<costAdditionalLastPeriod>4525000</costAdditionalLastPeriod>
<currency>840</currency>
<overallConsumptionLastPeriod>
<powerOfTenMultiplier>0</powerOfTenMultiplier>
<uom>72</uom>
<value>1951364</value>
</overallConsumptionLastPeriod>
<currentBillingPeriodOverAllConsumption>
<powerOfTenMultiplier>0</powerOfTenMultiplier>
<timeStamp>1334462400</timeStamp>
<uom>72</uom>
<value>1006640</value>
</currentBillingPeriodOverAllConsumption>
<qualityOfReading>14</qualityOfReading>
<statusTimeStamp>1334462400</statusTimeStamp>
</ElectricPowerUsageSummary>
</content>
</entry>
</code></pre>
</div>
<h3>ElectricPowerQualitySummary</h3>
<div>
<p></p>
<pre><code> <entry>
<id>urn:uuid:DEB0A337-C1B5-4658-99BA-4688E253A99B</id>
<link rel="self" href="RetailCustomer/9b6c7063/ElectricPowerQualitySummary/01"/>
<link rel="up" type="" href="RetailCustomer/9b6c7063/UsagePoint/01/ElectricPowerQualitySummary"/>
<title>Quality Summary</title>
<content>
<ElectricPowerQualitySummary xmlns="http://naesb.org/espi">
<flickerPlt>1</flickerPlt>
<flickerPst>2</flickerPst>
<harmonicVoltage>3</harmonicVoltage>
<longInterruptions>4</longInterruptions>
<mainsVoltage>5</mainsVoltage>
<measurementProtocol>6</measurementProtocol>
<powerFrequency>7</powerFrequency>
<rapidVoltageChanges>8</rapidVoltageChanges>
<shortInterruptions>9</shortInterruptions>
<summaryInterval>
<duration>2119600</duration>
<start>2330578000</start>
</summaryInterval>
<supplyVoltageDips>10</supplyVoltageDips>
<supplyVoltageImbalance>11</supplyVoltageImbalance>
<supplyVoltageVariations>12</supplyVoltageVariations>
<tempOvervoltage>13</tempOvervoltage>
</ElectricPowerQualitySummary>
</content>
<published>2012-10-24T00:00:00Z</published>
<updated>2012-10-24T00:00:00Z</updated>
</entry>
</code></pre>
</div>
</div>
</div>
<div id="tabs-4">
<p>Green Button comes in two flavors:
<dl>
<dt>Download My Data</dt>
<dd>A RetailCustomer may download an XML file from either a Data Custodian or a Third Party. Restful interfaces are provided to enable this operation. There are no assumptions made with respect to what the RetailCustomer might do with this XML file, although best practices would be to insure the file is viewable by using a minimal stylesheet.</dd>
<dt>Connect My Data</dt>
<dd>The RetailCustomer may also authorize Green Button data to move between two machines, such as from their utility to a company that might use the data to estimate the energy efficiency of their facility. In this case, <em>Connect My Data</em> would be used to provide machine-2-machine data transfers. Connect My Data may provide a single transfer of information, or transfers on a predefined schedule.</dd>
</dl>
The simple message flows associated with each are described below:
</p>
<div id="accordion4">
<h3>Download My Data Examples</h3>
<div>
</div>
<h3>Connect My Data Examples</h3>
<div>
</div>
</div>
</div>
<div id="tabs-5">
<h3>
<img style="float:left; width:24px; margin-top:0px; border:0px;" src="images/GreenButton_only_64x64.png"/>
<a name="designer-templates" class="anchor" href="#designer-templates"><span class="octicon octicon-link"></span></a>Green Button APIs</h3>
<p>Green Button services are provided through a set of <a href="API"><span style="color:blue;">Application Programming Interfaces (APIs)</span></a> that enable you to publish metered data as well as subscribe to data streams from meters maintained by your Utility.</p>
</div>
<div id="tabs-6">
<h3>
<img style="float:left; width:24px; margin-top:0px; border:0px;" src="images/GreenButton_only_64x64.png"/>
<a name="authors-and-contributors" class="anchor" href="#authors-and-contributors"><span class="octicon octicon-link"></span></a>Further Information</h3>
<p></p>
<h3>
<img style="float:left; width:24px; margin-top:0px; border:0px;" src="images/GreenButton_only_64x64.png"/>
<a name="support-or-contact" class="anchor" href="#support-or-contact"><span class="octicon octicon-link"></span></a>Support or Contact</h3>
<p>Having trouble with Green Button? Check out the documentation at <a href="http://help.github.com/pages">http://help.github.com/pages</a> or contact <a href="mailto:[email protected]">[email protected]</a> and we’ll help you sort it out.</p>
</div>
</div>
</section>
</div>
<script type="text/javascript" src="http://commonterms.net/Scripts/common.js"/>
<script type="text/javascript">$(document).ready(initlightbox);</script>
<link rel="stylesheet" type="text/css"
href="http://commonterms.net/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
<a href="http://commonterms.net/generator/gener8.aspx?my=price_1/free_for_personal_use,price_1/future_changes_possible_for_commercial_use,notification_of_price_change/will_be_communicated_to_user,notification_of_price_change/written_notice_30_days_prior,cancellation/by_visiting_specified_webpage,provider_can_terminate_service/any_circumstances,change_of_terms/commercially_reasonable_changes_allowed,change_of_terms/at_providers_discretion,notification_of_changed_terms/provider_will_try_to_notify_user,jurisdiction/exception_for_us_government_entities,reuse_of_content/cc-by-sa,reuse_of_content/attribution_and_date_required,ownership/license_to_use,ownership/user_owns,ownership_of_user_generated_content/provider_and_affiliates_get_unlimited_licence,ownership_of_user_generated_content/user_keeps_ownership,ownership_of_user_generated_content/provider_gets_limited_licence,personal_data_can_be_published/yes,censorship/provider_can_censor_content,safety/cannot_be_guaranteed,personal_data__access_by_provider/for_investigations,personal_data__access_by_provider/according_to_privacy_policy,personal_data__access_by_provider/for_support_issues,what_data_will_be_recorded/any_data_provided_by_user,personal_data_can_be_given_to_authorities/if_required_by_legal_process,accetable_use/according_to_currently_applicable_terms_of_use,accetable_use/applicable_law,warranty/according_to_sla,warranty/as_is,warranty/nothing_outside_of_this_agreement,complies_with/trust-e_requirements&full=http%3A%2F%2Fenergyos.github.io%2FOpenESPI-GreenButton-API-Documentation%2FTermsOfUse.html&fullpp=&fulltoc=&nameofsite=EnergyOS%20Green%20Button%20Services"
target="_blank" id="CommonTermsPreviewLink" onclick="" title="CommonTerms preview">
<img src="http://commonterms.net/images/commonterms_button_02.png" title="Click to view a one-screen CommonTerms summary of our Terms & Conditions"
style="width:150px;" border="0" alt="Preview Terms" /></a>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<br /> <br />
<p class="copyright" style="float:right">OpenESPI Green Button Developer is maintained by <a href="https://www.energyos.org/">EnergyOS.org</a></p>
<p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>