Machine Readable Appendix (MRA)
MRA is a data file that describes the contents of “APPENDIX Detailed Requirements for ECHONET Device objects” in JSON format.
Please refer to the release notes for supported devices. MRAs are provided as JSON data, and a tool (MRAViewer) for viewing the contents of MRAs with a Web browser is available from Kanagawa Institute of Technology (KAIT). The Device Descriptions (DDs) of the ECHONET Lite Web APIs are created using MRA. This translation is done by using a tool (eDataModelsGen) provided by Japan Advanced Institute of Science and Technology (JAIST), which can automatically generate DDs from MRAs.
MRA Data and guidebook (English version) download
Links to MRA-related tools (Supporting MRA Data version 1.1.1)
Background
“APPENDIX Detailed Requirements for ECHONET Device objects” are defined as detailed specifications for the property structure of the specified classes for each device. In order to implement a program that operates a device or a controller, the developer usually extracts the necessary commands and parameters from the specifications published in PDF format, translates them into the messages on the ECHONET Lite communication stack, and codes them manually. In this case, the developer writes the necessary code by following the values in the property table with his eyes, which not only takes a lot of man-hours but also creates a situation where mistakes can easily occur. In order to avoid this situation, a format suitable for handling the contents of device object specifications electronically instead of manually allow the developer to build a more efficient coding environment.
Purpose and positioning of MRA disclosure
- Purpose of disclosure:
MRA is disclosed as reference data to be used in the software that handles ECHONET Lite for the purpose of providing machine-readable data of device object specifications based on the above background.
- Positioning:
The MRA is reference data and does not replace the specifications in the Detailed Requirements for ECHONET Device object.
- Coverage version:
Please see the Release Notes.
- Disclaimer:
Please refer the ECHONET Lite Standards, Detailed Requirements for ECHONET Device objects, and AIF Specifications as formal standard specifications when you get certified under the ECHONET Lite Specification Certification System and AIF Specification Certification System.
Future Developments
We plan to update the MRA data when we update the DD. With your comments and feedback, we will continue to improve MRA to the data that is easier to use and more valuable.
Acknowledgements
This MRA was developed as part of a joint research project between KAIT, JAIST, and the ECHONET Consortium. We received many supports from Professor Isshiki of KAIT, Vice President Tan of JAIST, and other researchers throughout the development of the MRA. We would like to express our deepest gratitude to them.
