Zepp Theme

文字盤で表示できる値の一覧

Zepp OS の文字盤でデータを出す経路は 2 つあり、取れる値の範囲が違う。

実際に叩いた結果と戻り値の実例は API リファレンス にまとめてある。

経路 読み方 特徴
hmSensor hmSensor.createSensor(hmSensor.id.X).プロパティ JS から数値として読める。 自分で整形・計算できる。更新は自前(タイマー or addEventListener)
hmUI.data_type ウィジェットの type に指定する 値はシステムが勝手に描画・更新する。 JS からは読めない。代わりに hmSensor に無い値(現在気温・湿度・UV・日の出入り・高度など)が揃っている

hmSensor で読めない値は data_type で出す、という使い分けになる。


#1. hmSensor(JS から読める値)

const s = hmSensor.createSensor(hmSensor.id.STEP) のように作る。

id プロパティ 内容
TIME utc year month day hour minute second week(1〜7) 日時
lunar_year lunar_month lunar_day lunar_festival lunar_solar_term solar_festival 旧暦・祝日(中国向け)
getLunarMonthCalendar() getShowFestival() ※ getShowFestival() は時計の言語が中国語のときだけ動く
BATTERY current バッテリー残量 %
STEP current target 歩数 / 目標歩数
CALORIE current target 消費カロリー / 目標(kcal)
DISTANCE current 移動距離(target は無い)
HEART last current today 最後に測れた心拍 / 現在値 / 当日 0 時からの分単位配列(最大 1440 要素)
STAND current target 立った時間 / 目標(時間単位)
FAT_BURRING current target 脂肪燃焼 / 目標(分)※ 綴りが BURRING
PAI dailypai totalpai prepai0〜prepai6 当日 PAI / 累計 / 過去 7 日分
SPO2 current time retcode hourAvgofDay(24 要素) 血中酸素。start() で単発測定
STRESS current time ストレス値
BODY_TEMP current timeinterval 体温(単位の記載なし)
WEAR current 装着状態 0:未装着 1:装着中 2:運動中 3:不明
SLEEP getBasicInfo() → score deepMin startTime endTime 睡眠スコア・深い睡眠の分数・就寝/起床(0 時からの分)
getSleepStageData() → [{model, start, stop}] 睡眠ステージ。model は getSleepStageModel() の WAKE_STAGE / REM_STAGE / LIGHT_STAGE / DEEP_STAGE
getTotalTime() updateInfo() getSleepHrData()
WEATHER getForecastWeather() → cityName / forecastData.data[i].{high,low,index} / tideData.data[i].{sunrise,sunset}.{hour,minute} 予報の最高/最低気温と日の出入りのみ。現在気温・天気コード・湿度は hmSensor には無い(→ data_type を使う)
MUSIC artist title isPlaying 再生中の曲。audPlay() audPause() audPrev() audNext() audInit() で操作も可能
WORLD_CLOCK init() → getWorldClockCount() / getWorldClockCountInfo(i) → {city, hour, minute, timeZoneHour, timeZoneMinute} → uninit() ワールドクロック。※ドキュメントのサンプルは getWorldClockInfo(0) と書いており名前が食い違っているので要確認
VIBRATE scene + start() / stop() バイブ。1 ページに 1 インスタンスのみ

#更新方法

// 変化イベント(対応しているセンサーのみ)
step.addEventListener(hmSensor.event.CHANGE, () => { /* ... */ })

// 心拍だけ専用イベント
heart.addEventListener(hmSensor.event.LAST, cb)
heart.addEventListener(hmSensor.event.CURRENT, cb)
// onDestroy で removeEventListener すること(HEART のページに明記)

CHANGE が documented なのは CALORIE / DISTANCE / STAND / SPO2 / STRESS / FAT_BURRING / STEP / BATTERY / MUSIC / WEAR。 PAI / BODY_TEMP / SLEEP / TIME / WEATHER / WORLD_CLOCK にはイベントの記載が無いので、タイマーで読みに行く。


