Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 3 KB

estimated-location.rst

File metadata and controls

87 lines (64 loc) · 3 KB

Estimated Location

Important

The Estimated Location feature is disabled by default.

Before enabling it, the :doc:`WHOIS Lookup feature <whois>` must be enabled. Then set :ref:`OPENWISP_CONTROLLER_ESTIMATED_LOCATION_ENABLED` to True

Table of contents:

Overview

This feature automatically creates or updates a device’s location based on latitude and longitude information retrieved from the WHOIS Lookup feature.

Trigger Conditions

This feature is triggered when:

  • A fresh WHOIS lookup is performed for a device.
  • Or when a WHOIS record already exists for the device’s IP and:
    • The device’s last IP address is public.
    • WHOIS lookup and Estimated Location is enabled for the device’s organization.

Behavior

The system will attach the already existing matching location of another device with same ip to the current device if:

  • Only one device is found with that IP and it has a location.
  • The current device has no location or that location is estimated.

If there are multiple devices with location for the same IP, the system will not attach any location to the current device and a notification will be sent suggesting the user to manually assign/create a location for the device.

If there is no matching location, a new estimated location is created or the existing one is updated using coordinates from the WHOIS record, but only if the existing location is estimated.

If two devices share the same IP address and are assigned to the same location, and the last IP of one of the devices is updated, the system will create a new estimated location for that device.

Visibility of Estimated Status

The estimated status of a location is visible on the location page if the feature is enabled for the organization. The location admin page also includes indicators for the estimated status.

  • The name of the location will have suffix (Estimated Location : <ip_address>).
  • A warning on top of the page.
  • Is Estimated field.

Changes to the coordinates and geometry of the estimated location will set the is_estimated field to False and remove the "(Estimated Location)" suffix with IP from the location name.

In REST API, the field will be visible in the :ref:`Device Location <device_location_estimated>`, :ref:`Location list <location_list_estimated>`, :ref:`Location Detail <location_detail_estimated>` and :ref:`Location list (GeoJson) <location_geojson_estimated>` if the feature is enabled. The field can also be used for filtering in the location list (including geojson) endpoints and in the :ref:`Device List <device_list_estimated_filters>`.

Managing Older Estimated Locations

Whenever location related fields in WHOIS records are updated as per :ref:`Managing WHOIS Older Records <whois_older_records>`; the location will also be updated automatically.