See: Description

Packages 
Package Description
com.lf.api  
com.lf.api.constants  
com.lf.api.events  
com.lf.api.exceptions  
com.lf.api.models  
com.lf.api.models.interfaces  

Introduction

This document explains the API which allows your custom Android application to communicate with the new Life Fitness Discover Tablet Consoles software and Life Fitness web portal called LFconnect . By embedding this library in your application, you would be able to link with LFconnect and download exerciser workouts and send those directly to any connected Life Fitness Discover Tablet Console Cardio product. The equipment will communicate with your application via this library to get workouts names, workout parameters and will also send workout results (i.e. speed, distance, time, calories & heart rate) to the library for uploading to LFconnect server for progress tracking.

Setup

- Copy the file LFAPI.jar into the lib folder of your Android Project.
- Add the jar file to your Java Build Path (In Eclipse: Properties --> Java Build Path --> Libraries --> Add JARs)
- Select either SDK level 10 Google api or API level 12 and higher for the target platform.
- Modify project manifest file. See below for sample

Usage

The overall classes provided by Life Fitness API can be viewed at the class diagram below:

Life Fitness API provides:
  • Interface to access Life Fitness equipment via EquipmentManager class and
  • Interface to access LFconnect website via WorkoutManager class

    • The Equipment library extends the android service class. Therefore this class needs to be started or stopped manually. Please see sample code below. On the other hand, the Workout library only needs to be accessed using its static function: getInstance().

    Before using Life Fitness library, the developer must obtain a license to each mobile app from our Life Fitness website. Once you register as a developer and register the mobile app, the website gives a license for the particular app. For details of how to obtain development license, please contact LifeFitness at developer@lifefitness.com.

    Switching environment

     License.getInstance().setEnvironmentToLive(LFLibsSampleActivity.this, true);

    License

    In order to use classes in this library, the developer must supply the license generated by Life Fitness for the particular app before using any of the methods in this API. Calling any methods without supplying the valid license code will result in an Exception.

    To supply the license given by Life Fitness, simply assign it using setLicense() method: 
      License.getInstance().setLicense(this,"123-456-789-ABC-DEF");


    If the given license is invalid, any call to library's public methods will trigger onError() callback with InvalidLicenseException as the parameter. Please note that it is also possible that during the license validation, method call may trigger InvalidLicenseException. The app can check the status of this validation by reading state data member of License: 
      
  if (License.getInstance().isLicenseValid()) {
    VTManager.getInstance().login(LoginOauth2Activity.this,  webview);

  } else {
    if (License.getInstance().state == License.NETWORK_ERROR) {
      // notify user or retry
      // ...

    } else if (License.getInstance().state == License.REQUESTING) {
      // still checking the license, try again later
      // ...
    }
  }

    EquipmentManager

    To use the API methods, implement Observer interface and supply the concrete Observer instance to EquipmentLibrary using registerObserver() method. The concrete Observer will handle any request coming from the equipment to your mobile app.

    The steps to use EquipmentManager for your mobile app:
    • 1. Register the event in your Manifest 
      ...
<application
android:icon="@drawable/ic_launcher"
android:label="@string/app_name" >

  <!-- Important -->
  <uses-library android:name="com.android.future.usb.accessory" />
  <service android:name="com.lf.api.EquipmentManager" />
  <service   android:name="com.lf.api.controller.usb.DeviceConnector" android:label="Device Connection" />
  <!-- Important -->
  <activity
  android:name=".LFLibsSampleActivity" android:screenOrientation="portrait"
  android:label="@string/app_name"  android:launchMode="singleInstance" >
    <intent-filter>
      <action android:name="android.intent.action.MAIN" />
      <action android:name="android.hardware.usb.action.USB_ACCESSORY_ATTACHED" />
      <category android:name="android.intent.category.LAUNCHER" />
    </intent-filter>

    <meta-data
    android:name="android.hardware.usb.action.USB_ACCESSORY_ATTACHED"
    android:resource="@xml/accessory_data" />
  </activity>
