Hue

Namespace

Hue

Description:
  • Philips Hue管理用オブジェクト
Source:

Methods

(static) dummy()

Description:
  • ダミーコールバック関数
Source:

(static) getState() → {Promise.<void>}

Description:
  • 現在の状態を取得する
Source:
Returns:
完了時にコールバックが呼ばれる
Type
Promise.<void>

(static) initialize(userKey, userFunc, Optionsopt) → {Promise.<string>}

Description:
  • Hueハンドラの初期化
Source:
Parameters:
Name Type Attributes Description
userKey string 既存のHueユーザーキー（なければ空文字）
userFunc function 状態変更時に呼ばれるコールバック関数 (ip, response, error) => {}
Options object <optional>
 オプション設定
Properties
Name Type Attributes Default Description
appName string <optional>
 'hueManager' アプリケーション名
deviceName string <optional>
 hostname デバイス名
userName string <optional>
 'sugilab' ユーザー名
debugMode boolean <optional>
 false デバッグモード有効化
bridgeIp string <optional>
 ブリッジのIP指定（指定時は自動検索スキップ）
requestTimeout number <optional>
 5000 HTTPリクエストタイムアウト(ms)
searchTimeout number <optional>
 20000 ブリッジ検索タイムアウト(ms)
maxRetries number <optional>
 3 ブリッジ検索リトライ回数
pollInterval number <optional>
 5000 Linkボタン監視等のポーリング間隔(ms)
Returns:
取得または確認されたUserKey
Type
Promise.<string>

(static) initializeCancel()

Description:
  • 初期化処理をキャンセルする
Source:

(static) objectSort(obj) → {object}

Description:
  • オブジェクトをキーでソートして返す
Source:
Parameters:
Name Type Description
obj object ソート対象オブジェクト
Returns:
ソート済みオブジェクト
Type
object

(static) searchBridge(timeout) → {Promise.<Array>}

Description:
  • Hue Bridgeをネットワーク内から検索する
Source:
Parameters:
Name Type Description
timeout number タイムアウト時間(ミリ秒)
Throws:
検索エラー時
Type
Error
Returns:
発見されたブリッジのリスト
Type
Promise.<Array>

(static) setState(url, bodyObj) → {Promise.<void>}

Description:
  • 状態を設定（制御）する
Source:
Parameters:
Name Type Description
url string 制御対象のAPIエンドポイント (e.g. '/lights/1/state')
bodyObj object | string 制御内容のJSONオブジェクトまたは文字列
Returns:
完了時にコールバックが呼ばれる
Type
Promise.<void>

(static) sleep(ms) → {Promise.<void>}

Description:
  • 指定時間スリープする
Source:
Parameters:
Name Type Description
ms number 待機時間(ミリ秒)
Returns:
Type
Promise.<void>