🖼

【Web API / Vue.js】デバイスのバッテリーレベルに応じて変わる絵を作った

2023/08/29に公開

Vue.js

Web API

VueUse

tech

2023/07/28にVue.jsの勉強会はなんぼあってもいいですからねというイベントで登壇していました。

発表は結構緊張しちゃったので動画は貼らないのですが、Web Bluetooth APIで心拍数を表示しながら登壇を走り切るというネタで一笑いとれたので良かったです。

こちらで発表した中で、Battery Status APIを用いて変化する絵を作ったのでそれに関して軽くメモ記事として残しておきます。

▼サイトはこちら

▼GitHubはこちら

Battery Status APIとは？

MDNはこちらです。

バッテリー状態 API は、バッテリー API と呼ばれることの方が多いのですが、システムのバッテリー充電レベルに関する情報の提供、およびバッテリーレベルや充電状態が変化したときに発生するイベントによる通知を可能にします。これは、バッテリーが消耗したときにバッテリー消費を減らすためアプリのリソース使用状況を調整したり、データを失わないためにバッテリーが切れる前に変更点を保存したりするために使用できます。

現状、主要ブラウザではChrome, Edge, Opera以外ではサポートされていないようです。

https://caniuse.com/battery-status

プロパティから以下の情報を得る事ができます。

State	Description
charging	If the device is currently charging. （デバイスが充電中かどうか）
chargingTime	The number of seconds until the device becomes fully charged. （デバイスが完全に充電されるまでの秒数）
dischargingTime	The number of seconds before the device becomes fully discharged.（デバイスが完全に放電されるまでの秒数）
level	A number between 0 and 1 representing the current charge level.（現在の充電レベルを表す0～1の数値）

これらの値を、VueUseのuseBatteryですと以下のようなインターフェースで手軽に取得することが出来ます。

import { useBattery } from '@vueuse/core'

const { charging, chargingTime, dischargingTime, level } = useBattery()

https://vueuse.org/core/useBattery/

登壇がVueUseを使う内容だったので、今回はVueUseを使ってバッテリーレベルに応じて変わる絵を実装しました。

以下のような絵を閲覧することが出来ます。

バッテリーレベルに応じて

空の色
太陽と月の位置

が変わり、また充電中か否かにより犬のPC周りも変わります。

App.vueで基本的に完結しており、コード全容を以下に貼ります。

コード全容

<script setup lang="ts">
import { computed, reactive } from 'vue'
import { useBattery, useInterval } from '@vueuse/core'
import ImageBase from './assets/image/use_battery_background.png'
import Sun from './assets/image/use_battery_sun.png'
import Moon from './assets/image/use_batterry_moon.png'
import Cloud1Base from './assets/image/use_battery_cloud_01_base.png'
import Cloud1Gd1 from './assets/image/use_battery_cloud_01_gd_01.png'
import Cloud1Gd2 from './assets/image/use_battery_cloud_01_gd_02.png'
import Cloud2Base from './assets/image/use_battery_cloud_02_base.png'
import Cloud2Gd1 from './assets/image/use_battery_cloud_02_gd_01.png'
import Cloud2Gd2 from './assets/image/use_battery_cloud_02_gd_02.png'
import Kuki from './assets/image/use_battery_kuki.png'
import Flower from './assets/image/use_battery_flower.png'
import DogBase from './assets/image/use_battery_dog_base.png'
import DogTail1 from './assets/image/use_battery_dog_tail_1.png'
import DogTail2 from './assets/image/use_battery_dog_tail_2.png'
import Pc1 from './assets/image/use_battery_dog_pc_1.png'
import Pc2 from './assets/image/use_battery_dog_pc_2.png'
import Ereki1 from './assets/image/use_battery_ereki_1.png'
import Ereki2 from './assets/image/use_battery_ereki_2.png'
import Battery from './assets/image/use_battery_battery.png'

const battery = reactive(useBattery())

// 1500ミリ秒ごとにカウントアップ
const counter = useInterval(1500)

const interpolateColor = (color1: string, color2: string, ratio: number) => {
  // カラーコードを16進数からRGBに変換
  const r1 = parseInt(color1.substring(1, 3), 16)
  const g1 = parseInt(color1.substring(3, 5), 16)
  const b1 = parseInt(color1.substring(5, 7), 16)

  const r2 = parseInt(color2.substring(1, 3), 16)
  const g2 = parseInt(color2.substring(3, 5), 16)
  const b2 = parseInt(color2.substring(5, 7), 16)

  // ratioに基づいてカラーコードを補間
  const r = Math.round(r1 + (r2 - r1) * ratio)
  const g = Math.round(g1 + (g2 - g1) * ratio)
  const b = Math.round(b1 + (b2 - b1) * ratio)

  // RGBを16進数に変換してカラーコードを返す
  const hexR = r.toString(16).padStart(2, '0')
  const hexG = g.toString(16).padStart(2, '0')
  const hexB = b.toString(16).padStart(2, '0')
  return `#${hexR}${hexG}${hexB}`
}

