jp.co.sharp.android.hardware
クラス Pedometer

java.lang.Object
  上位を拡張 jp.co.sharp.android.hardware.Pedometer

public class Pedometer
extends java.lang.Object

歩数計の計測データを取得するクラス。 

注意:歩数計が装備されていない機種では、本クラスは使用できません。 本クラスを使用するためには、下記uses-featureを宣言しなれければならない。
<uses-feature android:name="jp.co.sharp.android.pedometer" android:required="true" />
また、本クラスを使用するApplicationノードに下記uses-libraryを宣言しなれければならない。
<uses-library android:name="jp.co.sharp.android.hardware" />


フィールドの概要
static java.lang.String ACTION_MEASURE
           Broadcast Action:歩数計からのIntent通知を500msec毎に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。
static java.lang.String ACTION_MEASURE_CLEAR
           Broadcast Action:歩数計からのIntent通知をクリア時に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。
static java.lang.String ACTION_MEASURE_HOURLY
           Broadcast Action:歩数計からのIntent通知を1時間毎に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。
static java.lang.String ACTION_START
           Broadcast Action:歩数計からのIntent通知を起動時に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。
static java.lang.String ACTION_STOP
           Broadcast Action:歩数計からのIntent通知を停止時に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。
static java.lang.String AEROBICS_STEPS
           データ識別:有酸素運動時の歩数。
static java.lang.String CALORIE
           データ識別:消費カロリー(kcal)。
static int DEVICE_READY
           歩数計の状態:起動中。
static int DEVICE_STARTED
           歩数計の状態:稼働中。
static int DEVICE_STOPED
           歩数計の状態:停止中。
static java.lang.String DISTANCE
           歩数計から受取ったパラメータ(計測データ)から「移動距離(km)」データを識別するための定義値。
static java.lang.String EXERCISE
           歩数計から受取ったパラメータ(計測データ)から「エクササイズ(EX)」データを識別するための定義値。
static java.lang.String EXERCISE_DISTANCE
           歩数計から受取ったパラメータ(計測データ)から「移動距離(km)」データを識別するための定義値。
static java.lang.String EXERCISE_STEPS
           歩数計から受取ったパラメータ(計測データ)から「エクササイズ歩数」データを識別するための定義値。
static java.lang.String EXERCISE_TIME
           歩数計から受取ったパラメータ(計測データ)から「エクササイズ歩行時間(分)」データを識別するための定義値。
static java.lang.String FAT_COMBUSTION
           歩数計から受取ったパラメータ(計測データ)から「脂肪燃焼量(g)」データを識別するための定義値。
static java.lang.String JOG_STEPS
           歩数計から受取ったパラメータ(計測データ)から「ジョギング歩数」データを識別するための定義値。
static java.lang.String JOG_TIME
           歩数計から受取ったパラメータ(計測データ)から「ジョギング時間(分)」データを識別するための定義値。
static java.lang.String MEASURE_STATUS
           歩数計から受取ったパラメータ(計測データ)から「歩数計起動状態」データを識別するための定義値。
static java.lang.String METS
           歩数計から受取ったパラメータ(計測データ)から「METS値」データを識別するための定義値。
static java.lang.String STATUS
           歩数計の起動、停止時のIntentから処理結果を取得するための定義値。
static int STATUS_NG
           処理結果:失敗  本クラスのSTATUSを返すメソッドが失敗したときにこの値を返す。
static int STATUS_OK
           処理結果:成功  本クラスのSTATUSを返すメソッドが成功したときにこの値を返す。
static java.lang.String STEPS
           歩数計から受取ったパラメータ(計測データ)から「歩数」データを識別するための定義値。
static java.lang.String TIME
           歩数計から受取ったパラメータ(計測データ)から「歩行時間(秒)」データを識別するための定義値。
static java.lang.String WALK_STATUS
           歩数計から受取ったパラメータ(計測データ)から「歩行状態」データを識別するための定義値。
