View Source NervesHubLink.Extensions.Geo.Resolver behaviour (nerves_hub_link v2.6.0)

Summary

Formatted error response from a failed location resolution

Location information from a successful location resolution

Supported responses from resolve_location/0

@type error_information() :: %{error_code: String.t(), error_description: String.t()}

Formatted error response from a failed location resolution

@type location_information() :: %{
  :latitude => float(),
  :longitude => float(),
  :source => String.t(),
  optional(:accuracy) => pos_integer()
}

Location information from a successful location resolution

@type location_responses() ::
  {:ok, location_information()} | {:error, error_information()}

Supported responses from resolve_location/0

@callback resolve_location() :: location_responses()