Giter VIP home page Giter VIP logo

uplink-android's Introduction

Uplink Android SDK

SDK for setting up and communicating with uplink from android.

This project consists of two parts.

Uplink android module

It's distributed as a tarball for the 4 major android architectures (arm/x86 X 32bit/64bit). This module is a valid magisk module so it can be just extracted to /data/adb/modules/uplink if you're using magisk as your root manager and it will start uplink at boot. You can also start uplink manually like this:

$MODULE/bin/daemonize $MODULE/service.sh

This script will stop the current uplink instance if it's running and then start it.

The following are the configuration points for this module:

  • $MODULE/etc/uplink.config.toml : uplink configuration file
  • $MODULE/services/ : If you want to run some additional services, put the boot script in this directory
  • env.sh : Defines the environment variables for this module. One of those is DATA_DIR where all the uplink runtime data lives. By default it points to /data/local/uplink

Android library

It's distributed as an aar file on the github releases page. It can be included in you android project like this:

    implementation files('libs/uplink.aar')

The main entry point of this library is the io.bytebeam.uplink.Uplink class. Look at the javadoc of this class for usage notes.

uplink-android's People

Contributors

amokfa avatar bmcpt avatar de-sh avatar gautambt avatar tekjar avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

uplink-android's Issues

Issues with running in background

When using the aar to build a background service on android that is then run and the user moves out and back in, i.e. pushing the app into background and then bringing it back into the foreground will cause one of a SIGSEGV/SIGABRT. This can be reproduced in android with running the app, using the home button to move out of the app activity and then reopening the app all while connected to adb logcat for collecting logs.

Example logcat output

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.