static java.lang.String WALK_STEPS
           歩数計から受取ったパラメータ(計測データ)から「しっかり歩数」データを識別するための定義値。
static java.lang.String WALK_TIME
           歩数計から受取ったパラメータ(計測データ)から「しっかり歩行時間(分)」データを識別するための定義値。
 
メソッドの概要
static Pedometer createInstance(android.content.Context context)
           Pedometerクラスの生成。
 float getFloatParameter(java.lang.String key)
           float型データの取得。
 int getIntParameter(java.lang.String key)
           Int型データの所得。
 android.os.Bundle getParameters(java.lang.String[] keys)
           複数データを一度に取得する。
static int getVersion()
           バージョンの取得。
 boolean isSupported(java.lang.String key)
           パラメータ(測定データ)のサポート確認。
 int startBroadcastIntent()
           パラメータ(測定データ)のIntent通知を開始します。
 int stopBroadcastIntent()
           パラメータ(測定データ)のIntent通知を停止します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

AEROBICS_STEPS

public static final java.lang.String AEROBICS_STEPS
データ識別:有酸素運動時の歩数。 

歩数計から受取ったパラメータ(計測データ)から「有酸素運動時の歩数」データを識別するための定義値。

関連項目:
定数フィールド値

CALORIE

public static final java.lang.String CALORIE
データ識別:消費カロリー(kcal)。 

歩数計から受取ったパラメータ(計測データ)から「消費カロリー(kcal)」データを識別するための定義値。

関連項目:
定数フィールド値

DEVICE_READY

public static final int DEVICE_READY
歩数計の状態:起動中。 

参考:STATUS, getIntParameter(String), getParameters(String[])

関連項目:
定数フィールド値

DEVICE_STARTED

public static final int DEVICE_STARTED
歩数計の状態:稼働中。 

参考:STATUS, getIntParameter(String), getParameters(String[])

関連項目:
定数フィールド値

DEVICE_STOPED

public static final int DEVICE_STOPED
歩数計の状態:停止中。 

参考:STATUS, getIntParameter(String), getParameters(String[])

関連項目:
定数フィールド値

DISTANCE

public static final java.lang.String DISTANCE
歩数計から受取ったパラメータ(計測データ)から「移動距離(km)」データを識別するための定義値。

関連項目:
定数フィールド値

EXERCISE

public static final java.lang.String EXERCISE
歩数計から受取ったパラメータ(計測データ)から「エクササイズ(EX)」データを識別するための定義値。

関連項目:
定数フィールド値

EXERCISE_DISTANCE

public static final java.lang.String EXERCISE_DISTANCE
歩数計から受取ったパラメータ(計測データ)から「移動距離(km)」データを識別するための定義値。

関連項目:
定数フィールド値

EXERCISE_STEPS

public static final java.lang.String EXERCISE_STEPS
歩数計から受取ったパラメータ(計測データ)から「エクササイズ歩数」データを識別するための定義値。

関連項目:
定数フィールド値

EXERCISE_TIME

public static final java.lang.String EXERCISE_TIME
歩数計から受取ったパラメータ(計測データ)から「エクササイズ歩行時間(分)」データを識別するための定義値。

関連項目:
定数フィールド値

FAT_COMBUSTION

public static final java.lang.String FAT_COMBUSTION
歩数計から受取ったパラメータ(計測データ)から「脂肪燃焼量(g)」データを識別するための定義値。

関連項目:
定数フィールド値

JOG_STEPS

public static final java.lang.String JOG_STEPS
歩数計から受取ったパラメータ(計測データ)から「ジョギング歩数」データを識別するための定義値。

関連項目:
定数フィールド値

JOG_TIME

public static final java.lang.String JOG_TIME
歩数計から受取ったパラメータ(計測データ)から「ジョギング時間(分)」データを識別するための定義値。

関連項目:
定数フィールド値

MEASURE_STATUS

