Documents how to add device definitions in README (#23)

banban525 · Nov 20, 2023 · c6941c9 · c6941c9
1 parent 5aba2fd
commit c6941c9
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/README.ja.md b/README.ja.md
@@ -269,6 +269,27 @@ ECHONET Liteの「温度設定値」が1度単位なので対応できません
 * (日本語) https://echonet.jp/spec_g/#standard-05
 * (英語) https://echonet.jp/spec-en/#standard-05
 
+### デバイスの定義を追加したい
+
+ECHONETLite2MQTTはデバイス定義として [Echonet lite Machine Readable Appendix (MRA)](https://echonet.jp/spec_mra_rq1/) を使用しています。
+しかし、MRAにないデバイスクラス、またはメーカー独自の拡張を使用したい場合があります。
+"MRA_custom"フォルダにeoj名のJsonファイルを作ると、MRAの定義を上書きすることができます。
+
+例: エアコン(eoj=0x0130)の場合
+```
+/MRA_custom/0x0130.json
+
+{
+  "eoj": "0x0130"
+  ...
+}
+
+```
+
+ファイルフォーマットは、 [Echonet lite Machine Readable Appendix (MRA)](https://echonet.jp/spec_mra_rq1/) を参考にしてください。
+また、 "MraTypes.schema.json" にJson Schemaが用意されています。
+
+
 ## 使用しているサードパーティ
 
 * リポジトリ内の画像は"いらすとや" (https://www.irasutoya.com/) の素材を使用しています。

diff --git a/README.md b/README.md
@@ -268,6 +268,27 @@ See specs below.
 * (ja) https://echonet.jp/spec_g/#standard-05
 * (en) https://echonet.jp/spec-en/#standard-05
 
+### I want to add a device definition
+
+ECHONETLite2MQTT uses [Echonet lite Machine Readable Appendix (MRA)](https://echonet.jp/spec_mra_rq1/) as a device definition.
+However, you may want to use a device class that is not in MRA, or a manufacturer-specific extension.
+You can overwrite the MRA definition by creating a Json file with the eoj name in the "MRA_custom" folder.
+
+Example: For air conditioner (eoj=0x0130)
+````
+/MRA_custom/0x0130.json
+
+{
+   "eoj": "0x0130"
+   ...
+}
+
+````
+
+For the file format, please refer to [Echonet lite Machine Readable Appendix (MRA)](https://echonet.jp/spec_mra_rq1/).
+Also, Json Schema is provided in "MraTypes.schema.json".
+
+
 ## Third party use
 
 * The images in the repository use materials such as "いらすとや" (https://www.irasutoya.com/).