Lighting Test Trait
API Service: LightingTestApi
| Method | Request Type | Response Type | Description |
|---|---|---|---|
| GetLightHealth | GetLightHealthRequest | LightHealth | |
| ListLightHealth | ListLightHealthRequest | ListLightHealthResponse | |
| ListLightEvents | ListLightEventsRequest | ListLightEventsResponse | |
| GetReportCSV | GetReportCSVRequest | ReportCSV |
LightHealth
| Field Name | Type | Description |
|---|---|---|
| name | string | The Smart Core device name of the emergency light. |
| update_time | google.protobuf.Timestamp | The last time this data was updated. |
| faults | repeated LightFault |
LightingEvent
| Field Name | Type | Description |
|---|---|---|
| name | string | |
| id | string | |
| timestamp | google.protobuf.Timestamp | |
| duration_test_pass | LightingEvent.DurationTestPass | |
| function_test_pass | LightingEvent.FunctionTestPass | |
| status_report | LightingEvent.StatusReport |
LightingEvent.DurationTestPass
| Field Name | Type | Description |
|---|---|---|
| achieved_duration | google.protobuf.Duration |
LightingEvent.FunctionTestPass
No fields defined.
LightingEvent.StatusReport
| Field Name | Type | Description |
|---|---|---|
| faults | repeated LightFault |
GetLightHealthRequest
| Field Name | Type | Description |
|---|---|---|
| name | string |
ListLightHealthRequest
| Field Name | Type | Description |
|---|---|---|
| page_size | int32 | The maximum number of emergency light names to return at once. The service may choose to return fewer. If unspecified, defaults to 50. |
| page_token | string | Page token from a previous ListEmergencyLists call. Provide to get the next page. If omitted, the first page is supplied. |
ListLightHealthResponse
| Field Name | Type | Description |
|---|---|---|
| emergency_lights | repeated LightHealth | |
| next_page_token | string |
ListLightEventsRequest
| Field Name | Type | Description |
|---|---|---|
| page_size | int32 | |
| page_token | string |
ListLightEventsResponse
| Field Name | Type | Description |
|---|---|---|
| events | repeated LightingEvent | |
| next_page_token | string | Contains a page token which can be supplied as page_token in ListLightEventsRequest to fetch the next page of results. Only present when more results are immediately available. |
| future_page_token | string | Contains a page token which can be supplied as page_token in ListLightEventsRequest to fetch only new data in the future. Unlike next_page_token, this is present even when no more pages are immediately available. The client can check again in the future |
GetReportCSVRequest
| Field Name | Type | Description |
|---|---|---|
| include_header | bool | Add a header to the generated CSV as the first row. |
ReportCSV
| Field Name | Type | Description |
|---|---|---|
| csv | bytes |
LightFault
| Name | Number | Description |
|---|---|---|
| FAULT_UNSPECIFIED | 0 | |
| DURATION_TEST_FAILED | 1 | |
| FUNCTION_TEST_FAILED | 2 | |
| BATTERY_FAULT | 3 | |
| LAMP_FAULT | 4 | |
| COMMUNICATION_FAILURE | 5 | |
| OTHER_FAULT | 6 |