public static final java.lang.String MEASURE_STATUS
歩数計から受取ったパラメータ(計測データ)から「歩数計起動状態」データを識別するための定義値。

関連項目:
定数フィールド値

METS

public static final java.lang.String METS
歩数計から受取ったパラメータ(計測データ)から「METS値」データを識別するための定義値。

関連項目:
定数フィールド値

STATUS

public static final java.lang.String STATUS
歩数計の起動、停止時のIntentから処理結果を取得するための定義値。 

参考: ACTION_START,ACTION_STOP,STATUS_NG, STATUS_OK

関連項目:
定数フィールド値

STATUS_NG

public static final int STATUS_NG
処理結果:失敗 

本クラスのSTATUSを返すメソッドが失敗したときにこの値を返す。 また、歩数計起動・停止に失敗した場合も、同通知Intentにこの値を格納する。

関連項目:
定数フィールド値

STATUS_OK

public static final int STATUS_OK
処理結果:成功 

本クラスのSTATUSを返すメソッドが成功したときにこの値を返す。 また、歩数計起動・停止に成功した場合も、同通知Intentにこの値を格納する。

関連項目:
定数フィールド値

STEPS

public static final java.lang.String STEPS
歩数計から受取ったパラメータ(計測データ)から「歩数」データを識別するための定義値。

関連項目:
定数フィールド値

TIME

public static final java.lang.String TIME
歩数計から受取ったパラメータ(計測データ)から「歩行時間(秒)」データを識別するための定義値。

関連項目:
定数フィールド値

WALK_STATUS

public static final java.lang.String WALK_STATUS
歩数計から受取ったパラメータ(計測データ)から「歩行状態」データを識別するための定義値。

関連項目:
定数フィールド値

WALK_STEPS

public static final java.lang.String WALK_STEPS
歩数計から受取ったパラメータ(計測データ)から「しっかり歩数」データを識別するための定義値。

関連項目:
定数フィールド値

WALK_TIME

public static final java.lang.String WALK_TIME
歩数計から受取ったパラメータ(計測データ)から「しっかり歩行時間(分)」データを識別するための定義値。

関連項目:
定数フィールド値

ACTION_MEASURE

public static final java.lang.String ACTION_MEASURE
Broadcast Action:歩数計からのIntent通知を500msec毎に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。 

startBroadcastIntent()をコールしてから500msec毎に、パラメータ(計測データ)をIntent通知します。 このため、消費電力が大きくなります。 このIntent通知は、AndroidManifest.xmlでアクションを定義しても受信できません。 受信するには、IntentFilter#addAction()で受信設定を行う必要があります。

必須項目:

オプション項目:

関連項目:
定数フィールド値

ACTION_MEASURE_HOURLY

public static final java.lang.String ACTION_MEASURE_HOURLY
Broadcast Action:歩数計からのIntent通知を1時間毎に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。 

Broadcast Action: 歩数計起動後、1時間毎(毎時00分)にパラメータ(計測データ)をIntent通知します。

なお、Version 2以降は、毎時00分のトラフィック集中を軽減するため、端末ごとに00~59秒間で通知時間をずらしています。

必須項目:

オプション項目:

関連項目:
定数フィールド値

ACTION_MEASURE_CLEAR

public static final java.lang.String ACTION_MEASURE_CLEAR
Broadcast Action:歩数計からのIntent通知をクリア時に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。 

歩数計のパラメータ(計測データ)がシステム側からクリアされたときに通知されます。

必須項目:

オプション項目:

関連項目:
定数フィールド値

ACTION_START

public static final java.lang.String ACTION_START
Broadcast Action:歩数計からのIntent通知を起動時に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。 

歩数計起動処理結果を通知します。

必須項目:

関連項目:
定数フィールド値

ACTION_STOP

public static final java.lang.String ACTION_STOP
Broadcast Action:歩数計からのIntent通知を停止時に受取るため、BroadcastReceiverに登録するIntent-FilterのAction定義値。 

