get_location()
- 1 Minute to read
get_location()
- 1 Minute to read
Article summary
Did you find this summary helpful?
Thank you for your feedback
get_location()
Retrieve information about an existing location
Reference
Arguments
| Arguments | Type | Default value | |
|---|---|---|---|
| location_name | str | The requested location on the map. | |
| pos_unit | POS_UNIT | POS_UNIT.PIXEL | ENUM to determine whether the x,y values should be returned as pixels of the map image (POS_UNIT.PIXEL) or Cartesian position in meters (POS_UNIT.METERS) |
Return
Dict with x and y values of the location on the current map.
| Key | Type | Info |
|---|---|---|
x | int | map position X. |
y | int | map position Y. |
Exceptions
| Exception | Condition |
|---|---|
RayaNavNotLocated | The robot is not located on the map. |
RayaNavZonesNotFound | No zones found on the map. |
RayaNavUnkownError | An unknown error occurs. |
RayaWrongArgument | pos_unit is neither POS_UNIT.METERS nor POS_UNIT.PIXEL. |
See the complete list of Raya Exceptions
Was this article helpful?
.png)