Skip to content
This repository has been archived by the owner on Oct 8, 2022. It is now read-only.

IntSoftDev/simian

Repository files navigation

Simian

This repo has been archived and superseded by a Kotlin Multiplatform version available here https://github.com/IntSoftDev/NRStationsKMP

 Android CI

An Android library for integrating with UK Train stations data

Simian connects to a Huxley-enabled web proxy that gets data from the NRE Darwin feed.

The defaultweb proxy is https://onrails.azurewebsites.net/ (https://github.com/azaka01/Huxley2)

Simian is currently used in the On Rails Android app https://play.google.com/store/apps/details?id=com.intsoftdev.nationalrail&hl=en_UK

It will be deprecated in favour of a Kotlin multiplatform library under development https://github.com/IntSoftDev/NRStationsKMP

About

Simian is written in Kotlin and requires minimum Android API 21+.

Get Started

Add this in your app's build.gradle file:

dependencies {
    implementation 'com.intsoftdev:simian:0.2'
}

In the Application::OnCreate class add these lines

StationsClientInitializer(this).initialise()

Create an instance of StationsClient

var client = StationsClient()
var stationsObservable: ReturnState<StationsResult> = client.getAllStations()
// subscribe to the observable
// a list of StationModel is returned
var stations : List<StationModel> = returnState.data.stations