歩数計停止処理結果を格納します。

必須項目:

関連項目:
定数フィールド値
メソッドの詳細

createInstance

public static final Pedometer createInstance(android.content.Context context)
Pedometerクラスの生成。 

Pedometerクラスを生成し、生成したPedometerクラスを返します。

パラメータ:
context - このクラスが動作しているContext。
戻り値:
歩数計サービスと接続が成功した場合、Pedometerクラスのインスタンスを返します。 失敗した場合は、nullを返します。

getVersion

public static final int getVersion()
バージョンの取得。 

このクラスのバージョン番号を返します。

本メソッドは下記Androidバージョン以降の端末のみ使用可能のため、注意が必要です。

Androidバージョン:ECLAIR (2.1)


 例:
 
 import android.os.Build;
 import jp.co.sharp.android.hardware.Pedometer;
 
 private Pedometer mPedometer;
 
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.ECLAIR_MR1) {
        int version = mPedometer.getVersion();
        if (version == 1) {
        //バージョンが1の場合
 
        ~中略~
 
        } else if (version == 2) {
        //バージョンが2の場合
 
        ~中略~
 
        } else {
        //バージョンが上記以外
 
        ~中略~
 
        }
    } else {
    // mPedometer.getVersion() を呼んではいけない
 
    ~中略~
 
    }
 

戻り値:
このクラスのバージョン番号を返します。

getFloatParameter

public float getFloatParameter(java.lang.String key)
float型データの取得。 

指定された識別の値を取得します。

パラメータ:
key - 以下のパラメータキーを指定することができます。 ただし、デバイスによってはこれらのパラメータ全てがサポートされているわけではありません。 パラメータがサポートされているかどうかは、isSupported(java.lang.String)で確認する必要があります。
戻り値:
指定されたデータ識別の値を返します。取得できなかった場合は0を返します。

getIntParameter

public int getIntParameter(java.lang.String key)
Int型データの所得。 

指定された識別の値を取得します。

パラメータ:
key - 以下のパラメータキーを指定することができます。 ただし、デバイスによってはこれらのパラメータ全てがサポートされているわけではありません。 パラメータがサポートされているかどうかは、isSupported(java.lang.String)で確認する必要があります。
戻り値:
指定されたデータ識別の値を返します。取得できなかった場合は0を返します。

getParameters

public android.os.Bundle getParameters(java.lang.String[] keys)
複数データを一度に取得する。 

指定された識別の値を取得します。

パラメータ:
key - 以下のパラメータキーを指定することができます。 ただし、デバイスによってはこれらのパラメータ全てがサポートされているわけではありません。 パラメータがサポートされているかどうかは、isSupported(java.lang.String)で確認する必要があります。
戻り値:
指定されたデータ識別の値をBundleに格納して返します。 取得できなかった値は0をセットします。 戻り値からデータを取り出すには、データ識別を用います。

例:

Bundle r = p.getParameters(keys);
int step = r.getInt(Pedometer.STEPS);
int distance = r.getFloat(Pedometer.DISTANCE);


isSupported

public boolean isSupported(java.lang.String key)
パラメータ(測定データ)のサポート確認。 

指定されたデータ識別がサポートされているかどうかの確認を行います。

パラメータ:
key - データ識別
戻り値:
true:サポートされている。
false:サポートされていない。

startBroadcastIntent

public int startBroadcastIntent()
パラメータ(測定データ)のIntent通知を開始します。 

500msec毎にパラメータ(測定データ)を通知します。 ACTION_MEASURE

戻り値:
成功:STATUS_OK
失敗:STATUS_NG

stopBroadcastIntent

public int stopBroadcastIntent()
パラメータ(測定データ)のIntent通知を停止します。 

500msecごとのIntent通知を停止します。 ただし、他のアプリがインテント通知を要求している場合は通知は停止しません。

戻り値:
成功:STATUS_OK
失敗:STATUS_NG