{"_id":"5b44ee0ba1c0120003fea447","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":33,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"5b44edff3306680003663f5c","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-07-10T17:33:51.438Z","from_sync":false,"order":10,"slug":"integrations","title":"Integrations"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-10T17:34:03.436Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"# Install the Ecobee EMS Conduit\n\n## Installation on the Droplit Portal\n\n1. Login to the [Droplit portal](https://portal.droplit.io), and select the _Integrations_ tab.\n2. Select _Ecobee EMS_ under \"Thermostats\", and select _Install_.\n3. Provide a value for the \"Poll Rate\" field. The value of the field is how often, in minutes, the conduit will poll provisioned devices for changes.\n4. Select _Save & apply_.\n5. Copy the \"Redirect Domain\" field; it will be pasted into another tab.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a3a89db-portalBlank.png\",\n        \"portalBlank.png\",\n        1280,\n        720,\n        \"#1c1c1d\"\n      ],\n      \"caption\": \"The Ecobee EMS Integration page on the Droplit portal as it appears by default.\"\n    }\n  ]\n}\n[/block]\n## Configuration on the Ecobee Web Portal\n\n1. Login to the [Ecobee web portal](https://www.ecobee.com/home/ecobeeLogin.jsp) with an Ecobee EMS account.\n2. Select the _developer_ tab in the top-right corner.\n3. Under \"Apps\", select _Create New_.\n4. Fill in the \"App Name\", \"App Summary\", and \"App Description\" fields as you see fit.\n5. Under \"Auth Method\", select _Authorization Code_.\n6. Paste the Redirect Domain copied from the Droplit portal into the \"Redirect Domain\" field.\n7. Select _Create_.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2f73f23-ecobeeAuthMethod.png\",\n        \"ecobeeAuthMethod.png\",\n        1280,\n        720,\n        \"#8ea380\"\n      ],\n      \"caption\": \"The \\\"Authorization Method\\\" section of Ecobee's application creation menu with the \\\"Authentication Method\\\" and \\\"Redirect Domain\\\" fields correctly filled.\"\n    }\n  ]\n}\n[/block]\n8. Select the newly created application from the list.\n9. Under the _Name and Summary_ tab, copy the \"API key\".\n\n## Configuration on the Droplit Portal\n\n1. Return to the Ecobee EMS page on the Droplit portal.\n2. Paste the copied API key into the \"API key\" field.\n3. Select _Save & apply_.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4ce338c-portalFilled.png\",\n        \"portalFilled.png\",\n        1280,\n        720,\n        \"#1c1c1d\"\n      ],\n      \"caption\": \"The Ecobee EMS Integration page on the Droplit portal with all of the fields correctly filled.\"\n    }\n  ]\n}\n[/block]\n# Activate the Ecobee EMS Conduit\n\nSince only one conduit exists per ecosystem, the `/ecosystems` API or the `/conduits` API may be used to activate it. The response of both API calls is a redirection URL that is used to authenticate with Ecobee.\n\n## Using the `/ecosystems` API\n\n[API call](doc:activate-conduit):\n```\nGET https://ioe.droplit.io/api/ecosystems/C59434aae4ca2fb182b7af191/conduits/droplit-ecobee-ems/activate HTTP/1.1\nauthorization: AUTH_TOKEN\n```\n\nResponse:\n```\n{\n    \"redirect\": \"https://yo.droplit.io/auth/activate?session=XIrpv4noD8PsSEWKISk4hY9dwym1XbawDjtSi7p4t9E\",\n    \"ttl\": 1800\n}\n```\n\n## Using the `/conduits` API\n\n[API call](doc:activate-a-conduit):\n```\nPOST https://ioe.droplit.io/api/conduits/5b55395d2f3804ca96802285/conduit-activations\n```\n\nResponse:\n```\n{\n    \"redirect\": \"https://dev-yo.droplit.io/auth/activate?session=QYUx1phDiqjSHTls_Z2AXPDCQ2LV032IS1PQ6Hx-U3s\",\n    \"ttl\": 1800\n}\n```\n\n# List EMS Thermostats\n\nA list of all the EMS thermostats supported by the conduit can be obtained by making the following [request](doc:list-local-devices):\n```\nGET https://ioe.droplit.io/api/conduits/:conduitId/conduit-activations/:activationId/local-devices HTTP/1.1\nauthorization: AUTH_TOKEN\n```\n\nThe body of the JSON response contains the following keys:\n* `localId`: the unique identifier provided by Ecobee\n* `customName`: the name of the thermostat provided by Ecobee\n* `isProvisioned`: boolean value indicating if the device is provisioned to at least one environment\n* `environments`: array of `environmentId`s indicating the environments to which the device is provisioned\n* `localData`: When the `expand` query parameter is set to `LocalData`, all of the thermostat's data is included in the response.\n\n# Provision Devices\n\nDevices connected to the Droplit system through the droplit-ecobee-ems conduit may be provisioned to several different environments; they are not necessarily limited to a single environment. The option still exists, however, to provision the conduit's devices to a single environment by specifying an environment during the conduit's activation.\n\nDevices are provisioned to an environment when they are created. In order to [create a device](doc:devices-create) that utilizes the droplit-ecobee-ems conduit, the body of the request must contain the following keys:\n* `environmentId`: The ID of the environment to which the device will be provisioned. If an environment was specified during the activation of the conduit, only that environment will be accepted.\n* `localId`: the device's unique identifier provided by Ecobee\n* `conduitActivationId`: the ID of the activation to which the device will be attached","excerpt":"Integrate Ecobee EMS thermostats with the Droplit system.","slug":"ecobee-ems","type":"basic","title":"Ecobee EMS Thermostats"}

