ECHONET Lite Web API ガイドライン

Web API ガイドラインのダウンロード ファイルリスト

(日本語版)
API仕様部 Version 1.1.6 ECHONET_Lite_Web_API_Specs_v1.1.6.pdf [PDF 2.2MB]
機器仕様部 Version 1.5.0 ECHONET_Lite_Web_API_Dev_Specs_v1.5.0.pdf [PDF 2.7MB]
機器仕様部 Version 1.5.0 errata ECHONET_Lite_Web_API_Dev_Specs_v1.5.0_errata.pdf [PDF 57KB]
Device Description(JSON)
(機器仕様部 Version 1.5.0 より抜粋)[zip圧縮]
Web_API_device_descriptions_v1.5.0.zip [zip 399KB]
DR関連サービス仕様 Version 1.0.0 ECHONET_Lite_Web_API_DR_Specs_v1.0.0.pdf [PDF 952KB]

 

(英語版)
API仕様部 Version 1.1.4 ECHONET_Lite_Web_API_Specs_v1.1.4_e.pdf [PDF 889KB]
機器仕様部 Version 1.4.1 ECHONET_Lite_Web_API_Dev_Specs_v1.4.1_e.pdf [PDF 2.5MB]
Device Description(JSON)
(機器仕様部 Version 1.4.1 より抜粋)[zip圧縮]
Web_API_device_descriptions_v1.4.1.zip [zip 366KB]

 

(参考)OpenAPI Document (YAML)
API仕様部V.1.1.6&機器仕様部V.1.5.0 対応版 [zip圧縮] Web_API_openapi_documents_v1.0.1.zip [zip 240KB]

背景

IoT技術の向上に伴い、クラウド環境を介したサービス提供モデルが進展しています。これらのモデルの中には、ECHONET Lite対応機器をクラウドを介してサービス事業者等へ提供するといった新しい提携サービスや応用アプリケーションが生まれつつあり、様々なビジネス展開が期待されています。

本ガイドライン公開目的

ECHONET Lite対応機器などを操作対象とする、Web APIを用いたシステム構築やアプリケーション実装指針(本ガイドライン)を策定・公開し、参考指針として活用いただくことで、エコーネットおよびその応用分野の更なる拡大・普及促進に繋がることを狙い、一般公開致します。

本ガイドラインの概要

ECHONET Lite Web APIガイドラインでは、宅内機器に対してECHONET Liteを用いて行う基本的な操作をクラウド経由で実現するユースケースを主対象として、Web APIモデルや機器オブジェクトのJSONモデルについて参考設計指針をまとめています。
ECHONET Lite Web APIガイドラインは、API仕様部と機器仕様部から構成されます。
具体的には、API仕様部は、ECHONET Lite Web APIモデルの基本方針やECHONET Lite仕様のWeb APIへのマッピング指針などを整理し、機器仕様部は、エアコンやスマートメータなどの機器オブジェクトを対象にしたDevice Description(JSON形式で記述した機器仕様)を提供しています。また、本Web APIは、ECHONET Liteに限らず様々な機器も操作対象にできる柔軟なモデルを採用しているため、広くIoT機器のクラウド外部公開向け操作APIとして活用いただくことが可能です。

今後の展開

応用操作まで対象を広げた第2版ガイドラインについても検討を進めて参ります。

【ガイドラインの使用について】
ここに掲載するガイドラインはだれでも閲覧でき、本ガイドラインに沿った製品の開発を行うことができます。
本ガイドラインの使用に際しては、以下の注意点をお読みいただき、ご了解の上ご使用ください。
ページの先頭へ