home-assistant.github.io/source/_components/binary_sensor.vultr.markdown
Adam Cooper e32f1cdabd Adding in docs for Vultr platform and sensors (#3663)
* Added Vultr logo

* Added v1 Vultr hub

* Added init sensor docs for Vultr

* Updated Vultr components to next version

* Updating Vultr components

* Added more details to vultr sensors

* Updated Vultr component docs

* Corrected Vultr name default values, added vultr sensor {} name option
2017-11-05 14:11:54 +01:00

42 lines
1.2 KiB
Markdown

---
layout: page
title: "Vultr Binary Sensor"
description: "Instructions on how to set up Vultr binary sensors within Home Assistant."
date: 2017-10-17 21:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: System Monitor
logo: vultr.png
ha_release: "0.57"
ha_iot_class: "Cloud Polling"
---
The `vultr` binary sensor platform allows you to monitor your [Vultr](https://www.vultr.com/) subscription to see if it is powered on or not.
To use this binary sensor, you first have to set up your [Vultr hub](/components/vultr/).
<p class='note'>
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
</p>
Minimal `configuration.yaml` (produces `binary_sensor.vultr_web_server`):
```yaml
binary_sensor:
- platform: vultr
subscription: 123456
```
Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
```yaml
binary_sensor:
- platform: vultr
name: totally_awesome_server
subscription: 12345
```
Configuration variables:
- **subscription** (*Required*): The subscription you want to monitor, this can be found in the URL when viewing a server
- **name** (*Optional*): The name you want to give this binary sensor, defaults to `Vultr {subscription label}`