Code Monkey home page Code Monkey logo

rxwear's Introduction

Reactive Wearable API Library for Android

Build Status codecov Download Android Arsenal API

This library wraps the Wearable API in RxJava Observables and Singles. No more managing GoogleApiClients! Also, there are some helper classes, which ease communication between phone and wear app.

See the 2.x branch for a RxJava 2 version of this library.

Usage

Create an RxWear instance once, preferably in your Application's onCreate() or by using a dependency injection framework. The RxWear class is very similar to the Wearable class provided by the Wearable API. Instead of Wearable.MessageApi.sendMessage(apiClient, nodeId, path, data) you can use rxWear.message().send(nodeId, path, data).

There are also some helper methods to ease the putting/sending of data.

  • rxWear.data().putDataMap(): Use this to put a DataItem containing a DataMap to a path or a pathPrefix with an auto appended ID.
  • rxWear.data().putSerializable(): Use this to put a DataItem containing a Serializable object to a path or a pathPrefix with an auto appended ID.
  • rxWear.message().sendDataMap(): Use this to send a message containing a DataMap to either one specific node or all remote nodes.
  • rxWear.message().sendSerializable(): Use this to send a message containing a Serializable object to either one specific node or all remote nodes.

A few Observable Transformers are included to ease fetching the data. Since these include filtering, they cannot operate on Singles by default, but you can use single.toObservable().compose(...).

  • DataEventGetDataMap: Use this Transformer to get the DataMap from a DataEvent and optionally filter the events.
  • DataEventGetSerializable: Use this Transformer to get a Serializable object from a DataEvent and optionally filter the events.
  • DataItemGetDataMap: Use this Transformer to get the DataMap from a DataItem and optionally filter the items.
  • DataItemGetSerializable: Use this Transformer to get a Serializable object from a DataItems and optionally filter the items.
  • MessageEventGetDataMap: Use this Transformer to get the DataMap from a MessageEvent and optionally filter the events.
  • MessageEventGetSerializable: Use this Transformer to get a Serializable object from a MessageEvent and optionally filter the events.

Example:

RxWear rxWear = rxWear.init(context);

// Phone App

rxWear.message().sendDataMapToAllRemoteNodes("/dataMap")
	    .putString("title", "Title")
	    .putString("message", "My message")
	    .toObservable()
	    .subscribe(requestId -> {
	    	/* do something */
	    });

rxWear.data().putSerializable(serializable).urgent().to("/serializable")
        .subscribe(dataItem -> {
	        /* do something */
        });

// Wear App

rxWear.message().listen("/dataMap", MessageApi.FILTER_LITERAL)
        .compose(MessageEventGetDataMap.noFilter())
        .subscribe(dataMap -> {
            String title = dataMap.getString("title", getString(R.string.no_message));
            String message = dataMap.getString("message", getString(R.string.no_message_info));
            /* do something */
        });

rxWear.data().listen("/serializable", DataApi.FILTER_LITERAL)
        .compose(DataEventGetSerializable.<MySerializableType>filterByType(DataEvent.TYPE_CHANGED))
        .subscribe(serializable -> {
            /* do something */
        });

An optional global default timeout for all Wearable API requests made through the library can be set via rxWear.setDefaultTimeout(...). In addition, timeouts can be set when creating a new Observable by providing timeout parameters, e.g. rxWear.message().send(nodeId, path, data, 15, TimeUnit.SECONDS). These parameters override the default timeout. When a timeout occurs, a StatusException is provided via onError(). The timeouts specified here are only used for calls to the Wearable API, e.g. a timeout will not occur when a listener does not emit an item within the specified timeout. The RxJava timeout operators can be used for this use case.

You can also obtain a Single<GoogleApiClient>, which connects on subscribe and disconnects on unsubscribe via GoogleAPIClientSingle.create(...).

The following Exceptions are thrown in the lib and provided via onError():

  • StatusException: When the call to the Wearable API was not successful or timed out
  • GoogleAPIConnectionException: When connecting to the GoogleAPIClient was not successful.
  • GoogleAPIConnectionSuspendedException: When the GoogleApiClient connection was suspended.

Sample

A basic sample app is available in the sample and wearsample projects.

Setup

The lib is available on jCenter. Add the following to your build.gradle:

dependencies {
    compile 'com.patloew.rxwear:rxwear:1.3.0'
    // or, for a RxJava 2 version of this library:
    compile 'com.patloew.rxwear:rxwear2:2.0.0'
}

Credits

The code for managing the GoogleApiClient is taken from the Android-ReactiveLocation library by Michał Charmas, which is licensed under the Apache License, Version 2.0.

License

Copyright 2016 Patrick Löwenstein

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

rxwear's People

Contributors

patloew avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

rxwear's Issues

Dependencies

I tried to use GMS 10.2.0, which compiled fine, but as soon a I ran the app it crashed because of a gms version conflict caused by this lib, using gms 9.8.0:
com.google.android.gms:play-services-wearable:9.8.0

Can you please add the gms dependencies in the main documentation for other people? This way the lib wouldn't have to update every time a new gms version is released (as requested in #4 ) and the developer using the lib could upgrade to a later gms version.
Thanks

NoSuchMethodError with Java8

