Skip to content

Commit e32f1cd

Browse files
GenericStudentfabaff
GenericStudent
authored and
fabaff
committed
Adding in docs for Vultr platform and sensors (home-assistant#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
1 parent df50d51 commit e32f1cd

File tree

5 files changed

+178
-0
lines changed

5 files changed

+178
-0
lines changed

‎source/_components/binary_sensor.vultr.markdown

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: page
3+
title: "Vultr Binary Sensor"
4+
description: "Instructions on how to set up Vultr binary sensors within Home Assistant."
5+
date: 2017-10-17 21:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
ha_category: System Monitor
11+
logo: vultr.png
12+
ha_release: "0.57"
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
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.
17+
18+
To use this binary sensor, you first have to set up your [Vultr hub](/components/vultr/).
19+
20+
<p class='note'>
21+
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
22+
</p>
23+
24+
Minimal `configuration.yaml` (produces `binary_sensor.vultr_web_server`):
25+
```yaml
26+
binary_sensor:
27+
- platform: vultr
28+
subscription: 123456
29+
```
30+
31+
Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
32+
```yaml
33+
binary_sensor:
34+
- platform: vultr
35+
name: totally_awesome_server
36+
subscription: 12345
37+
```
38+
39+
Configuration variables:
40+
41+
- **subscription** (*Required*): The subscription you want to monitor, this can be found in the URL when viewing a server
42+
- **name** (*Optional*): The name you want to give this binary sensor, defaults to `Vultr {subscription label}`

‎source/_components/sensor.vultr.markdown

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: page
3+
title: "Vultr Sensor"
4+
description: "Instructions on how to integrate Vultr sensor within Home Assistant."
5+
date: 2017-10-17 21:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: vultr.png
11+
ha_release: "0.57"
12+
ha_category: System Monitor
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
17+
The `vultr` sensor will allow you to view current bandwidth usage and pending charges against your [Vultr](https://www.vultr.com/) subscription.
18+
19+
To use this sensor, you must set up your [Vultr hub](/components/vultr/).
20+
21+
<p class='note'>
22+
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
23+
</p>
24+
25+
Minimal `configuration.yaml` (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`):
26+
```yaml
27+
sensor:
28+
- platform: vultr
29+
subscription: 123456
30+
```
31+
32+
Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_used` and `sensor.server_pending_charges`):
33+
```yaml
34+
sensor:
35+
- platform: vultr
36+
name: Server {}
37+
subscription: 123456
38+
monitored_conditions:
39+
- current_bandwidth_used
40+
- pending_charges
41+
```
42+
43+
Custom `configuration.yaml` with only one condition monitored (produces `sensor.web_server_bandwidth`):
44+
```yaml
45+
sensor:
46+
- platform: vultr
47+
name: Web Server Bandwidth
48+
subscription: 123456
49+
monitored_conditions:
50+
- current_bandwidth_used
51+
```
52+
53+
Configuration variables:
54+
55+
- **subscription** (*Required*): The Vultr subscription to monitor, this can be found in the URL when viewing a subscription
56+
- **name** (*Optional*): The name to give this sensor, defaults to `Vultr {Vultr subscription label} {monitored condition name}`.
57+
- **monitored_conditions** array (*Optional*): List of items you want to monitor for each subscription. Defaults to all of them if omitted.
58+
- **current_bandwidth_used**: The current (invoice period) bandwidth usage in Gigabytes (GB).
59+
- **pending_charges**: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$).

‎source/_components/switch.vultr.markdown

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: page
3+
title: "Vultr Switch"
4+
description: "Instructions on how to set up Vultr switches within Home Assistant."
5+
date: 2017-10-17 21:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: vultr.png
11+
ha_category: Switch
12+
ha_release: "0.57"
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
The `vultr` switch platform allows you to control (start/stop) your [Vultr](https://www.vultr.com/) subscription.
17+
18+
To control your Vultr subscription, you first have to set up your [Vultr hub](/components/vultr/).
19+
20+
<p class='note'>
21+
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
22+
</p>
23+
24+
Minimal `configuration.yaml` (produces `switch.vultr_web_server`):
25+
```yaml
26+
switch:
27+
- platform: vultr
28+
subscription: 123456
29+
```
30+
31+
Full `configuration.yaml` (produces `switch.amazing_server`):
32+
```yaml
33+
switch:
34+
- platform: vultr
35+
name: Amazing Server
36+
subscription: 123456
37+
```
38+
39+
Configuration variables:
40+
41+
- **subscription** (*Required*): List of droplets you want to control.
42+
- **name** (*Optional*): The name you want to give this switch, defaults to `Vultr {subscription label}`

‎source/_components/vultr.markdown

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: page
3+
title: "Vultr"
4+
description: "Instructions on how to integrate Vultr within Home Assistant."
5+
date: 2017-10-17 21:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
featured: false
11+
ha_category: Hub
12+
ha_release: "0.57"
13+
logo: vultr.png
14+
ha_iot_class: "Cloud Polling"
15+
---
16+
17+
18+
The `vultr` component allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
19+
20+
Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/#settingsapi).
21+
22+
<p class='note'>
23+
Ensure you allow the public IP of Home Assistant under the Access Control heading.
24+
</p>
25+
26+
To integrate your Vultr subscriptions with Home Assistant, add the following section to your `configuration.yaml` file:
27+
28+
```yaml
29+
vultr:
30+
api_key: ABCDEFG12345
31+
```
32+
33+
Configuration variables:
34+
35+
- **api_key** (*Required*): Your Vultr API key.

‎source/images/supported_brands/vultr.png

6.17 KB
Loading

0 commit comments

Comments
 (0)