Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 3.29 KB

README.md

File metadata and controls

86 lines (62 loc) · 3.29 KB
Raw

API, core API, Android API, Android

Current version | Structure | What does it do? | What it isn't | Quick start

Locus API

Library for Locus Map application for Android devices.

Current version

Latest stable LT version: 0.9.55 Available versions on the maven repository: here.

How to update to new 0.9.x version? More about it here.

Structure

Whole API is divided into two separate parts:

  • library written in pure Java - Locus API - Core
  • its extension for Android devices - Locus API - Android

In most cases, Android version is the only interesting one here.

What does it do?

  • main purpose is a transport tool for various objects (points/tracks)
  • allows to check state of certain functions like periodic updates, units defined by user and more
  • allows to control track recording and partially also navigation features
  • allows to handle field notes completely
  • allows to generate map preview of a certain area & zoom level

What it isn't

  • a replacement for Google Maps API or other map library that substitutes map core to your own application
  • a standalone library that may work without Locus Map application

For creating Locus Map add-ons it is needed to handle only Locus API - Android library. Locus API is automatically added as dependency.

Quick start

Add JitPack repository to your root build.gradle module config. This is currently necessary for the internal logger dependency.

allprojects {
  repositories {
    maven(url = "https://jitpack.io")
  }
}

Add dependency to your build.gradle module config

dependencies {
     // get Locus API (Java only)
     implementation('com.asamm:locus-api-core:[latest]')
     
     // or Locus Android API (for Android apps)
     implementation('com.asamm:locus-api-android:[latest]')
}

Check for sample use-cases in Locus API - Android sample project.

New version release steps

  1. Raise version in the gradle.properties
    • API_CODE
    • API_VERSION
  2. update version also in this "README" file (line 19)
  3. update "CHANGELOG" news file
  4. commit changes to GitHub
  5. tag commit with "Locus_API_X.X.X" pattern to trigger publishing of the "Core" module
  6. wait approx 15 minutes till version will be available on the Maven, alternative check here
  7. tag commit with "Locus_API_Android_X.X.X" pattern to trigger publishing of the "Android" module
  8. after another 15+ minutes, it should be available as well