Skip to content

A safe and correct Bluetooth Low Energy (BLE) library for Android with functional data types and Kotlin Coroutines and RxJava2 interface.

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

technocreatives/beckon-android

Repository files navigation

Beckon

A safe, correct and pleasant Bluetooth Low Energy (BLE) library for Android with functional data types and reactive interface.

Introduction

This library aims to solve many of the pains that Android developers have to endure in their life when working with Android BLE.

By using functional programming approach and reactive interface, this library (will) provides:

Setup

You can get Beckon by using Jitpack.

    repositories {
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }

    // Beckon
    implementation "com.github.technocreatives.beckon-android:beckon:main-SNAPSHOT"

    // Beckon DFU
    implementation "com.github.technocreatives.beckon-android:beckon-dfu:main-SNAPSHOT"

    // Beckon Mesh
    implementation "com.github.technocreatives.beckon-android:mesh-data:main-SNAPSHOT"
    implementation "com.github.technocreatives.beckon-android:beckon-mesh:main-SNAPSHOT"

Compatibility

The library uses arrow, version 1.1.2, to provide well typed Either results for error handling. A basic understanding of how Arrow's work is essential.

Contributing

Any bug reports, feature requests, questions and pull requests are very welcome.

Modules & Features

Beckon

Basic BLE connection to devices

  • Scan
  • Connect/disconnect a device
  • Create/remove Bond
  • Save/remove (A new concept from Beckon)
  • Descriptor with requirements on a device

Beckon DFU

Wrapper around NordicSemiconductor/Android-DFU-Library

  • Sealed interface of results during the process of a DFU (Starting, EnablingBootloader, Uploading and Success/Aborted/Error)
  • Process to view current state and abort a DFU process

Beckon Mesh

  • Exposes mesh states for Loaded, Connected & Provisioning
  • Support multiple meshes
  • Observe changes to mesh configuration
  • Exposes sendMessage as suspend for Ack message
  • Typed Configuration messages
  • ProxyFilterMessage that types AccessPayload and OpCode (e.g Single, Double & Triple octet)

Mesh Data

Workflow

-> Create a new branch
-> Push a lot of commits
-> Create a new PR to master
-> Push a lot of commits
-> Do code review & discuss
-> make sure ci agrees with what you did
-> Rebase to master (if needed)
-> Squash into one commit (and write a beautiful commit message)
-> If team agrees then merge to master

Limitation

This library is not feature complete, feel free to make a PR if you wish to add functionality that is missing.

License

Licensed under either of these:

Contributing

Unless you explicitly state otherwise, any contribution you intentionally submit for inclusion in the work, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.

About

A safe and correct Bluetooth Low Energy (BLE) library for Android with functional data types and Kotlin Coroutines and RxJava2 interface.

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •