Web API で使う

Web API で使う

X-remoの基本的な使い方

Web APIとは

Web API(ウェブエーピーアイ/Web Application Programming Interface)とは、インターネットやローカルネットワークを経由して、プログラムやシステム間で機能やデータを共有する仕組みです。メーカーが公開している仕様をもとに、HomeKitに対応していない機器などを操作できます。たとえば、Nature Remo(Nature株式会社)の赤外線信号や、REGZA(TVS REGZA株式会社)の音量・チャンネル操作などをX-remoに統合できます。

何ができるの?

ネットワーク上の機器を制御
HTTP APIに対応した機器を、X-remoのボタンから操作できます。APIのパス、クエリ、ヘッダ、JSON bodyをボタンごとに設定できます。NASや録画サーバーなど、家庭内ネットワーク上の機器に用意したAPIをボタンから実行できます。
テレビリモコンを簡単設定
TVセット展開時に、テレビ操作をまとめて設定できます。ボタンを1つずつ細かく作る手間を減らせます(*)。
シーン検索に便利なシークバー
録画番組の再生状況を表示し、シークバーで見たい位置へ移動できます(*)。
  • ※ 対応するテレビに限ります。

利用に必要なもの

  • X-remoをインストールしたiPhone / iPad
  • Web API対応デバイス(Nature Remo、REGZAなど)

セットアップの手順

APIプリセットの登録

  • APIプリセットとは、APIにアクセスすための基本情報です。後述のボタンアクションで指定することで簡単に接続先等の情報をまとめて管理・変更ができます。
  • 一部のテレビでは「設定補助」を使用することで、プロファイルの自動設定ができるようになりました(Ver.1.2.0では株式会社東芝 もしくは TVS REGZA株式会社製REGZAのみ)。

ギアアイコンをロングプレスし、設定をタップ

APIプロファイルの+ボタンをタップ

APIプロファイル名とベースURLを入力、適宜デフォルトパス、認証方法等を入力し、確定ボタンをタップ

ボタンアクションの登録

ギアアイコンをロングプレスし、ボタン編集をタップ

ユニット追加をタップ

追加したいボタンユニットを選択

配置されたユニットの設定したいボタンをタップ

アクション種別で「API」を選択したら、プロファイルやメソッド、パスなどを入力して確定

確定アイコンをタップして設定完了

  • 一部のAPIプロファイルでは、プロファイル選択時点で「プリセットから代入」という項目が使用可能になり、メソッドやパスが自動入力されます(株式会社東芝 もしくは TVS REGZA株式会社製REGZAのAPI使用時)。