#2. hmUI.data_type(ウィジェットに自動バインドする値)

TEXT_IMG / IMG_PROGRESS / IMG_LEVEL / ARC_PROGRESS などの type に渡すと、 システムが値の取得と再描画をやってくれる。JS からは値を読めない。

分類 data_type
基本 BATTERY(0-100) STEP STEP_TARGET CAL CAL_TARGET HEART DISTANCE STAND STAND_TARGET
PAI・脂肪燃焼 PAI_DAILY PAI_WEEKLY FAT_BURNING FAT_BURNING_TARGET
天気 WEATHER_CURRENT(現在気温) WEATHER_LOW WEATHER_HIGH UVI AQI(中国本土のみ) HUMIDITY WIND
日の出入り・月 SUN_CURRENT SUN_RISE(HH:MM) SUN_SET(HH:MM) MOON(月齢)
生体 STRESS SPO2 SLEEP(HH:MM) READINESS
高度・フロア ALTIMETER ALTITUDE FLOOR
時計機能 ALARM_CLOCK(HH:MM) COUNT_DOWN STOP_WATCH
トレーニング TRAINING_LOAD VO2MAX RECOVERY_TIME MONTH_RUN_TIMES MONTH_RUN_DISTANCE
ショートカット(IMG_CLICK 専用) OUTDOOR_RUNNING WALKING OUTDOOR_CYCLING FREE_TRAINING POOL_SWIMMING OPEN_WATER_SWIMMING BREATH_TRAIN PHN

現在気温・湿度・UV・風・日の出入り・高度・フロア・月齢・アラーム時刻は hmSensor には無く、data_type でしか出せない。 逆に data_type の値は JS で加工できないので、「気温に応じて色を変える」などはできない。


#3. ステータスアイコン(IMG_STATUS)

Bluetooth やアラームのアイコンは IMG_STATUS ウィジェットで出す。

hmUI.createWidget(hmUI.widget.IMG_STATUS, {
  x: 0,
  y: 0,
  // w, h は省略可。省略すると画像のサイズをそのまま使う
  type: hmUI.system_status.DISCONNECT,
  src: 'status.png',
})
type 意味
hmUI.system_status.CLOCK アラームがオン
hmUI.system_status.DISCONNECT Bluetooth 未接続
hmUI.system_status.DISTURB おやすみモード
hmUI.system_status.LOCK 画面ロックがオン

状態に応じた表示/非表示はシステムが面倒を見る。状態を JS で読む API は無い。


#4. hmSetting(端末・ユーザー設定)

関数 返り値
getDeviceInfo() {width, height, screenShape(0:角/1:丸), deviceName, keyNumber, deviceSource}
getScreenType() hmSetting.screen_type. APP / WATCHFACE / SETTINGS / AOD — AOD 判定はこれ
getTimeFormat() 0:12 時間制 1:24 時間制
getMileageUnit() 0:メートル法 1:ヤード・ポンド法(ユーザー設定であってデータの単位ではない点に注意)
getLanguage() 言語番号
getUserData() {age, height, weight, gender, nickName, region}(未設定は 0)
getDateFormat() getWeightUnit() getWeightTarget() getSleepTarget() getDiskInfo() 未調査
setBrightness() setBrightScreen() setScreenOff() setScreenAutoBright() ほか 画面制御

#5. ドキュメントに無いもの

公式ドキュメントに記載が見つからなかったもの。使うなら別途裏取りが必要。

  • 未読通知の件数
  • 次のアラームの時刻を JS で読む手段(data_type.ALARM_CLOCK で表示はできる)
  • おやすみモード / Bluetooth 接続状態を JS で読む手段(アイコン表示のみ)
  • スマホ側のバッテリー残量
  • hmBle / hmApp — 文字盤 API のサイドバーには存在しない(ミニプログラム側の API)

#出典

https://docs.zepp.com/docs/watchface/api/hmSensor/sensorId/ 配下の各ページ、 .../hmUI/widget/data_type/、.../hmUI/widget/IMG_STATUS/、.../hmSetting/ 配下。