{"id":23,"date":"2015-05-28T13:26:19","date_gmt":"2015-05-28T13:26:19","guid":{"rendered":"http:\/\/stateoftheartsoftware.com\/docs\/?page_id=23"},"modified":"2015-05-28T13:26:39","modified_gmt":"2015-05-28T13:26:39","slug":"file-format-measurand","status":"publish","type":"page","link":"https:\/\/stateoftheartsoftware.com\/docs\/technical-documents\/file-format-measurand\/","title":{"rendered":"File Format: Measurand"},"content":{"rendered":"

\n\tMeasurand.cnf & Measurand.json
\n<\/h2>\n

\n\tMeasurand.cnf (Original Format)
\n<\/h3>\n

\n\tThe original file format is based on INI files and looks like this :-\n<\/p>\n

\r\n{EnergyTypes}\r\netElectric|Elec|Electric\r\netGas|Gas|Gas\r\n\r\n{EnergyUnits:etElectric}\r\neukW|kWh~kilowatt hour~kW~kilowatt|Y|Y\r\neukVA|kVAh~kVAh~kVA~kVA|Y|Y\r\neukVAr|kVArh~kVArh~kVAr~kVAr|Y|Y\r\neukVArl|kVArlh~kVArlh~kVArl~kVArl|Y|Y\r\neuAmps|A~Amps|N|N\r\neuVolts|V~Volts|N|N\r\neuFrequency|Hz~Frequency (Hz)|N|N\r\neuPF|PF~Power Factor|N|N\r\neuPC|%~Percentage|N|N\r\neukgCO2|kg CO2~kg CO2~kg CO2\/h~kg CO2\/h|Y|Y\r\neukgCO2e|kg CO2e~kg CO2e~kg CO2e\/h~kg CO2e\/h|Y|Y\r\n\r\n{EnergyUnits:etGas}\r\neuCM|m³~Cubic Metre~m³\/h~Cubic Metre per Hour|Y|Y\r\neuCF|ft³~Cubic foot~ft³\/h~Cubic Foot per Hour|Y|Y\r\neuTherms|Thm~Therms~Thm\/h~Therms per Hour|Y|Y\r\neukW|kWh~kilowatt hour~kW~kilowatt|Y|Y\r\neuPC|%~Percentage|N|N\r\neukgCO2|kg CO2~kg CO2~kg CO2\/h~kg CO2\/h|Y|Y\r\neukgCO2e|kg CO2e~kg CO2e~kg CO2e\/h~kg CO2e\/h|Y|Y\r\n<\/pre>\n
\n\tThis is only a small part of the original file to explain the rules of the format. The original has many more energy types.\n<\/p>\n
\n\tMeasurand.json (New format adopted in July 2012)
\n<\/h3>\n
\n\tJSON is a standard cross-platform data exchange format based on Java.  It can be read by many programming languages and is particularly useful for exchanging web data as it is read natively by Javascript.  For more details see this Wikipedia article<\/a>. The JSON version looks like this :-\n<\/p>\n
\r\n{\r\n    "Energy Types":{\r\n        "etElectric":{\r\n            "Internal Name":"etElectric",\r\n            "Short Name":"Elec",\r\n            "Long Name":"Electric",\r\n            "Unit Types":{\r\n                "eukW":{\r\n                    "Internal Name":"eukW",\r\n                    "Short Name":"kWh",\r\n                    "Long Name":"kilowatt hour",\r\n                    "Can Be Demand":true,\r\n                    "Demand Short Name":"kW",\r\n                    "Demand Long Name":"kilowatt",\r\n                    "Can Be Totalled":true\r\n                },\r\n                "eukVA":{\r\n                    "Internal Name":"eukVA",\r\n                    "Short Name":"kVAh",\r\n                    "Long Name":"kVAh",\r\n                    "Can Be Demand":true,\r\n                    "Demand Short Name":"kVA",\r\n                    "Demand Long Name":"kVA",\r\n                    "Can Be Totalled":true\r\n                },\r\n                "eukVAr":{\r\n                    "Internal Name":"eukVAr",\r\n                    "Short Name":"kVArh",\r\n                    "Long Name":"kVArh",\r\n                    "Can Be Demand":true,\r\n                    "Demand Short Name":"kVAr",\r\n                    "Demand Long Name":"kVAr",\r\n                    "Can Be Totalled":true\r\n                },\r\n                "eukVArl":{\r\n                    "Internal Name":"eukVArl",\r\n                    "Short Name":"kVArlh",\r\n                    "Long Name":"kVArlh",\r\n                    "Can Be Demand":true,\r\n                    "Demand Short Name":"kVArl",\r\n                    "Demand Long Name":"kVArl",\r\n                    "Can Be Totalled":true\r\n                },\r\n                "euAmps":{\r\n                    "Internal Name":"euAmps",\r\n                    "Short Name":"A",\r\n                    "Long Name":"Amps",\r\n                    "Can Be Demand":false,\r\n                    "Can Be Totalled":false\r\n                },\r\n                "euVolts":{\r\n                    "Internal Name":"euVolts",\r\n                    "Short Name":"V",\r\n                    "Long Name":"Volts",\r\n                    "Can Be Demand":false,\r\n                    "Can Be Totalled":false\r\n                },\r\n                "euFrequency":{\r\n                    "Internal Name":"euFrequency",\r\n                    "Short Name":"Hz",\r\n                    "Long Name":"Frequency (Hz)",\r\n                    "Can Be Demand":false,\r\n                    "Can Be Totalled":false\r\n                },\r\n                "euPF":{\r\n                    "Internal Name":"euPF",\r\n                    "Short Name":"PF",\r\n                    "Long Name":"Power Factor",\r\n                    "Can Be Demand":false,\r\n                    "Can Be Totalled":false\r\n                },\r\n                "euPC":{\r\n                    "Internal Name":"euPC",\r\n                    "Short Name":"%",\r\n                    "Long Name":"Percentage",\r\n                    "Can Be Demand":false,\r\n                    "Can Be Totalled":false\r\n                },\r\n                "eukgCO2":{\r\n                    "Internal Name":"eukgCO2",\r\n                    "Short Name":"kg CO2",\r\n                    "Long Name":"kg CO2",\r\n                    "Can Be Demand":true,\r\n                    "Demand Short Name":"kg CO2\\\/h",\r\n                    "Demand Long Name":"kg CO2\\\/h",\r\n                    "Can Be Totalled":true\r\n                },\r\n                "eukgCO2e":{\r\n                    "Internal Name":"eukgCO2e",\r\n                    "Short Name":"kg CO2e",\r\n                    "Long Name":"kg CO2e",\r\n                    "Can Be Demand":true,\r\n                    "Demand Short Name":"kg CO2e\\\/h",\r\n                    "Demand Long Name":"kg CO2e\\\/h",\r\n                    "Can Be Totalled":true\r\n                }\r\n            }\r\n        },\r\n"etGas":{\r\n    "Internal Name":"etGas",\r\n    "Short Name":"Gas",\r\n    "Long Name":"Gas",\r\n    "Unit Types":{\r\n        "euCM":{\r\n            "Internal Name":"euCM",\r\n            "Short Name":"m\\u00B3",\r\n            "Long Name":"Cubic Metre",\r\n            "Can Be Demand":true,\r\n            "Demand Short Name":"m\\u00B3\\\/h",\r\n            "Demand Long Name":"Cubic Metre per Hour",\r\n            "Can Be Totalled":true\r\n        },\r\n        "euCF":{\r\n            "Internal Name":"euCF",\r\n            "Short Name":"ft\\u00B3",\r\n            "Long Name":"Cubic foot",\r\n            "Can Be Demand":true,\r\n            "Demand Short Name":"ft\\u00B3\\\/h",\r\n            "Demand Long Name":"Cubic Foot per Hour",\r\n            "Can Be Totalled":true\r\n        },\r\n        "euTherms":{\r\n            "Internal Name":"euTherms",\r\n            "Short Name":"Thm",\r\n            "Long Name":"Therms",\r\n            "Can Be Demand":true,\r\n            "Demand Short Name":"Thm\\\/h",\r\n            "Demand Long Name":"Therms per Hour",\r\n            "Can Be Totalled":true\r\n        },\r\n        "eukW":{\r\n            "Internal Name":"eukW",\r\n            "Short Name":"kWh",\r\n            "Long Name":"kilowatt hour",\r\n            "Can Be Demand":true,\r\n            "Demand Short Name":"kW",\r\n            "Demand Long Name":"kilowatt",\r\n            "Can Be Totalled":true\r\n        },\r\n        "euPC":{\r\n            "Internal Name":"euPC",\r\n            "Short Name":"%",\r\n            "Long Name":"Percentage",\r\n            "Can Be Demand":false,\r\n            "Can Be Totalled":false\r\n        },\r\n        "eukgCO2":{\r\n            "Internal Name":"eukgCO2",\r\n            "Short Name":"kg CO2",\r\n            "Long Name":"kg CO2",\r\n            "Can Be Demand":true,\r\n            "Demand Short Name":"kg CO2\\\/h",\r\n            "Demand Long Name":"kg CO2\\\/h",\r\n            "Can Be Totalled":true\r\n        },\r\n        "eukgCO2e":{\r\n            "Internal Name":"eukgCO2e",\r\n            "Short Name":"kg CO2e",\r\n            "Long Name":"kg CO2e",\r\n            "Can Be Demand":true,\r\n            "Demand Short Name":"kg CO2e\\\/h",\r\n            "Demand Long Name":"kg CO2e\\\/h",\r\n            "Can Be Totalled":true\r\n        }\r\n    }\r\n}\r\n<\/pre>\n
\n\t \n<\/p>\n
\n\tAgain, this is only a small sample, but the format is obviously much more verbose!  So why use it?  It is easier to read by a human and is practically self-documenting, whereas the previous format was positively hieroglyphic in places.  It is also an interchangeable standard format and allows the addition of new data without breaking old code – something which should make future changes quicker to implement.\n<\/p>\n
\n\tGuide to adding energy types and units to JSON format file<\/strong>\n<\/p>\n
\n\t <\/p>\n","protected":false},"excerpt":{"rendered":"
Measurand.cnf & Measurand.json Measurand.cnf (Original Format) The original file format is based on INI files and looks like this :- {EnergyTypes} etElectric|Elec|Electric etGas|Gas|Gas {EnergyUnits:etElectric} eukW|kWh~kilowatt hour~kW~kilowatt|Y|Y eukVA|kVAh~kVAh~kVA~kVA|Y|Y eukVAr|kVArh~kVArh~kVAr~kVAr|Y|Y eukVArl|kVArlh~kVArlh~kVArl~kVArl|Y|Y euAmps|A~Amps|N|N euVolts|V~Volts|N|N euFrequency|Hz~Frequency (Hz)|N|N euPF|PF~Power Factor|N|N euPC|%~Percentage|N|N eukgCO2|kg CO2~kg CO2~kg CO2\/h~kg CO2\/h|Y|Y eukgCO2e|kg CO2e~kg CO2e~kg CO2e\/h~kg CO2e\/h|Y|Y {EnergyUnits:etGas} euCM|m³~Cubic Metre~m³\/h~Cubic Metre per Hour|Y|Y euCF|ft³~Cubic foot~ft³\/h~Cubic Foot per Hour|Y|Y euTherms|Thm~Therms~Thm\/h~Therms per Hour|Y|Y<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":19,"menu_order":12,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"_links":{"self":[{"href":"https:\/\/stateoftheartsoftware.com\/docs\/wp-json\/wp\/v2\/pages\/23"}],"collection":[{"href":"https:\/\/stateoftheartsoftware.com\/docs\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/stateoftheartsoftware.com\/docs\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/stateoftheartsoftware.com\/docs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/stateoftheartsoftware.com\/docs\/wp-json\/wp\/v2\/comments?post=23"}],"version-history":[{"count":1,"href":"https:\/\/stateoftheartsoftware.com\/docs\/wp-json\/wp\/v2\/pages\/23\/revisions"}],"predecessor-version":[{"id":24,"href":"https:\/\/stateoftheartsoftware.com\/docs\/wp-json\/wp\/v2\/pages\/23\/revisions\/24"}],"up":[{"embeddable":true,"href":"https:\/\/stateoftheartsoftware.com\/docs\/wp-json\/wp\/v2\/pages\/19"}],"wp:attachment":[{"href":"https:\/\/stateoftheartsoftware.com\/docs\/wp-json\/wp\/v2\/media?parent=23"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}