Ecobee EMS Thermostats

Integrate Ecobee EMS thermostats with the Droplit system.

# Install the Ecobee EMS Conduit ## Installation on the Droplit Portal 1. Login to the [Droplit portal](https://portal.droplit.io), and select the _Integrations_ tab. 2. Select _Ecobee EMS_ under "Thermostats", and select _Install_. 3. Provide a value for the "Poll Rate" field. The value of the field is how often, in minutes, the conduit will poll provisioned devices for changes. 4. Select _Save & apply_. 5. Copy the "Redirect Domain" field; it will be pasted into another tab. [block:image] { "images": [ { "image": [ "https://files.readme.io/a3a89db-portalBlank.png", "portalBlank.png", 1280, 720, "#1c1c1d" ], "caption": "The Ecobee EMS Integration page on the Droplit portal as it appears by default." } ] } [/block] ## Configuration on the Ecobee Web Portal 1. Login to the [Ecobee web portal](https://www.ecobee.com/home/ecobeeLogin.jsp) with an Ecobee EMS account. 2. Select the _developer_ tab in the top-right corner. 3. Under "Apps", select _Create New_. 4. Fill in the "App Name", "App Summary", and "App Description" fields as you see fit. 5. Under "Auth Method", select _Authorization Code_. 6. Paste the Redirect Domain copied from the Droplit portal into the "Redirect Domain" field. 7. Select _Create_. [block:image] { "images": [ { "image": [ "https://files.readme.io/2f73f23-ecobeeAuthMethod.png", "ecobeeAuthMethod.png", 1280, 720, "#8ea380" ], "caption": "The \"Authorization Method\" section of Ecobee's application creation menu with the \"Authentication Method\" and \"Redirect Domain\" fields correctly filled." } ] } [/block] 8. Select the newly created application from the list. 9. Under the _Name and Summary_ tab, copy the "API key". ## Configuration on the Droplit Portal 1. Return to the Ecobee EMS page on the Droplit portal. 2. Paste the copied API key into the "API key" field. 3. Select _Save & apply_. [block:image] { "images": [ { "image": [ "https://files.readme.io/4ce338c-portalFilled.png", "portalFilled.png", 1280, 720, "#1c1c1d" ], "caption": "The Ecobee EMS Integration page on the Droplit portal with all of the fields correctly filled." } ] } [/block] # Activate the Ecobee EMS Conduit Since only one conduit exists per ecosystem, the `/ecosystems` API or the `/conduits` API may be used to activate it. The response of both API calls is a redirection URL that is used to authenticate with Ecobee. ## Using the `/ecosystems` API [API call](doc:activate-conduit): ``` GET https://ioe.droplit.io/api/ecosystems/C59434aae4ca2fb182b7af191/conduits/droplit-ecobee-ems/activate HTTP/1.1 authorization: AUTH_TOKEN ``` Response: ``` { "redirect": "https://yo.droplit.io/auth/activate?session=XIrpv4noD8PsSEWKISk4hY9dwym1XbawDjtSi7p4t9E", "ttl": 1800 } ``` ## Using the `/conduits` API [API call](doc:activate-a-conduit): ``` POST https://ioe.droplit.io/api/conduits/5b55395d2f3804ca96802285/conduit-activations ``` Response: ``` { "redirect": "https://dev-yo.droplit.io/auth/activate?session=QYUx1phDiqjSHTls_Z2AXPDCQ2LV032IS1PQ6Hx-U3s", "ttl": 1800 } ``` # List EMS Thermostats A list of all the EMS thermostats supported by the conduit can be obtained by making the following [request](doc:list-local-devices): ``` GET https://ioe.droplit.io/api/conduits/:conduitId/conduit-activations/:activationId/local-devices HTTP/1.1 authorization: AUTH_TOKEN ``` The body of the JSON response contains the following keys: * `localId`: the unique identifier provided by Ecobee * `customName`: the name of the thermostat provided by Ecobee * `isProvisioned`: boolean value indicating if the device is provisioned to at least one environment * `environments`: array of `environmentId`s indicating the environments to which the device is provisioned * `localData`: When the `expand` query parameter is set to `LocalData`, all of the thermostat's data is included in the response. # Provision Devices Devices connected to the Droplit system through the droplit-ecobee-ems conduit may be provisioned to several different environments; they are not necessarily limited to a single environment. The option still exists, however, to provision the conduit's devices to a single environment by specifying an environment during the conduit's activation. Devices are provisioned to an environment when they are created. In order to [create a device](doc:devices-create) that utilizes the droplit-ecobee-ems conduit, the body of the request must contain the following keys: * `environmentId`: The ID of the environment to which the device will be provisioned. If an environment was specified during the activation of the conduit, only that environment will be accepted. * `localId`: the device's unique identifier provided by Ecobee * `conduitActivationId`: the ID of the activation to which the device will be attached