</application>
...

(res/xml/accessory_data.xml)
<resources>
  <usb-accessory manufacturer="Life Fitness" model="Upright Bike" version="1.0" /> 
  <usb-accessory manufacturer="Life Fitness" model="Recumbent Bike" version="1.0" /> 
  <usb-accessory manufacturer="Life Fitness" model="Cross-Trainer" version="1.0" /> 
  <usb-accessory manufacturer="Life Fitness" model="Treadmill" version="1.0" /> 
</resources>
    • 2. Implement EquipmentObserver 
      private EquipmentObserver cEquipment = new EquipmentObserver() {
  @Override
  public void onWorkoutResultReceived(WorkoutResult workoutresult) {
  }
  @Override
  public void onWorkoutPresetSent() {
  }
  @Override
  public void onStreamReceived(WorkoutStream workoutstream) {
  }
  @Override
  public List onSendingWorkoutPreset(){
  }
  @Override
  public void onInit() {
  }
  @Override
  public void onError(Exception e) {
  }
  @Override
  public void onDisconnected() {
  }
  @Override
  public void onConnection() {
  }
  @Override
  public void onConnected() {
  }
};
    • 3. Starting/stopping the service 
      
bindService(new Intent(LFLibsSampleActivity.this,
  EquipmentManager.class), new ServiceConnection() {
    @Override
    public void onServiceDisconnected(ComponentName pName) {    
    }
    @Override
    public void onServiceConnected(ComponentName pName, IBinder pService) {
      EquipmentManager.getInstance().registerObserver(cEquipment);
      EquipmentManager.getInstance().start();
                
    }
  },
Context.BIND_AUTO_CREATE);
    • 4. Register the observer

      Note: Register observers only after onServiceConnected is called. Usually, the good place will be inside onServiceConnected above. 
      EquipmentManager.getInstance().registerObserver(cEquipment);
EquipmentManager.getInstance().start();
    • 5. Add the Equipment list in the resource folder (res/xml/accessory_data.xml) 
      <resources>
  <usb-accessory manufacturer="Life Fitness" model="Upright Bike" version="1.0" /> 
  <usb-accessory manufacturer="Life Fitness" model="Recumbent Bike" version="1.0" /> 
  <usb-accessory manufacturer="Life Fitness" model="Cross-Trainer" version="1.0" /> 
  <usb-accessory manufacturer="Life Fitness" model="Treadmill" version="1.0" /> 
</resources>

    Equipment Simulation Mode

    Life Fitness Open API provides a way to develop the app without a physical Cardio product console. The app can set the mode to DEBUG_MODE.

    DEBUG_MODE will trigger callback to EquipmentObserver method, as if the device is connected to Life Fitness equipment. Please note that DEBUG_MODE will assume that the user has selected the first workout preset from "List onSendingWorkoutPreset()".

    To enable equipment simulation on the EquipmentManager: 
      EquipmentManager.DEBUG_MODE = true;
  .
  .
  .
  bindService(
    new Intent(LFLibsSampleActivity.this, EquipmentManager.class), 
    new ServiceConnection() {
      @Override
      public void onServiceDisconnected(ComponentName pName) {      
      }
  
      @Override
      public void onServiceConnected(ComponentName pName, IBinder pService) {                  
      }
    },
    Context.BIND_AUTO_CREATE
  );

    VTManager

    This is a singleton class. The registerUser() and getDefaultWorkouts() methods can be called without login to LFconnect server, but getUserWorkout(), postUserWorkout() and getProgressSummary() can only be called after a successful login() call.
    register
    This is an open Service which allows developers to create users without going through the Life Fitness website. A User class is provided for ease of use. Please see the User Class for the mandatory fields. 
    logintask.execute();