Android plugin 2.4.0 supports Java 8 language features, which makes it possible to stop using retrolambda.
However, when I removed my retrolamda dependancy, my app crashed when trying to use the RxWear 2.0.0 library.

Any idea what might cause this 😕 ?

Stacktrace of the crash:

04-11 15:08:04.061 4853-4853/com.company.myapp.debug E/AndroidRuntime: FATAL EXCEPTION: main
                                                                            Process: com.company.myapp.debug, PID: 4853
                                                                            java.lang.NoSuchMethodError: No virtual method lambda$subscribe$0(Lcom/google/android/gms/common/api/GoogleApiClient;)V in class Lcom/patloew/rxwear/BaseSingle; or its super classes (declaration of 'com.patloew.rxwear.BaseSingle' appears in /data/app/com.company.myapp.debug-1/split_lib_dependencies_apk.apk)
                                                                                at com.patloew.rxwear.BaseSingle$$Lambda$1.cancel(Unknown Source)
                                                                                at io.reactivex.internal.disposables.CancellableDisposable.dispose(CancellableDisposable.java:49)
                                                                                at io.reactivex.internal.operators.single.SingleCreate$Emitter.onError(SingleCreate.java:91)
                                                                                at com.patloew.rxwear.BaseSingle$ApiClientConnectionCallbacks.onConnectionFailed(BaseSingle.java:90)
                                                                                at com.google.android.gms.common.internal.zzm.zzn(Unknown Source)
                                                                                at com.google.android.gms.internal.zzaat.zzc(Unknown Source)
                                                                                at com.google.android.gms.internal.zzaar.zzf(Unknown Source)
                                                                                at com.google.android.gms.internal.zzaar.zzwf(Unknown Source)
                                                                                at com.google.android.gms.internal.zzaar.zza(Unknown Source)
                                                                                at com.google.android.gms.internal.zzaav.zza(Unknown Source)
                                                                                at com.google.android.gms.internal.zzaag.onConnectionFailed(Unknown Source)
                                                                                at com.google.android.gms.common.internal.zzl$2.onConnectionFailed(Unknown Source)
                                                                                at com.google.android.gms.common.internal.zzf$zzj.zzm(Unknown Source)
                                                                                at com.google.android.gms.common.internal.zzf$zza.zzb(Unknown Source)
                                                                                at com.google.android.gms.common.internal.zzf$zza.zzu(Unknown Source)
                                                                                at com.google.android.gms.common.internal.zzf$zze.zzxH(Unknown Source)
                                                                                at com.google.android.gms.common.internal.zzf$zzd.handleMessage(Unknown Source)
                                                                                at android.os.Handler.dispatchMessage(Handler.java:102)
                                                                                at android.os.Looper.loop(Looper.java:154)
                                                                                at android.app.ActivityThread.main(ActivityThread.java:6077)
                                                                                at java.lang.reflect.Method.invoke(Native Method)
                                                                                at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:865)
                                                                                at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:755)

Uri for DataListener not properly computed

I'm sending data on the mobile through

rxWear.data().putDataMap().to("/myPath")

which seems to properly create the Uri and results in wear://<nodeId>/myPath

but on the wear I listen like:

rxWear.data().listen("/myPath", DataApi.FILTER_LITERAL)

which gives me: wear:/myPath

In your Implementation you create the Uri with a Uri.Builder but do not set the host (which is missing in the above uri)

This bug results has the problem that the listen command is triggered by EVERY data-update, no matter of the specified Uri, see https://developers.google.com/android/reference/com/google/android/gms/wearable/DataClient.html#addListener(com.google.android.gms.wearable.DataClient.OnDataChangedListener,%20android.net.Uri,%20int)

Unable to get DataMap.

When I try to get DataMap on Wear device like this:

RxWear.Data.get()
        .compose(DataItemGetDataMap.filterByPath("/picture"))
        .subscribe(dataMap -> /* do something */)

I get java.lang.IndexOutOfBoundsException: Invalid index 0, size is 0.

I found this bug report https://code.google.com/p/android/issues/detail?id=74204 which describes this problem so I don't think this is RxWear library problem but I'm wondering is there a way to make this work?

rxWear quite simply NOT WORKING

I tried making a basic app that sends small data to my wear app, and my wear app should just Log.d "ok..." to see if the data was received.

It does not:

here is my wear app;

  RxWear rxWear = new RxWear(this);

        Log.d("MEx", "  ok  ! ");

        rxWear.message().listen("/dataMap", MessageApi.FILTER_LITERAL)
                .compose(MessageEventGetDataMap.noFilter())
                .subscribe(dataMap -> {

                    Log.d("MEx", " lol " );

                });

That is the relevant code.

Here is what I do in my mobile app:


 public void sendPoint(Point b)
    {


        long[] pointz = new long[3];

        pointz[0] = b.x;
        pointz[1] = b.y;

        rxWear.message().sendDataMapToAllRemoteNodes("/dataMap")
                .putString("title", "Title")
                .putLongArray("point", pointz)
                .toObservable()
                .subscribe(requestId -> {
                    /* do something */
                });




    }

What am I doing wrong?!!

RxWear stops working from a service if battery is below certain level

I've noticed a very strange thing: after getting below certain battery charge level (on the phone), the communication via RxWear works only if the app on the phone is in the foreground, but no longer works from a background service. Maybe it's not an issue with RxWear but with the Wear configuration?

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.