The Maps feature helps to position managed entities at specific locations using their configured geolocation property with latitude and longitude values. This document provides a step-by-step guide for creating static maps for devices and assets, and enabling live tracking of assets on maps.
All Map operations require necessary permissions. Refer to
Users and Profiles document for more details.
Prerequisites
The prerequisites for working with the Maps feature are provided below.
- Configuring geolocations - Required for plotting managed entities on specific locations on the map.
- Configuring Location datapoints - Required for live tracking of managed entities. The movement of the managed entity is updated in the map whenever the Location datapoint value is received for the managed entity. The Live Tracking feature must also be enabled for the map.
- Integrating Google Maps API with Zoho IOT - Required for using Google Maps API on maps. By default, Zoho Maps is used.
Configuring Geolocations
As a first step, configure the geolocation property for the managed entities such as assets, devices, and locations that must be placed on the map.
Geolocation can be configured even after map creation from the Unmapped Devices/Assets/Locations link.
To configure geolocation,
- Access the End Application.
- Select Devices/Assets/Locations from the application's main menu on the left pane. The available entities are displayed in the right pane.
- Click on the entity for which you want to configure the geolocation.
- Click on the Details tab.
- Click on the Edit icon next to the Geolocation input textbox.
- Click inside the input textbox. The Geolocation page is displayed for entering/selecting the location.
- Enter the coordinates if you are aware, or traverse to the map and double click on the exact location of the device/asset/location. Alternatively, you can provide the location name in the search textbox inside the map to obtain the coordinates.
- Click on Set Geolocation to configure the coordinates.
- Click on the Tick icon to save the coordinates.
Next step is to create and integrate Google Maps API with the Zoho IOT Application. This is necessary if you want to use Google Maps for the map. If you want to continue with Zoho Maps, you can skip this step.
Configuring Location Datapoints (For Live Tracking)
In the case of live tracking of a managed entity, you need to configure a Location Datapoint for the entity.
To configure location datapoints and properties,
Select Location data type when creating a datapoint.
Refer to the Working with Datapoints document for more details on creating a datapoint. The Location datapoint is available for Realtime datapoints only.
- Configure GPS (Location) type.
Single Key: Latitude, Longitude are sent as a single key in the telemetry
Separate Key: Latitude, Longitude are sent as separate keys in the telemetry.
Configure Parsing Keys
Latitude, Longitude, and
Altitude.
- Click Add to create the datapoint for the particular managed entity.
The movement of the managed entity on the map is constructed and updated live whenever the GPS Location datapoint value is received.
Integrating Google Maps API
This integration is required if you want to view your maps on a Google Map.
To generate and integrate google maps key,
- Generate key in Google Maps platform.
- Integrate the Google Map Key in the application.
To integrate the key,
- Access the End Application.
- Click on the Setup icon to view the setup page.
- Click Map Settings under the GENERAL section.
- Enable the Integrate Google Maps option using the toggle button. The integration can be disabled by disabling this option.
- Provide the Google Maps API Key in the textbox provided.
- Click Save.
Creating Maps
After configuring the prerequisites, you can proceed to map creation. Consider the scenario where you have numerous diesel generators located at different blocks of your organization premises. You want to view the exact location of the DGs along with its current status, and summary on the map.
To achieve this, you can create a map with the filter conditions to fetch all DGs.
To create a map view,
- Access the End Application.
- Select Maps from the application's main menu on the left pane in the user application. The available maps are displayed in the right pane.
- Click on the Add Map button on the top right corner of the page.
- Provide the Map Name, Group, Profile for the map.
- Enable Live Tracking if you want to track your managed entity on the map.
Note: The live tracking option will be applicable to MEs that have GPS Location datapoint values. Without GPS data, only the status of the ME will be updated in the map automatically. When disabled, the manual refresh button must be clicked to update the map. For example, the live tracking feature will be used extensively in fleet management, such as school van tracking or cab service, etc., where you want to track your assets.
Select Module. Ensure that the selected module's managed entities have the geolocation property updated. The location will be marked on the map.
- Select All Device/Asset/Location Models option from the drop down list to include all the instances of the model in the map.
Note: Live tracking, when enabled, will be effective only if a particular managed entity (Device/Asset/Location) is selected as a module. And also the selected managed entity must have the GPS Location datapoint configured. This entity will be considered moving, and its location will be updated. However, there will not be any separate status for moving entities.
Note: If a particular device/asset/location model is selected as a module, the Map Marker icon selection option will be displayed. Here, you can select the icon you wish to be displayed on the map. Whereas, if the All Device/Asset/Location Model option is selected as the module, the Model's icon will be used as the Map Marker icon.
8. Select the Map Marker icon if you selected a particular device/asset/location model as the module.
9. In Condition Builder, provide the condition based on which you want to filter and display device/asset/location on the map.
10. Select Field, Select Operator, Set Value.
11. Click
Create. The map is created and displayed in the right frame as shown below.
Image: Static map view with the summary details of the managed entity displayed on click.
Editing Maps
Any map can be modified after creation if required. Apart from the Module, all basic details of the map such as name, group, associated profiles, and filter condition can be modified using the Edit option.
To edit a map,
- Select Maps from the application's main menu on the left pane in the user application. The available maps are displayed in the right pane.
- Click on Actions > Edit Map on the top right corner of the page.
- In the Edit Map page, modify the desired values.
Note: Module is the main criteria and therefore it cannot be modified. 4. Click Update to save the changes.
Deleting Maps
Any map in the application can be deleted using the Delete Map option. On deletion, the map will be permanently deleted.
To delete a map,
- Select Maps from the application's main menu on the left pane in the user application. The available maps are displayed in the right pane.
- Click on Actions > Delete Map on the top right corner of the page. The Delete Confirmation popup is displayed.
3. Ensure you want to delete the map, and click on the Delete Map button.
The map will be deleted and removed from the Maps page.
Viewing Maps
Maps can be viewed using the Maps option from the left pane and by choosing the relevant map from the drop down list.
To view a map in the maps tab,
- Access the End Application
- Click Maps, the available maps are displayed.
- Select the desired map from the drop down list.
4. You can view the Map Card view of the managed entity by clicking on the marker.
Image : Map Card view
Note: The details displayed here are the same as those configured for the Summary Panel.
To view a map in the dashboard,
- Access the End Application.
- Click Dashboard; the map widget configured is shown displaying the map as shown below.
The new map widget is displayed on the dashboard in which the widget is added.
Google Maps API Error Messages
What happens when the Google Key Expires in the application?
The below message is displayed in the map when the Google Maps API Key expires.
What happens when the API usage exceeds limit?
The below message is displayed in the map when the Google Map API limit is exceeded.
Solution: This can be solved by increasing the limit of the API usage count.
The complete list of error messages in Google Maps API can be accessed from the official web site.
See Also