DNA Energy Read and Write APIs.
\nTo get authentication credentials, please contact DNA Energy support team.
\n{{host}}: https://api.dnaenergy.liveThis command will return a list of all devices recording
data at site.
When filtering the info list, the key items to filter for are the following parameters.
\n\"device_object_id\" - This is the indetifier for {{device-id}}
\n\"friendly_name\" - This is the device name and can be used to identify what asset is returning data
\n","urlObject":{"path":["api","sites","{{site_id}}","devices"],"host":["{{host}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"}],"variable":[]}},"response":[],"_postman_id":"d6b66429-81aa-4a87-a6f3-0d8b524a0776"},{"name":"Get registers","id":"42013f2f-c6da-43dc-ae2c-c18faa548c30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/registers","description":"After using the “Get Devices” command all devices will return a \"device_object_id\", this can be used in the “Get Registers” command to return a list of all the devices available energy registers.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","registers"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"42013f2f-c6da-43dc-ae2c-c18faa548c30"},{"name":"Get latest measurement","id":"de326c74-1fe5-444e-afe4-0f88476b272b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"registers\": [\"GRID.VoltsPhaseA\",\"GRID.VoltsPhaseB\",\"GRID.VoltsPhaseC\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/measurements/latest","description":"registers: this is an array of register type label name that you can get from calling API endpoint GET_Regs (Check #2) [OPTIONAL]The measurements for every device can be queried through API, once the energy registers are known they can be put in the measurement query to download data for that device. The user should specify what register they want to be returned inside the “registers” array, the available registers can be retrieved from the ‘Get Registers” command.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","measurements","latest"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8cce987e-5cbe-4f44-8748-c1f6818bf18b","name":"Get latest measurement","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"registers\": [\"GRID.VoltsPhaseA\",\"GRID.VoltsPhaseB\",\"GRID.VoltsPhaseC\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/measurements/latest"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:01:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"268"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"05401b8b-c936-4e3d-abe9-e373e488619a"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"268"},{"key":"x-amz-apigw-id","value":"T0V3HF1UywMEnuA="},{"key":"etag","value":"W/\"10c-LkuRQEeXtubF/LYuCtmSa7rB5Nk\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de69c6-43733d711061624c3dee27bc;Parent=4228bd3d7f5fbdd0;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"_id\": \"000001c001110200\",\n \"measurements\": [\n {\n \"label\": \"GRID.VoltsPhaseB\",\n \"units\": \"V\",\n \"value\": 242.745\n },\n {\n \"label\": \"GRID.VoltsPhaseC\",\n \"units\": \"V\",\n \"value\": 238.588\n },\n {\n \"label\": \"GRID.VoltsPhaseA\",\n \"units\": \"V\",\n \"value\": 243.863\n }\n ],\n \"updated_at\": \"2024-02-27T23:01:26.224Z\"\n }\n ]\n}"}],"_postman_id":"de326c74-1fe5-444e-afe4-0f88476b272b"},{"name":"Get measurements (long)","id":"2549716b-0dc2-48bf-862e-7f80dfe77664","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"registers\": [\"GRID.PowerkW\", \"GRID.PowerkVA\"],\n \"sampling\": \"hour\",\n \"start_time\": \"2024-01-26T08:00:00Z\",\n \"end_time\": \"2024-01-27T08:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/measurements","description":"sampling: This value is the sampling group to aggregate of the given time range [OPTIONAL]second:grouping every 5 second, this is only valid on 1 minute interval between start_time and end_timeminute: grouping every 5 minutehour: grouping every 1 hourday: grouping every 24 hourstart_time: format (YYYY-MM-DDTHH:mm:ssZ) [optional]end_time: format (YYYY-MM-DDTHH:mm:ssZ) [optional]registers: this is an array of register type label name that you can get from calling API endpoint GET_Regssecond: if the interval between start_time and end_time is less than or equal to 1 minuteminute: if the interval between start_time and end_time is more than 1 minute and equal or less than 1 hourhour: if the interval between start_time and end_time is more than 1 hour and less than or equal to 24 hours (1 day)day: if the interval between start_time and end_time is more than 1 dayThe measurements long query allows the client to specify the start and end time of data to be returned with the specified sampling rate.
\nThe result of the aggregated_value is calculated by adding the latest data points in the specified sampling batch from various objects under the device, that can provide the specified data registers. Additionally, the data points should fall under the given date-time range.
Standard API calls to retrieve site measurements
\n","_postman_id":"71548709-b723-4cdd-bc46-0f081245a3c2"},{"name":"DNA Site Controller","item":[{"name":"Set register Lt","id":"810067c3-08b1-480b-ab9b-631d464629d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": -62300\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/register_blocks/controlled_load","description":"This endpoint sends set register block command call to the site controller control object, e.g., 0000002701100100. The command type is to set Lt
The site load limit, the site controller will restrict the site to prevent this value from being exceeded. Lt can not exceed the maximum site load or the safety restrictions set by DNA. The command will timeout back to default after 30 minutes.
\nThis register lets the client set the site controller Load Target, please refer to the DNA Site Controller document on how these parameters should be set.
\n","urlObject":{"path":["api","sites","{{site_id}}","register_blocks","controlled_load"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8099a9ae-9797-4ccd-b98c-9e6312152e1f","name":"Set register Lt","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": -62300\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/register_blocks/controlled_load"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:03:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"76399c6d-ab49-46d6-834f-f4c4674701b3"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"16"},{"key":"x-amz-apigw-id","value":"T0WJDHWOSwMEOIg="},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6a39-62a8c83c4398010855e622aa;Parent=4787ddcf8f6db44f;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"810067c3-08b1-480b-ab9b-631d464629d4"},{"name":"Set register Sd","id":"9e539fac-08c5-47d4-ba5a-1fb38d7d89bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": -12000\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/register_blocks/storage_discharge","description":"This endpoint sends set register block command call to the site controller control object, e.g., 0000002701100100. The command type is to set Sd
The site storage discharging point limit, when this limit is reached the site controller will begin discharging all controlled storage devices, such as batteries. Sd can not exceed Lt and must be greater than Sc. The command will timeout back to default after 30 minutes.
\nThis register lets the client set the site controller Storage (Battery) Discharge Target, please refer to the DNA Site Controller document on how these parameters should be set.
\n","urlObject":{"path":["api","sites","{{site_id}}","register_blocks","storage_discharge"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"662dd360-5e49-4616-800b-23e88cf8e5a7","name":"Set register Sd","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": -12000\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/register_blocks/storage_discharge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:03:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"9334c078-8426-43ac-bbcf-3cc5f2a9b5c4"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"16"},{"key":"x-amz-apigw-id","value":"T0WLcHU2SwMEbzQ="},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6a48-70c200e36c53872c3c698093;Parent=29ec5dc0bd78baca;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"9e539fac-08c5-47d4-ba5a-1fb38d7d89bd"},{"name":"Set register Sc","id":"b927d330-355f-43c9-bd4f-9e390e528b20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": -12000\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/register_blocks/storage_charge","description":"This endpoint sends set register block command call to the site controller control object, e.g., 0000002701100100. The command type is to set Sc
The site storage charging point limit, when this limit is reached the site controller will begin charging all controlled storage devices, such as batteries. Sc can not exceed Sd and must be greater than Et. The command will timeout back to default after 30 minutes.
\nThis register lets the client set the site controller Storage (Battery) Charge Target, please refer to the DNA Site Controller document on how these parameters should be set.
\n","urlObject":{"path":["api","sites","{{site_id}}","register_blocks","storage_charge"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"04af6353-1d14-4b02-9908-03ccc223981b","name":"Set register Sc","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": -12000\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/register_blocks/storage_charge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:03:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"f045d30c-af2b-4627-8976-48580cb25e73"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"16"},{"key":"x-amz-apigw-id","value":"T0WNeF0lSwMEu9Q="},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6a55-3f80b6c3786274da4e6d3019;Parent=204086fe7da06182;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"b927d330-355f-43c9-bd4f-9e390e528b20"},{"name":"Set register Et","id":"b8c41f64-2ea6-419c-9425-0f10648aa01c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": -12000\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/register_blocks/solar","description":"This endpoint sends set register block command call to the site controller control object, e.g., 0000002701100100. The command type is to set Et
StartFragment
\nThe site export limit, the site controller will restrict the site to prevent this value from being exceeded. Et can not exceed the maximum site export limit or the safety restrictions set by DNA. The command will timeout back to default after 30 minutes.
\nEndFragment
\nThis register lets the client set the site controller Export Limit Target, please refer to the DNA Site Controller document on how these parameters should be set.
\n","urlObject":{"path":["api","sites","{{site_id}}","register_blocks","solar"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"49415b4c-fc6a-4c7d-941b-676bd20a9680","name":"Set register Et","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": -12000\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/register_blocks/solar"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:04:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"b3db7aa5-3a66-4a7d-80e9-b8afee29f09d"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"16"},{"key":"x-amz-apigw-id","value":"T0WPUEcASwMEXig="},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6a61-2ae468852933ef3d199af873;Parent=646bda53d143d16a;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"b8c41f64-2ea6-419c-9425-0f10648aa01c"}],"id":"ed8deb0e-eb07-46de-bb3c-82ccf4304749","_postman_id":"ed8deb0e-eb07-46de-bb3c-82ccf4304749","description":""},{"name":"DNA HVAC Direct Control","item":[{"name":"HVAC_Operating_State","id":"0c7d9947-5b5f-4858-8469-a72f91c47e65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_operating_state","description":"This command will return the current HVAC unit operating state.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","register_blocks","hvac_operating_state"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"3531c7cb-c5bb-4547-b07e-dd927afe1035","name":"HVAC_Operating_State","originalRequest":{"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_operating_state"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:04:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"d455a7a7-9f12-4925-94c1-5677ea00e6e0"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"43"},{"key":"x-amz-apigw-id","value":"T0WTaHwTSwMEQZA="},{"key":"etag","value":"W/\"2b-TXBkbWNYz8VpVyuPV8QckSzNKo4\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6a7b-60cd067234c2d4d37abb3e90;Parent=3e4c0dbd0008ffda;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"hvac_operating_state\",\n \"value\": 1\n }\n]"}],"_postman_id":"0c7d9947-5b5f-4858-8469-a72f91c47e65"},{"name":"HVAC_Mode","id":"6564d9f2-53bc-4c98-8db5-892bb8c7a185","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_mode","description":"This command will return the current HVAC operating mode.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","register_blocks","hvac_mode"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"6dd450b4-f287-4bf2-a0aa-9682c1b2e283","name":"HVAC_Mode","originalRequest":{"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_mode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:05:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"32"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"61ac15b4-207c-499d-87d5-5d46d6479612"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"32"},{"key":"x-amz-apigw-id","value":"T0Wb9E24SwMEo1A="},{"key":"etag","value":"W/\"20-XmzH3Ed1bN7jHjranH8h4H2l/mM\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6ab2-66a4a2f663da008b418a9c89;Parent=6ed35f413b38e75b;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"hvac_mode\",\n \"value\": 2\n }\n]"}],"_postman_id":"6564d9f2-53bc-4c98-8db5-892bb8c7a185"},{"name":"HVAC_Demand_Response","id":"87397de3-a4ec-4635-8949-e651b58b0733","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_demand_response","description":"This command will return the current demand response applied to the HVAC unit.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","register_blocks","hvac_demand_response"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"372df5f6-704c-488c-9b62-568f92c7eec1","name":"HVAC_Demand_Response","originalRequest":{"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_demand_response"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:05:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"344a5294-89c4-4af9-89e5-171d5f0230a4"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"43"},{"key":"x-amz-apigw-id","value":"T0Wd8HmcSwMEhDw="},{"key":"etag","value":"W/\"2b-3lo5cLijy/gZbWj7egBO5L7djfc\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6abf-584e9e453a112cda5157c05e;Parent=307b21f73ff3368f;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"hvac_demand_response\",\n \"value\": 0\n }\n]"}],"_postman_id":"87397de3-a4ec-4635-8949-e651b58b0733"},{"name":"HVAC_Temperature_Setpoint","id":"d5b31ac4-374e-49d1-a6aa-681323c5704f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_temperature_setpoint","description":"This command will return the current temperature setpoint of the HVAC unit. Temperature units are in Degrees.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","register_blocks","hvac_temperature_setpoint"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"33e7d8eb-5ea3-4833-9b28-e39e8114c7e3","name":"HVAC_Temperature_Setpoint","originalRequest":{"method":"GET","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_temperature_setpoint"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:05:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"2f3e99d2-6324-4b13-8389-52c75c45401d"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"49"},{"key":"x-amz-apigw-id","value":"T0WfxHLzSwMEPtg="},{"key":"etag","value":"W/\"31-GkK/8Gtqlo9HRlPwxZvrpXBmB8Q\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6acb-5ef3788315bcc952112d62c3;Parent=7745f5e8875ba48c;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"hvac_temperature_setpoint\",\n \"value\": 23\n }\n]"}],"_postman_id":"d5b31ac4-374e-49d1-a6aa-681323c5704f"},{"name":"HVAC_Operating_State","id":"db77cf1c-aece-46f2-b557-1b556a4427d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_operating_state","description":"This command will set the HVAC unit operating state.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","register_blocks","hvac_operating_state"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"06386b22-0910-4b0e-9e32-838b465c6296","name":"HVAC_Operating_State","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_operating_state"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:06:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"27309e1f-f9f2-4431-8715-912d5db4c9f2"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"16"},{"key":"x-amz-apigw-id","value":"T0WjUGQpSwMEW1w="},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6ae1-3b9246cf5975c9ea48800f9c;Parent=37660db5de39eae5;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"db77cf1c-aece-46f2-b557-1b556a4427d0"},{"name":"HVAC_Mode","id":"2f1f214a-05d0-4b1f-a7ea-0fe1fd33de00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\" : 2\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_mode","description":"This command will set the HVAC operating mode.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","register_blocks","hvac_mode"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"90f2e31b-6e93-4856-8811-fd5fdabd35f9","name":"HVAC_Mode","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\" : 2\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_mode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:06:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"896eacab-a83e-40a5-833c-abc6cb4bcff0"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"16"},{"key":"x-amz-apigw-id","value":"T0WlmEhnywMEk4A="},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6af0-3fa6b05a43ae65c67d125bcc;Parent=0293b15fab1c8e0e;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"2f1f214a-05d0-4b1f-a7ea-0fe1fd33de00"},{"name":"HVAC_Demand_Response","id":"9f868dc8-5002-4cf6-9204-4d767a5c1942","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_demand_response","description":"This command will set the demand response at the HVAC unit. This will apply a restirction to the HVAC unit preventing normal operation to reduce power consumption.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","register_blocks","hvac_demand_response"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"4f5ba1eb-4324-42da-a1f1-f7469de9edbf","name":"HVAC_Demand_Response","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_demand_response"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:06:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c4c465b9-2135-4f47-b759-454de7563900"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"16"},{"key":"x-amz-apigw-id","value":"T0WorFoqywMEefw="},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6b04-20583bd952a1995d4121f2c6;Parent=5fd5a235b7c6ae7d;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"9f868dc8-5002-4cf6-9204-4d767a5c1942"},{"name":"HVAC_Temperature_Setpoint","id":"42d7933e-2c86-4543-a2f5-ac83b9f1d2ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\" : 23\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_temperature_setpoint","description":"This command will set the temperature setpoint of the HVAC unit. Temperature units are in Degrees. Minimum value of 16 Degrees and Maximum of 30 Degrees allowed.
\n","urlObject":{"path":["api","sites","{{site_id}}","devices","{{device_id}}","register_blocks","hvac_temperature_setpoint"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"9a66f9e7-ab13-4785-b2bf-7394cc2cc5ac","name":"HVAC_Temperature_Setpoint","originalRequest":{"method":"POST","header":[{"key":"x-client-id","value":"{{x-client-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\" : 23\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/sites/{{site_id}}/devices/{{device_id}}/register_blocks/hvac_temperature_setpoint"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Feb 2024 23:06:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"1bd9ffb2-2f57-45d5-b238-7ce65799ec62"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"16"},{"key":"x-amz-apigw-id","value":"T0WqtFdnywMEi3A="},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-65de6b11-1c07d37725e241c071ec72d2;Parent=07c932e5d1884e2c;Sampled=0;lineage=7dbcedaa:0"},{"key":"access-control-allow-credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"42d7933e-2c86-4543-a2f5-ac83b9f1d2ef"}],"id":"559e53f6-aa91-4652-9750-dbf4992228da","description":"Where a site is configured with HVAC BMS controls the DNA API can be used to control each HVAC asset.
\nThe DNA API provides the following standard control registers, all HVAC manufacturers and HVAC controllers are all mapped into this standard format of control.
\nHVAC_Operating_State - Turn the HVAC unit on or off
\nHVAC_Mode - Change the HVAC unit from cooling to heating or auto
\nHVAC_Demand_Response - Reduce load at the HVAC asset
\nHVAC_Temeprature_Setpoint - Change the temperature setpoint
\nIt should be noted that additonal HVAC read only registers are available through the \"Get registers\" command.
\n","_postman_id":"559e53f6-aa91-4652-9750-dbf4992228da"}]}