This is a glossary for the fields Raptor Maps uses in requests and responses.
Field Name | Data Type | Purpose |
---|---|---|
ac_size_megawatts | integer | Translated value from DC to AC |
access_code | string | Information to access the physical farm |
action | json object | Object with information about suggested action |
address | string | Physical address of the farm |
annual_power_impact_visible | boolean | Report view option |
anomaly | string | Anomaly type |
anomaly_count | integer | Number of anomalies of certain type identified in an inspection |
anomaly_life_cycle | json object | Life cycle Object |
anomaly_locations_visible | boolean | Report view option |
anomaly_map_description | boolean | Optional notes for inspection quality check |
anomaly_map_visible | boolean | Report view option |
annual_monetary_impact_visible | boolean | Report view option |
anomalies_examples_visible | boolean | Report view option |
asset_id | string | External unique identifier for integrated systems |
avg_temp | float | Average temp at time of inspection |
client_org_id | integer | Internal value showing the originating org for the farm. |
cloud_cover | string | Cloud cover at time of inspection |
commisioning_tsecs | float | Date of farm commissioning displayed in unix epoch |
contact_uuid | string | Identifier for farm contact |
coordinates | list | Geo-location for anomaly |
country | string | Country where farm is located |
creator_id | string | User ID for the object creator |
created_tsecs | float | Date of object creation in Raptor Maps in unix epoch |
custom_locator_text | string | Custom numbering for equipment location |
data_capture_visible | boolean | Report view option |
defect_action_visible | boolean | Report view option |
delta_t | float | Difference in temperature between non-anomalous modules and the identified anomaly |
delta_t_visible | boolean | Report view option |
est_affected_dc_kw | float | The estimated affected power of the anomaly. |
est_affected_dc_percent | float | The estimated affected power of the anomaly is divided by the total site's power and represented as a percent. |
est_annual_impact_kw_h | float | The estimated annual impact in kilowatt-hours is the estimated affected power multiplied by the site's peak sunlight hours. |
est_annual_impact_dollars | float | The estimated annual impact in money is the estimated annual impact in kilowatt-hours multiplied by the money per kilowatt-hour i.e. power purchase agreement (PPA) rate. |
farm_obect | json object | Contains information about the farm on which the anomaly was found |
feedback | string | Notes about the anomaly |
findings_visible | boolean | Report view option |
flight_boundary | string | Data object that describes boundary of inspection flight |
geom | geometry object | Location of object |
group_name | string | Logical grouping for the anomaly |
id | integer | Unique ID number for the object. |
imaging_system | string | Model of camera used for inspection |
inspection_id | integer | ID of the inspection which found the anomaly |
inspection_tsecs | float | Time of the inspection in unix epoch |
inspection_tsecs_end | float | Time inspection ended in unix epoch |
inspection_uuid | uuid | UUID for the inspection associated with the anomaly |
irradiance | float | Available irradiance when the inspection took place |
irradiance_tsecs | float | Time when the irradiance was measured |
latitude | float | Geolocation for the object, with Longitude field |
linked_image_filename | string | File name for the secondary image associated with the anomaly |
linked_image_id | string | Identifier of the secondary image associated with the anomaly |
linked_image_url | string | URL of the secondary image associated with the anomaly |
linked_thumbnail_url | string | URL of the secondary thumbnail associated with the anomaly |
localize_anomalies_visible | boolean | Report view option |
localize_description | string | Notes from farm creation |
longitude | float | Geolocation for the object, with Latitude field |
max_temp | float | Maximum measured temperature on the panel |
min_temp | float | Minimum measure temperature on the panel |
modules | integer | The number of modules affected by a specific anomaly. For module anomalies, this will be one-to-one. For string and row anomalies, this will provide sum of the modules affected. |
module_layout | string | Number of modules per string |
module_mount | string | Description of the mounting technology used on the farm |
name | string | Name of the object |
norm_delta_t | float | Normalized delta t measurement |
notation | string | Notation type used for farm |
object_notation_json | json object | Standard numbering for equipment location |
object_type | string | The anomaly type |
order_uuid | string | UUID for order that created the inspection |
org_id | integer | ID of org that owns the data |
org_power_factor | float | The amount the anomaly reduces power generation as set by the parent org. Found in the tag object |
ppa_rate | float | Power Purchasing Authority's rate |
peak_sunlight_hours_annual | integer | Number of hours of estimated sunshine per year. Defaults to 1500. |
peak_sunlight | integer | Number of hours of estimated sunshine per year. Defaults to 1500. |
power_inspected | float | How much power was inspected |
power_factor | float | Raptor Maps default value for the amount the anomaly reduces power generation. Found in the tag object |
primary_image_filename | string | File name of the primary image associated with the anomaly |
primary_image_id | integer | Identifier of the primary image associated with the anomaly |
primary_shape_id | integer | The ID of the shape of identified anomaly |
primary_image_url | string | URL of the primary image associated with the anomaly |
primary_thumbnail_url | string | URL of the primary thumbnail associated with the anomaly |
priority | integer | Priority level of an identified anomaly |
quality_checked | boolean | check for inspection quality control |
rel_humidity | integer | Humidity levels during inspection |
row_child_process_status | integer | Asynchronous job status |
sensor_id | integer | ID of sensor used to measure temperature |
site_layout | string | Farm configuration indicators |
site_overview_visible | boolean | Report view option |
size | integer | Farm size in MW |
solar_module_id | integer | ID for the solar module type |
solar_farm_id | string | ID of the inspected farm |
source_farm_uuid | uuid | Identifier for farm |
state | string | State in which the farm is built |
status | integer | Indicator of object status |
summary_text | string | Notes for inspection |
tag | json object | Object with information about anomaly type |
tag_display_text | string | Text name of the anomaly type. |
tag_id | integer | ID number for the anomaly tag |
temperature | float | Outside temperature at time of inspection. Measured in Celsius |
thermal_overlay_visible | boolean | Report view option |
timezone | string | Time zone for the farm location |
title | string | Inspection Title |
type | string | Shape of the anomaly |
uas_model | string | Model of drone used for the inspection |
updated_tsecs | float | Date of the last update to the object in unix epoch |
uuid | string | Unique identifier for the object. |
verified | boolean | Verification of inspection |
version | integer | current version of the object |
wind_speed | float | Wind speed at time of inspection. Measured in km/h |
action
The action object contains information about the suggested action for a given anomaly. The primary field is the "action" field which contains a string value with the name of the suggested action. Possible values are CLAIM, NO_ACTION, REPAIR, REPLACE, TRACK, UNSPECIFIED.
"action": {
"action": <string>, -- enumerated value from list above
"action_source": "system_specified",
"created_tsecs": <integer>,
"creator_id": <integer>,
"defect_id": <integer>,
"id": <integer>,
"inspection_id": <integer>,
"status": 1,
"updated_tsecs": <integer>,
"updator_id": <integer>
},
Field Name | Purpose |
---|---|
action | The recommended or chosen action. |
action_source | This is always set to system_specified. |
created_tsecs | The time the action was set. This is represented in Unix Epoch time signature and is in UTC. |
creator_id | The ID of the user that created the action. This user will usually be Raptor Maps. |
defect_id | The ID of the anomaly for which the action is recommended. |
id | The ID of the action object. |
inspection_id | The ID of the inspection associated with the anomaly. |
status | This will always be 1. |
updated_tsecs | The time the action was updated. This is represented in Unix Epoch time signature and is in UTC. |
updator_id | The ID of the user that updated the action. |
anomaly_life_cycle
The anomaly life cycle object consists of two values, an ID and a status. The ID is a numerical representation of the status. The status is a string description of the anomaly status.
Life Cycle ID | Status | Description |
---|---|---|
1 | Detected | This anomaly was recently found |
2 | Verified | This anomaly's existence has been verified |
3 | Resolved | This anomaly has been remediated |
4 | Not Found | This anomaly can no longer be identified |
object_notation_json
Raptor Maps' new standard for object locator text. Each notation object contains a row name, string name, module name. These refer to the physical equipment on the farm and a full explanation can be found in our knowledge hub. For the API response. Each notation element contains an x and a y component, the default goes west to east, and north to south respectively.
If an object's location is 2,29,6,1,4,2 we can break that into three pairs.
2, 29 means the second row in the x direction, 29th row in the y direction
6, 1 means the 6th string horizontally into the row, and the 1st string vertically
4,2 gives us the location of the module, 4th in the string, in the 2nd segment of the string
In our API response that will look like this:
"object_notation_json": {
"row": {
"object_name": "2,29",
"prefix": "",
"rule_index": 0
},
"string": {
"object_name": "6,1",
"prefix": "",
"rule_index": 1
},
"module": {
"object_name": "4,2",
"prefix": "",
"rule_index": 2
}
},
object_type
This field describes the equipment level at which the anomaly was found. Values are module, row, or string. For instance, cracking would be a module level anomaly; tracker mounts would be a row level; and wiring might affect an entire string.
priority
This field describes the priority level assigned to a particular anomaly. The first level of priority is determined automatically by Raptor Maps based on the anomaly type but can be changed.
Priority level | Status |
---|---|
0 | None |
1 | Low |
2 | Medium |
3 | High |
4 | Completed |
5 | Unset |
tag
The tag object contains information about the anomaly type. The tag field is the primary field in the object and is the identifier for the anomaly. The tag_display_text is a string description corresponding to the tag id.
The structure of the tag object is this:
"tag": {
"color": <string>,
"id": <integer>,
"org_power_factor": <float>,
"power_factor": <float>,
"tag": <string>,
"tag_display_text": <string>
},
Field Name | Purpose |
---|---|
color | Used by the web app to determine the color with which to display the anomaly. |
id | The tag id. This ID corresponds to the type of the anomaly. A shading anomaly, for instance, will have an id of 9619. |
org_power_factor | This serves the same function as the power_factor. The difference is the number comes from the org owner and not from Raptor Maps. This can be set in the Raptor Maps web app. |
power_factor | This is the by Raptor Maps to calculate the loss in power from the anomaly compared to a nominally functioning panel. |
tag | This is the plain text name for the anomaly type. |
tag_display_name | This is used by the web app to display an anomaly name if it differs from the standard name set in the tag field. |