{"_id":"586ade049698b91900f8495f","parentDoc":null,"project":"568bdc1483d2061900d86cdc","user":"573b7f42fdc9d320001b777d","version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"__v":0,"category":{"_id":"5859e859e3306d1900126725","project":"568bdc1483d2061900d86cdc","__v":0,"version":"582789aabe5c080f00a5a7fe","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-12-21T02:26:33.525Z","from_sync":false,"order":5,"slug":"edge-server","title":"Edge Server"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-02T23:11:00.286Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"The `droplit-plugin-voyager` plugin allows the Edge to communicate with the Venstar® Voyager Thermostat.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Enaling the Local Thermostat API\",\n  \"body\": \"By default, the API for the Voyager thermostat is disabled. In order for the plugin to work with a thermostat is must first be enabled.\\n\\nEnable the API with the following steps:\\n1. Open main front panel and the smaller panel on the bottom of the thermostat. This will expose the `SETUP` button on the bottom-right.\\n2. Press the `SETUP` button on the furthest right of the bottom row.\\n3. Press the `MODE` button to navigate through each setup step as indicated on the left of the display until reaching step `29`. The thermostat should display `LOCAL API`.\\n4. Press either the `WARMER` or `COOLER` buttons to enable or disable the local API. If enabled, the thermostat should display `ON` or `OFF` when disabled.\\n5. To exit, press the `SETUP` button to return to the main screen.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Services\"\n}\n[/block]\n## Temperature\nThe `Temperature` service is used to display temperature information.\n\n### properties\n`temperature` — The temperature value. Value is an object with a numeric temperature value property and a unit property which may be `C`, `F`, or `K` (for Celsius, Fahrenheit, and Kelvin appropriately). Is ReadOnly.\n`units` — The temperature unit the device is currently displaying in.\n\n## Thermostat\nThe `Thermostat` service is used to control a thermostat.\n\n### properties\n`mode` — The thermostat’s current working mode. Values are `off`, `auto`, `cool`, and `heat`.\n`fan` — The thermostat’s fan setting. Values are `auto` and `on`.\n`coolTemperature` — The thermostat’s cool setting. Values are an object with a numeric temperature value property and a unit property which may be `C`, `F`, or `K` (for Celsius, Fahrenheit, and Kelvin appropriately). The setting may also be set with just the numeric value to use the unit that the thermostat is currently displaying with.\n`heatTemperature` — The thermostat’s heat setting. Values are an object with a numeric temperature value property and a unit property which may be `C`, `F`, or `K` (for Celsius, Fahrenheit, and Kelvin appropriately). The setting may also be set with just the numeric value to use the unit that the thermostat is currently displaying with.\n`state` — The thermostat’s current action. Values are `cooling`, `heating`, and `off`. Is ReadOnly.\n`away` — Whether the device is in away mode. The value is a boolean.","excerpt":"A Plugin for talking with Venstar® Voyager thermostat","slug":"plugin-voyager","type":"basic","title":"Voyager Plugin"}

Voyager Plugin

A Plugin for talking with Venstar® Voyager thermostat

The `droplit-plugin-voyager` plugin allows the Edge to communicate with the Venstar® Voyager Thermostat. [block:callout] { "type": "info", "title": "Enaling the Local Thermostat API", "body": "By default, the API for the Voyager thermostat is disabled. In order for the plugin to work with a thermostat is must first be enabled.\n\nEnable the API with the following steps:\n1. Open main front panel and the smaller panel on the bottom of the thermostat. This will expose the `SETUP` button on the bottom-right.\n2. Press the `SETUP` button on the furthest right of the bottom row.\n3. Press the `MODE` button to navigate through each setup step as indicated on the left of the display until reaching step `29`. The thermostat should display `LOCAL API`.\n4. Press either the `WARMER` or `COOLER` buttons to enable or disable the local API. If enabled, the thermostat should display `ON` or `OFF` when disabled.\n5. To exit, press the `SETUP` button to return to the main screen." } [/block] [block:api-header] { "type": "basic", "title": "Services" } [/block] ## Temperature The `Temperature` service is used to display temperature information. ### properties `temperature` — The temperature value. Value is an object with a numeric temperature value property and a unit property which may be `C`, `F`, or `K` (for Celsius, Fahrenheit, and Kelvin appropriately). Is ReadOnly. `units` — The temperature unit the device is currently displaying in. ## Thermostat The `Thermostat` service is used to control a thermostat. ### properties `mode` — The thermostat’s current working mode. Values are `off`, `auto`, `cool`, and `heat`. `fan` — The thermostat’s fan setting. Values are `auto` and `on`. `coolTemperature` — The thermostat’s cool setting. Values are an object with a numeric temperature value property and a unit property which may be `C`, `F`, or `K` (for Celsius, Fahrenheit, and Kelvin appropriately). The setting may also be set with just the numeric value to use the unit that the thermostat is currently displaying with. `heatTemperature` — The thermostat’s heat setting. Values are an object with a numeric temperature value property and a unit property which may be `C`, `F`, or `K` (for Celsius, Fahrenheit, and Kelvin appropriately). The setting may also be set with just the numeric value to use the unit that the thermostat is currently displaying with. `state` — The thermostat’s current action. Values are `cooling`, `heating`, and `off`. Is ReadOnly. `away` — Whether the device is in away mode. The value is a boolean.