I’ve been experimenting with how changes to a static JSON file for a device impact how it appears in the UI, specifically UI7. I’ve looked at the WIKI articles and many posts in the forum and have arrived at a few conclusions.
- As with most of the documentation, that for the static JSON file is sparse, incomplete, and inconsistent or out of date.
- Many forum members have posted results of their experiments on modifications to these files.
- There is a real need for complete and concise documentation for the attribute-value pairs that make up the static JSON file used by the Vera UI.
- Be leery of wiki articles that haven’t been touched in years.
Developers should not have to experiment to find out how the data in this file works. A good document for the static JSON file should probably look like a table and contain at least:
- A description of each tag/attribute; its purpose
- Allowable values for each attribute and the units or meaning of each
- Whether the attribute is required or optional
- The UI version that uses the attribute; UI5? UI7? Both?
- The correct hierarchy of attributes in the file.
If the developers at Vera think of themselves as professionals then they need to do the entire job - not just bang out code. This document should be a living document; updated and corrected as the product evolves.