User user = new User();
user.setAge(10);
user.setEmail("superman@yahoo.com");
user.setUsername("iambatman");
user.setPassword("password");
registerUserTask.execute(user);
private AsyncTask registerUserTask = new AsyncTask(){

  @Override
  protected String doInBackground(User ...pParams) {
        
    try {
      VTManager.getInstance().register(pParams[0]);
    } catch (MissingFieldException e) {
      e.printStackTrace();
    }
  return "";
  }
  protected void onPostExecute(String result) {};

};
    login
    This method wraps OAuth 2.0 authentication. It will open Life Fitness OAuth page. After a successful authentication, an OAuth token is maintained by VTManager for the subsequent communication. 
    VTManager.getInstance().addEventListener(AuthorizationEvent.AUTHORIZATION_INIT, eventListner);
VTManager.getInstance().addEventListener(AuthorizationEvent.AUTHORIZATION_COMPLETED, eventListner);
VTManager.getInstance().addEventListener(AuthorizationEvent.AUTHORIZATION_LOGIN_SUCCESS, eventListner);
VTManager.getInstance().addEventListener(AuthorizationEvent.AUTHORIZATION_ACCEPTED, eventListner);
VTManager.getInstance().addEventListener(AuthorizationEvent.AUTHORIZATION_NOT_ACCEPTED_BY_USER, eventListner);

private EventListener eventListner = new EventListener()
{
  public void execute(Event e) {

    AuthorizationEvent event  = (AuthorizationEvent) e;
    if(event.getEventType().equals(AuthorizationEvent.AUTHORIZATION_INIT))
    {
    }
    else if(event.getEventType().equals(AuthorizationEvent.AUTHORIZATION_LOGIN_SUCCESS))
    {
          //event.getRequest_token();
    }
    else if(event.getEventType().equals(AuthorizationEvent.AUTHORIZATION_NOT_ACCEPTED_BY_USER))
    {
    }
    else if(event.getEventType().equals(AuthorizationEvent.AUTHORIZATION_ACCEPTED))
    {
    }
    else if(event.getEventType().equals(AuthorizationEvent.AUTHORIZATION_COMPLETED))
    {
      LoginOauth2Activity.this.lastAccessToken=event.getAccess_token();
    }   
  }

};

RequestToken rt  = new RequestToken("AAAAA", "BBBBB", "http://www.wikipedia.org");
VTManager.getInstance().login(LoginOauth2Activity.this,  LoginOauth2Activity.this.webview,rt);


or 

new LoginTask().execute(LoginOauth2Activity.this.lastAccessToken);



private class LoginTask extends AsyncTask {

  @Override
  protected AccessToken doInBackground(AccessToken... pParams) {

    try {
      return VTManager.getInstance().login(pParams[0]);
    } catch (Exception e) {
      return null;
    }
  }

  @Override
  protected void onPostExecute(AccessToken pResult) {
    super.onPostExecute(pResult);
        Toast.makeText(LoginOauth2Activity.this, "Refreshed:" + pResult, Toast.LENGTH_SHORT).show();
  }

}
    getUserworkout
    Retrieves a JSON format of the user workouts from the server and wraps them in a WorkoutPreset class and then returns them in a List.
    getUserWorkoutTask.execute();
private AsyncTask getUserWorkoutTask = new AsyncTask>() {

  @Override
  protected List doInBackground(String... params) {

    List workoutLists = null;

    try {
      workoutLists = VTManager.getInstance().getUserWorkout();
    } catch (Exception e) {

    }
    return workoutLists;
  }

  protected void onPostExecute(List result) {}
};
    getProgressSummary
    Queries the server for user's progress. 
    getProgressSummary.execute();
private AsyncTask getProgressSummary =  new AsyncTask(){

  @Override
  protected Progress doInBackground(String... pParams) {
    Progress progress=null;
    try {
      progress =VTManager.getInstance().getProgressSummary();
    } catch (Exception e) {
      e.printStackTrace();
    }

    return progress;
  }

};

    Requirements:

  • SDK level 10 Google API, or minimum API level 12. Get the compatible sdk here

    • Sample Project