// 色を取得する
const getColor = (
  batteryLevel: number,
  boundary: number,
  fromColor: string,
  middleColor: string,
  toColor: string
) => {
  if (batteryLevel <= boundary) {
    const ratio = batteryLevel / boundary
    return interpolateColor(toColor, middleColor, ratio)
  } else {
    const ratio = (batteryLevel - boundary) / (100 - boundary)
    return interpolateColor(middleColor, fromColor, ratio)
  }
}

// バッテリーレベル
const batteryLevel = computed(() => battery.level * 100)

// 空のベースカラー
const baseColor = computed(() => getColor(batteryLevel.value, 40, '#30a4f2', '#ff974e', '#746c88'))
// 空のグラデーションの上側
const gdTopColor = computed(() => getColor(batteryLevel.value, 40, '#1687d3', '#996971', '#241b39'))
// 空のグラデーションの下側
const gdBottomColor = computed(() =>
  getColor(batteryLevel.value, 40, '#a2d0ee', '#ffe142', '#c7b5c0')
)
</script>

<template>
  <div class="wrapper">
    <div class="image" :style="{ backgroundColor: baseColor }">
      <div class="gd-top1" :style="{ backgroundColor: gdTopColor, opacity: 0.2 }"></div>
      <div class="gd-top2" :style="{ backgroundColor: gdTopColor, opacity: 0.2 }"></div>
      <div class="gd-top3" :style="{ backgroundColor: gdTopColor, opacity: 0.2 }"></div>
      <div class="gd-top4" :style="{ backgroundColor: gdTopColor, opacity: 0.2 }"></div>
      <div class="gd-bottom1" :style="{ backgroundColor: gdBottomColor, opacity: 0.2 }"></div>
      <div class="gd-bottom2" :style="{ backgroundColor: gdBottomColor, opacity: 0.2 }"></div>
      <div class="gd-bottom3" :style="{ backgroundColor: gdBottomColor, opacity: 0.2 }"></div>
      <div class="gd-bottom4" :style="{ backgroundColor: gdBottomColor, opacity: 0.2 }"></div>
      <img class="image__base" :src="ImageBase" alt="" />
      <img
        class="sun"
        :src="Sun"
        alt=""
        :style="{
          position: 'absolute',
          top: `calc(4% + ${100 - batteryLevel} * 0.55%)`,
          right: '10%'
        }"
      />
      <img
        class="moon"
        :src="Moon"
        alt=""
        :style="{
          position: 'absolute',
          top: `calc(58% - ${100 - batteryLevel} * 0.55%)`,
          right: '10%'
        }"
      />
      <div class="cloud cloud--1">
        <img class="cloud__base" :src="Cloud1Base" alt="" />
        <img class="cloud__gd1" :src="Cloud1Gd1" alt="" />
        <img class="cloud__gd2" :src="Cloud1Gd2" alt="" />
      </div>
      <div class="cloud cloud--2">
        <img class="cloud__base" :src="Cloud2Base" alt="" />
        <img class="cloud__gd1" :src="Cloud2Gd1" alt="" />
        <img class="cloud__gd2" :src="Cloud2Gd2" alt="" />
      </div>
      <img class="flower flower--1" :src="Flower" alt="" />
      <img class="flower flower--2" :src="Flower" alt="" />
      <img class="kuki" :src="Kuki" alt="" />
      <div class="dog">
        <div class="dog__pc">
          <img
            v-show="counter % 2 === 0 && battery.charging"
            class="dog__ereki"
            :src="Ereki1"
            alt=""
          />
          <img
            v-show="counter % 2 !== 0 && battery.charging"
            class="dog__ereki"
            :src="Ereki2"
            alt=""
          />
          <img v-show="battery.charging" class="dog__battery" :src="Battery" />
          <img v-show="counter % 2 === 0" class="dog__mac" :src="Pc1" alt="" />
          <img v-show="counter % 2 !== 0" class="dog__mac" :src="Pc2" alt="" />
        </div>
        <img class="dog__base" :src="DogBase" alt="" />
        <img v-show="counter % 2 === 0" class="dog__tail dog__tail--1" :src="DogTail1" alt="" />
        <img v-show="counter % 2 !== 0" class="dog__tail dog__tail--2" :src="DogTail2" alt="" />
      </div>
    </div>
  </div>
  <div v-if="!battery.isSupported" class="info">
    お使いのブラウザではAPIがサポートされていません
  </div>
  <div v-else class="info">
    Charging: {{ battery.charging }}<br />
    Battery label: {{ battery.level }}<br />
    Charging Time: {{ battery.chargingTime }}<br />
    DischargingTime: {{ battery.dischargingTime }}
  </div>
</template>

<style scoped>
@keyframes cloudAnime1 {
  0% {
    transform: translateX(0) translateY(0);
  }
  30% {
    transform: translateX(-7px) translateY(-5px);
  }
  60% {
    transform: translateX(5px) translateY(-7px);
  }
  100% {
    transform: translateX(0) translateY(0);
  }
}

@keyframes cloudAnime2 {
  0% {
    transform: translateX(0) translateY(0);
  }
  30% {
    transform: translateX(-12px) translateY(-7px);
  }
  60% {
    transform: translateX(3px) translateY(-5px);
  }
  100% {
    transform: translateX(0) translateY(0);
  }
}

@keyframes flower1 {
  0% {
    transform: translateX(0) translateY(0);
  }
  30% {
    transform: translateX(-3px) translateY(-2px) rotate(-4deg);
  }
  100% {
    transform: translateX(0) translateY(0);
  }
}

@keyframes flower2 {
  0% {
    transform: translateX(0) translateY(0);
  }
  30% {
    transform: translateX(-3px) translateY(-2px) rotate(-8deg);
  }
  100% {
    transform: translateX(0) translateY(0);
  }
}
.wrapper {
  text-align: center;
  padding-top: 0;
}
.image {
  margin-inline: auto;
  position: relative;
  overflow: hidden;
  width: 700px;
  max-width: 100%;
  border-radius: 16px;
}

.image__base {
  position: relative;
  z-index: 10;
  width: 100%;
  vertical-align: top;
}

.cloud {
  position: relative;
}

.cloud--1 {
  width: 21%;
  animation: cloudAnime1 11s infinite;
  position: absolute;
  top: 5%;
  left: 6%;
}

.cloud--2 {
  width: 10%;
  animation: cloudAnime2 11s infinite;
  position: absolute;
  top: 24%;
  left: 25%;
}

.cloud__base,
.cloud__gd1,
.cloud__gd2 {
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
  height: auto;
}

.gd-bottom1 {
  position: absolute;
  bottom: 40%;
  left: 0;
  width: 100%;
  height: 27%;
}

.gd-bottom2 {
  position: absolute;
  bottom: 40%;
  left: 0;
  width: 100%;
  height: 22%;
}

.gd-bottom3 {
  position: absolute;
  bottom: 40%;
  left: 0;
  width: 100%;
  height: 16%;
}

.gd-bottom4 {
  position: absolute;
  bottom: 40%;
  left: 0;
  width: 100%;
  height: 12%;
}

.gd-top1 {
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
  height: 20%;
}

.gd-top2 {
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
  height: 16%;
}

.gd-top3 {
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
  height: 12%;
}

.info {
  text-align: center;
  font-family: 'DotGothic16', sans-serif;
  font-size: 16px;
  margin-top: 10px;
}

.sun {
  width: 10%;
  height: auto;
}

.moon {
  width: 6.7%;
  height: auto;
}

.flower {
  position: absolute;
  width: 12%;
  height: auto;
  z-index: 20;
}

.flower--1 {
  left: 3%;
  bottom: 5%;
  animation: flower1 infinite 4s;
}

.flower--2 {
  left: 7%;
  bottom: -5%;
  animation: flower2 infinite 4s;
}

.kuki {
  position: absolute;
  width: 10%;
  bottom: 0;
  left: 0;
  height: auto;
  z-index: 15;
}

.dog {
  position: absolute;
  top: 57%;
  left: 30%;
  z-index: 20;
  width: 19%;
}

.dog__base {
  width: 100%;
  height: auto;
  position: relative;
  z-index: 10;
}

.dog__tail {
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
  height: 100%;
  z-index: 15;
}

.dog__pc {
  position: absolute;
  z-index: 5;
  width: 86%;
  top: 6%;
  left: -50%;
}

.dog__battery {
  position: absolute;
  bottom: 0;
  left: 16%;
  width: 30%;
}

.dog__mac {
  position: relative;
  z-index: 5;
  width: 96%;
  height: auto;
}

.dog__ereki {
  position: absolute;
  top: -20%;
  left: -8%;
  width: 100%;
  height: auto;
}
</style>

いくつか重要なポイントのみ解説します。

色のグラデーション変化を計算する関数

色をバッテリーレベルに応じて徐々に変化させるという方法を知らなかったので、ChatGPTくんにお願いして関数を作ってもらいました。

const interpolateColor = (color1: string, color2: string, ratio: number) => {
  // カラーコードを16進数からRGBに変換
  const r1 = parseInt(color1.substring(1, 3), 16)
  const g1 = parseInt(color1.substring(3, 5), 16)
  const b1 = parseInt(color1.substring(5, 7), 16)

  const r2 = parseInt(color2.substring(1, 3), 16)
  const g2 = parseInt(color2.substring(3, 5), 16)
  const b2 = parseInt(color2.substring(5, 7), 16)

  // ratioに基づいてカラーコードを補間
  const r = Math.round(r1 + (r2 - r1) * ratio)
  const g = Math.round(g1 + (g2 - g1) * ratio)
  const b = Math.round(b1 + (b2 - b1) * ratio)

  // RGBを16進数に変換してカラーコードを返す
  const hexR = r.toString(16).padStart(2, '0')
  const hexG = g.toString(16).padStart(2, '0')
  const hexB = b.toString(16).padStart(2, '0')
  return `#${hexR}${hexG}${hexB}`
}

当時の自分としては何も考えすプロダクトにこのコードを組み込みましたが、眺めてみるとカラーコードのR, G, Bごとに16進数から10進数に直し、0〜100の間（今回バッテリーレベルに関しては使いやすいよう*100しています）の比率で計算して、また16進数に直すという技をつかっているようです。

こちらを以下のようにして扱っています。

// 色を取得する
const getColor = (
  batteryLevel: number,
  boundary: number,
  fromColor: string,
  middleColor: string,
  toColor: string
) => {
  if (batteryLevel <= boundary) {
    const ratio = batteryLevel / boundary
    return interpolateColor(toColor, middleColor, ratio)
  } else {
    const ratio = (batteryLevel - boundary) / (100 - boundary)
    return interpolateColor(middleColor, fromColor, ratio)
  }
}

// 空のベースカラー
const baseColor = computed(() => getColor(batteryLevel.value, 40, '#30a4f2', '#ff974e', '#746c88'))
// 空のグラデーションの上側
const gdTopColor = computed(() => getColor(batteryLevel.value, 40, '#1687d3', '#996971', '#241b39'))
// 空のグラデーションの下側
const gdBottomColor = computed(() =>
  getColor(batteryLevel.value, 40, '#a2d0ee', '#ffe142', '#c7b5c0')
)

また、犬の交互のアニメーションに関しては、VueUseのuseIntervalを使って1500ミリ秒ごとに値がカウントアップするようにして、それで表示を切り替えています。

// 1500ミリ秒ごとにカウントアップ
const counter = useInterval(1500)

<img v-show="counter % 2 === 0" class="dog__tail dog__tail--1" :src="DogTail1" alt="" />
<img v-show="counter % 2 !== 0" class="dog__tail dog__tail--2" :src="DogTail2" alt="" />

https://vueuse.org/shared/useInterval/

きれいに書けなかったのが悔しいところですが、太陽と月の位置は:styleで愚直に計算しています。

<img
  class="sun"
  :src="Sun"
  alt=""
  :style="{
    position: 'absolute',
    top: `calc(4% + ${100 - batteryLevel} * 0.55%)`,
    right: '10%'
  }"
/>
<img
  class="moon"
  :src="Moon"
  alt=""
  :style="{
    position: 'absolute',
    top: `calc(58% - ${100 - batteryLevel} * 0.55%)`,
    right: '10%'
  }"
/>

バッテリーレベルに応じて何かをやるというのは、実はアイデアがたくさん出てくるのではないかと思っているので、これをみて面白そうだと思った方が何か作ってくれるのを期待しています。
（Chromium系でしか見れないのがざんねん…！）

おわりに

登壇に関しては緊張して失敗してしまいましたが、温かい声をかけてくれる人が多くてすごくあったか勉強会でした。
このような実装もでき、楽しかったです。
アルゴリズムさんの今後の勉強会にも期待しましょう…！

https://algorithms.connpass.com/

Battery Status APIとは？

色のグラデーション変化を計算する関数

おわりに

Discussion