-
Notifications
You must be signed in to change notification settings - Fork 1
/
enlighten.yaml
1785 lines (1767 loc) · 62.5 KB
/
enlighten.yaml
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
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: The Enlighten Systems API
description: |-
The Enlighten Systems API is a JSON-based API that provides access to performance data for a PV system. By using the Enlighten Systems API, you agree to the Enphase Energy API License Agreement.
Please note that the Enlighten Systems API does not provide performance data at a panel or microinverter level.
version: '2.0'
termsOfService: https://developer.enphase.com/docs#Display-Requirements
license:
name: Enphase API License Agreement
url: https://www.enphase.com/en-us/legal/api-license-agreement
servers:
- url: 'https://api.enphaseenergy.com/api/v2'
paths:
'/systems/{system_id}/energy_lifetime':
get:
description: |-
Returns a time series of energy produced on the system over its lifetime. All measurements are in Watt-hours.
The time series includes one entry for each day from the `start_date` to the `end_date`. There are no gaps in the time series. If the response includes trailing zeroes, such as
`[909, 4970, 0, 0, 0]`, then no energy has been reported for the last days in the series. You can check the system's status in the `meta` attribute of the response to determine when the
system last reported and whether it has communication or production problems.
If the system has a meter, the time series includes data as measured by the microinverters until the first full day after the meter has been installed, when it switches to using the data as
measured by the meter. This is called the "merged time series". In addition, the response includes the attribute `meter_start_date`, to indicate where in the time series the meter
measurements begin to be used. You can retrieve the complete time series from the meter and from the microinverters by adding the parameter `production=all` to the request.
operationId: EnergyLifetime
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_date
description: The date on which to start the time series. Defaults to the system's operational date.
in: query
schema:
type: string
format: date
example: '2013-01-01'
- name: end_date
description: The last date to include in the time series. Defaults to yesterday or the last day the system reported, whichever is earlier.
in: query
schema:
type: string
format: date
example: '2013-01-06'
- name: production
description: When `all`, returns the merged time series plus the time series as reported by the microinverters and the meter on the system. Other values are ignored.
in: query
schema:
type: string
enum:
- all
example: all
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EnergyLifetimeResponse'
'204':
description: No Content
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/envoys':
get:
description: Returns a listing of all active Envoys currently deployed on the system.
operationId: Envoys
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EnvoysResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems':
get:
description: |-
Returns a list of systems for which the user can make API requests. There is a limit to the number of systems that can be returned at one time. If the first request does not return a full
list, use the `next` attribute in the response body to request the next page of systems. By default, systems are returned in batches of 100. The maximum page size is 1000.
operationId: Systems
parameters:
- $ref: '#/components/parameters/UserId'
- name: next
in: query
schema:
type: string
example: 4d5467784d5445770a
- name: limit
in: query
schema:
type: integer
default: 100
maximum: 1000
example: 100
- name: system_id
in: query
schema:
type: integer
example: 67
- name: 'system_id[]'
in: query
schema:
type: array
items:
type: integer
example:
- 67
- name: system_name
in: query
schema:
type: string
example: Green
- name: 'system_name[]'
in: query
schema:
type: array
items:
type: string
example:
- Green
- name: status
in: query
schema:
$ref: '#/components/schemas/Status'
example: power
- name: 'status[]'
in: query
schema:
type: array
items:
$ref: '#/components/schemas/Status'
example:
- comm
- micro
- name: reference
in: query
schema:
type: string
- name: 'reference[]'
in: query
schema:
type: array
items:
type: string
- name: installer
in: query
schema:
type: string
- name: 'installer[]'
in: query
schema:
type: array
items:
type: string
- name: connection_type
in: query
schema:
$ref: '#/components/schemas/ConnectionType'
- name: 'connection_type[]'
in: query
schema:
type: array
items:
$ref: '#/components/schemas/ConnectionType'
example:
- ethernet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SystemsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/inventory':
get:
description: |-
Returns a listing of active devices on the given system. A device is considered active if it has not been retired in Enlighten. "Active" does not imply that the device is currently
reporting, producing, or measuring energy.
operationId: Inventory
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/inverters_summary_by_envoy_or_site':
get:
description: Returns the summary along with the energy produced on the system over its lifetime.
operationId: InvertersSummaryByEnvoyOrSite
parameters:
- $ref: '#/components/parameters/UserId'
- name: site_id
description: The identifier of the system.
in: query
required: true
schema:
type: integer
example: 66
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InvertersSummaryByEnvoyOrSiteResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/monthly_production':
get:
deprecated: true
description: |-
This endpoint is deprecated and will be removed in a future release. Use `production_meter_readings` or `energy_lifetime` instead.
Returns the energy production of the system for the month starting on the given date. The start date must be at least one month ago. If a meter or meters are installed on the system,
measurements come from the meter; otherwise, measurements come from the microinverters.
This endpoint can return a response of Data Temporarily Unavailable.
operationId: MonthlyProduction
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_date
description: |-
Start date for reporting period. The reporting period ends on the previous day of the next month; for example, a `start_date` of 2011-07-20 returns data through 2011-06-19. When the
start date is the first of a calendar month, the end date is the last day of that month.
in: query
required: true
schema:
type: string
format: date
example: '2011-07-01'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MonthlyProductionResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/production_meter_readings':
get:
description: |-
Returns the last known "odometer" reading of each revenue-grade production meter on the system as of the requested time.
This endpoint includes entries for every production meter on the requested system, regardless of whether the meter is currently in service or retired. `read_at` is the time at which the
reading was taken, and is always less than or equal to the requested `end_at`. Commonly, the reading will be within 30 minutes of the requested `end_at`; however, larger deltas can occur and
do not necessarily mean there is a problem with the meter or the system it is on. Systems that are configured to report infrequently can show large deltas on all meters, especially when
`end_at` is close to the current time. Meters that have been retired from a system will show an `end_at` that doesn't change, and that eventually is far away from the current time.
operationId: ProductionMeterReadings
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: end_at
in: query
schema:
type: integer
format: int64
example: 1473901755
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProductionMeterReadingsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/rgm_stats':
get:
description: |-
Returns performance statistics as measured by the revenue-grade meters installed on the specified system. If the total duration requested is more than one month, returns one month of
intervals. Intervals are 15 minutes in length and start at the top of the hour.
Requests for times that do not fall on the 15-minute marks are rounded down. For example, a request for 08:01, 08:08, 08:11, or 08:14 is treated as a request for 08:00. Intervals are listed
by their end dates; therefore, the first interval returned is 15 minutes after the requested start date.
If the system doesn't have any revenue-grade meters installed, the response includes an empty intervals array.
Under some conditions, data for a given period may be temporarily unavailable.
operationId: RgmStats
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_at
description: |-
Start of period to report on in Unix epoch time. If no start is specified, the assumed start is midnight today, in the timezone of the system. If the start is earlier than one year ago,
the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the first interval of the `operational_date`.
in: query
schema:
type: integer
format: int64
example: 1381474800
- name: end_at
description: |-
End of reporting period in Unix epoch time. If no end is specified, defaults to the time of the request. If the end is later than the last reported interval the response data ends with
the last reported interval.
in: query
schema:
type: integer
format: int64
example: 1381561200
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RgmStatsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/stats':
get:
description: |-
Returns performance statistics for the specified system as reported by microinverters installed on the system. If the total duration requested is more than one day, returns one day of
intervals. Intervals are 5 minutes in length and start at the top of the hour.
Requests for times that do not fall on the 5-minute marks are rounded down. For example, a request for 08:01, 08:02, 08:03, or 08:04 is treated as a request for 08:00. Intervals are listed
by their end dates; therefore, the first interval returned is 5 minutes after the requested start date.
The response includes intervals that have been reported for the requested period. Gaps in reporting are not filled with 0-value intervals. The dark hours on a system are an example of such a
gap, because the microinverters do not produce at night.
Sometimes a request cannot be processed because the requested dates are invalid for the system in question. Examples include asking for stats starting at a time that is later than the
system's last reported interval, or asking for stats before a system has started production. In cases such as these, the response code is `422` and the response body includes an error reason
as well as the parameters used to process the request.
If the system doesn't have any microinverters installed, the response includes an empty intervals array. Under some conditions, data for a given period may be temporarily unavailable.
operationId: Stats
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_at
description: |-
Start of reporting period in Unix epoch time. If no start is specified, defaults to midnight today, in the timezone of the system. If the start date is earlier than one year ago today,
the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the `operational_date`.
in: query
schema:
type: integer
format: int64
example: 1381496100
- name: end_at
description: |-
End of reporting period in Unix epoch time. If no end is specified, the assumed end is now. If the end is later than the last reporting interval the response data ends with the last
reported interval.
in: query
schema:
type: integer
format: int64
example: 1381497600
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StatsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/consumption_lifetime':
get:
description: |-
Returns a time series of energy consumption as measured by the consumption meter installed on the specified system. All measurements are in Watt-hours. If the system does not have a meter,
returns `204` - No Content. If you don't have permission to view consumption data, the response code is `401`.
The time series includes one entry for each day from the `start_date` to the `end_date`. There are no gaps in the time series. If the response includes trailing zeroes, such as
[909, 4970, 0, 0, 0], then no data has been reported for the last days in the series. You can check the system's status in the `meta` attribute of the response to determine when the system
last reported and whether it has communication or metering problems.
operationId: ConsumptionLifetime
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_date
description: The date on which to start the time series. Defaults to the system's operational date.
in: query
schema:
type: string
format: date
example: '2016-07-01'
- name: end_date
description: The last date to include in the time series. Defaults to yesterday or the last day the system reported, whichever is earlier.
in: query
schema:
type: string
format: date
example: '2016-07-31'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumptionLifetimeResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/consumption_stats':
get:
description: |-
Returns consumption as measured by the consumption meter installed on the specified system. If the total duration requested is more than one month, returns one month of intervals. Intervals
are 15 minutes in length and start at the top of the hour.
Requests for times that do not fall on the 15-minute marks are rounded down. For example, a request for 08:01, 08:08, 08:11, or 08:14 is treated as a request for 08:00. Intervals are listed
by their end dates; therefore, the first interval returned is 15 minutes after the requested start date.
If the system doesn't have any consumption meters installed, the response includes an empty intervals array.
If you don't have permission to view consumption data, the response code is `401`.
Under some conditions, data for a given period may be temporarily unavailable.
operationId: ConsumptionStats
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_at
description: |-
Start of period to report on in Unix epoch time. If no start is specified, the assumed start is midnight today, in the timezone of the system. If the start is earlier than one year ago,
the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the first interval of the `operational_date`.
in: query
schema:
type: integer
format: int64
example: 1448946000
- name: end_at
description: |-
End of reporting period in Unix epoch time. If no end is specified, defaults to the time of the request. If the end is later than the last reported interval the response data ends with
the last reported interval.
in: query
schema:
type: integer
format: int64
example: 1449011615
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumptionStatsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/summary':
get:
description: Returns summary information for the specified system.
operationId: Summary
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: summary_date
description: |-
Start of reporting period. If no `summary_date` is provided, the start is the current day at midnight site-local time. Otherwise, the start is midnight site-local time of the requested
day. If the requested date cannot be parsed or is in the future, the response includes an informative error message and `422` status.
in: query
schema:
type: string
format: date
example: '2010-09-17'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SummaryResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/search_system_id':
get:
description: Get system ID by envoy serial number.
operationId: SearchSystemId
parameters:
- $ref: '#/components/parameters/UserId'
- name: serial_num
description: Serial number of the envoy.
in: query
required: true
schema:
type: string
example: '23435345345'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SearchSystemIdResponse'
'401':
$ref: '#/components/responses/ClientError'
'404':
$ref: '#/components/responses/NotFoundError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
components:
schemas:
EnergyLifetimeResponse:
type: object
properties:
start_date:
description: |-
When no `start_date` parameter is specified on the request, this is the `operational_date` of the system. May be null if system has never produced. When a `start_date`
parameter is included in the request, it is included here in the response.
type: string
format: date
system_id:
description: The identifier of the system.
type: integer
production:
description: |-
An array of production measurements, one for each day since the system started producing, or one for each day of the requested period. If the system has never produced energy,
the array may be empty.
type: array
items:
type: integer
micro_production:
type: array
items:
type: integer
meter_production:
type: array
items:
type: integer
meter_start_date:
description: The first day in the time series when measurements are taken from a meter instead of from microinverters. This field is not present unless the system has a meter.
type: string
format: date
meta:
$ref: '#/components/schemas/Meta'
required:
- start_date
- system_id
- production
- meta
example:
start_date: '2013-01-01'
system_id: 66
production:
- 15422
- 15421
- 17118
- 18505
- 18511
- 18487
meter_start_date: '2013-02-15'
meta:
status: normal
last_report_at: 1445619615
last_energy_at: 1445619033
operational_at: 1357023600
EnvoysResponse:
type: object
properties:
system_id:
description: The identifier of the system.
type: integer
envoys:
description: A list of active Envoys on this system.
type: array
items:
type: object
properties:
envoy_id:
description: The Enlighten ID of the Envoy.
type: integer
last_report_at:
description: |-
The last time this Envoy submitted a report, by default expressed in Unix epoch time. When the `datetime_format` query parameter is `iso8601`, `last_report_at` is in
ISO 8601 format. If Enlighten has no record of a report from this Envoy, returns null.
type: integer
format: int64
name:
description: The human-friendly name of this Envoy.
type: string
part_number:
description: The Enphase part number of this Envoy.
type: string
serial_number:
description: The serial number of this Envoy.
type: string
status:
description: |-
The current status of this Envoy.
* `normal` - The Envoy is operating normally.
* `comm` - The Envoy is not communicating to Enlighten.
type: string
enum:
- normal
- comm
required:
- envoy_id
- last_report_at
- name
- part_number
- serial_number
- status
required:
- system_id
- envoys
example:
system_id: 67
envoys:
- envoy_id: 512
last_report_at: 1308008107
name: Envoy 010731000003
part_number: 800-00002-r00
serial_number: '010731000003'
status: normal
- envoy_id: 841
last_report_at: null
name: Envoy 010814000001
part_number: 910-10000-r01
serial_number: '010814000001'
status: normal
SystemsResponse:
type: object
properties:
systems:
type: array
items:
type: object
properties:
system_id:
description: The Enlighten ID of the system.
type: integer
system_name:
description: |-
The name of the system. Even if the system owner has indicated their site is anonymous for public lists, the actual system name is returned here for identification
purposes.
type: string
system_public_name:
description: The display name of the system. Use this when displaying the system name on a public list or view.
type: string
reference:
description: |-
If the calling user belongs to a company and that company has provided its own identifiers for a system, that ID is included here. Otherwise, this attribute is not
returned.
type: string
other_references:
description: If any other companies have provided their own identifiers for a system, those identifiers are included here. Otherwise, this attribute is not returned.
type: array
items:
type: string
country:
description: The two-letter code for the country where the system is located. See [ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for reference.
type: string
minLength: 2
maxLength: 2
state:
description: The two-letter code for the state where the system is located. See [ISO_3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) for reference.
type: string
minLength: 2
city:
description: The name of the city where the system is located.
type: string
postal_code:
description: The postal code where the system is located.
type: string
timezone:
description: The timezone of the system.
type: string
connection_type:
$ref: '#/components/schemas/ConnectionType'
status:
deprecated: true
description: The current status of the system. You can find this and more in the `meta` property.
type: string
enum:
- comm
- power
- meter
- meter_issue
- micro
- battery
- storage_idle
- normal
meta:
$ref: '#/components/schemas/Meta'
required:
- system_id
- system_name
- system_public_name
- status
- timezone
- country
- state
- city
- postal_code
- connection_type
- meta
next:
type: string
required:
- systems
example:
systems:
- system_id: 67
system_name: Sample Residence 1
system_public_name: Sample Residence 1
status: normal
timezone: America/Los_Angeles
country: US
state: CA
city: Sebastopol
postal_code: '95472'
connection_type: ethernet
meta:
status: normal
last_report_at: 1445619615
last_energy_at: 1445619033
operational_at: 1357023600
- system_id: 72
system_name: Sample Residence 2
system_public_name: Sample Residence 2
status: normal
timezone: America/Los_Angeles
country: US
state: CA
city: Placerville
postal_code: '95667'
connection_type: ethernet
meta:
status: comm
last_report_at: 1449959488
last_energy_at: 1449945104
operational_at: 1418912581
next: 4e7a453d0a
InventoryResponse:
type: object
properties:
system_id:
description: Enlighten ID for this system.
type: integer
envoys:
description: A list of Envoys on this system, including serial number.
type: array
items:
type: object
properties:
sn:
type: string
model:
type: string
sku:
type: string
required:
- sn
- model
- sku
inverters:
description: A list of inverters on this system, including serial and model numbers.
type: array
items:
type: object
properties:
sn:
type: string
model:
type: string
sku:
type: string
required:
- sn
- model
- sku
meters:
description: A list of meters on this system, including serial number, manufacturer, and model number.
type: array
items:
type: object
properties:
sn:
type: string
manufacturer:
type: string
model:
type: string
status:
type: string
state:
type: string
required:
- sn
- manufacturer
- model
meta:
$ref: '#/components/schemas/Meta'
required:
- system_id
- inverters
- meters
- meta
example:
system_id: 1765
inverters:
- sn: '123456789123'
model: M215
- sn: '123455589199'
model: M215
meters:
- sn: '999111222333'
manufacturer: GE
model: I-210+
InvertersSummaryByEnvoyOrSiteResponse:
type: object
properties:
signal_strength:
type: integer
micro_inverters:
description: A list of active inverters on this system, including serial and model numbers.
type: array
items:
type: object
properties:
id:
type: integer
model:
description: Model number of this Microinverter.
type: string
part_number:
description: The Enphase part number of this Microinverter.
type: string
serial_number:
description: The serial number of this Microinverter.
type: string
sku:
type: string
status:
description: |-
The current status of this Microinverter.
* `normal` - The microinverter is operating normally.
* `power` - There is a production issue.
* `micro` - The microinverter is not reporting.
* `retired` - The microinverter is retired.
type: string
enum:
- normal
- power
- micro
- retired
power_produced:
type: object
properties:
value:
type: integer
units:
type: string
enum:
- W
precision:
type: integer
required:
- value
- units
- precision
proc_load:
type: string
param_table:
type: string
envoy_serial_number:
type: string
energy:
description: Returns the lifetime energy of the Microinverter. If the system has never produced energy, the energy value would be 0.
type: object
properties:
value:
type: integer
units:
type: string
enum:
- Wh
- kJ
precision:
type: integer
required:
- value
- units
- precision
grid_profile:
type: string
last_report_date:
description: The last time this device submitted a report, by default expressed in Unix epoch time. If Enlighten has no record of a report from this Envoy, returns null.
type: string
format: date
required: