Dim Color Bulbs

SwitchBot API を使用して SwitchBot Color Bulb を一括操作する TypeScript アプリケーションです。

必要条件

• Node.js (v.20.6.0 以上)
• SwitchBot アカウント
• SwitchBot Color Bulb
• SwitchBot API トークンとシークレット

Important

Node.js v.20.6.0 以上としているのは、環境変数を --env-file フラグで読み込むためです。dotenv 等でやりくりできる場合はこれ以下でも構いません。

インストール

1. このリポジトリをクローンする:

   git clone https://github.com/yhakamay/dim-color-bulbs.git
   cd dim-color-bulbs

2. 必要な依存関係をインストールする:

   npm install

3. .env.local を自身のトークンとシークレットで更新する:

   TOKEN="<your_token>"
   SECRET="<your_secret>"

Note

トークンおよびシークレットの取得方法は以下を参照してください: https://blog.switchbot.jp/announcement/api-v1-1/

使用方法

1. プロジェクトを実行するには、以下のコマンドを使用します:

   npx tsx --env-file=.env.local index.ts <color> <brightness>

   • <color>: 設定する色 (例: 255:0:255)。省略時はデフォルトで 255:255:255。
   • <brightness>: 設定する明るさ (1 ~ 100)。省略時はデフォルトで 100。

2. アプリケーションは以下の操作を順に実行します:

   1. カラーバルブデバイスの取得
   2. カラーバルブの明るさを設定する
   3. カラーバルブの色を設定する

プロジェクト構成

dim-color-bulbs/
├── .env.local # 環境変数ファイル
├── index.ts # メインエントリーポイント
├── utils/ # ユーティリティ関数
│ ├── generateSign.ts # API 認証用の署名生成
│ ├── getDeviceIDs.ts # デバイス ID の取得
│ ├── sendCommand.ts # API コマンド送信
│ ├── setBrightness.ts # 明るさの設定
│ ├── setColor.ts # 色の設定
│ ├── setColorTemperature.ts # 色温度の設定 (非推奨)
│ └── turnOnColorBulbs.ts # カラーバルブのオン (非推奨)

注意事項

• SwitchBot API の利用にはインターネット接続が必要です。
• 環境変数が正しく設定されていない場合、アプリケーションはエラーをスローします。
• 以下の関数は非推奨です:
  • setColorTemperature: 色温度は色を設定する際に自動的に設定されるため、使用する必要はありません。
  • turnOnColorBulbs: 他のコマンドを送信すると自動的に電球がオンになるため、使用する必要はありません。

参照

• https://github.com/OpenWonderLabs/SwitchBotAPI/blob/main/README.md
• https://tsx.is/