-The following examples assume a subscription that has an ID of `123456` and a label of `Web Server` -
- -Minimal `configuration.yaml` (produces `binary_sensor.vultr_web_server`): - -```yaml -# Example configuration.yaml entry -binary_sensor: - - platform: vultr - subscription: 123456 -``` - -{% configuration %} -subscription: - description: The subscription you want to monitor, this can be found in the URL when viewing a server. - required: true - type: string -name: - description: The name you want to give this binary sensor. - required: false - default: "Vultr {subscription label}" - type: string -{% endconfiguration %} - -## {% linkable_title Full example %} - -Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`): - -```yaml -binary_sensor: - - platform: vultr - name: totally_awesome_server - subscription: 12345 -``` diff --git a/source/_components/sensor.vultr.markdown b/source/_components/sensor.vultr.markdown deleted file mode 100644 index 89f87369f76..00000000000 --- a/source/_components/sensor.vultr.markdown +++ /dev/null @@ -1,74 +0,0 @@ ---- -layout: page -title: "Vultr Sensor" -description: "Instructions on how to integrate Vultr sensor within Home Assistant." -date: 2017-10-17 21:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: vultr.png -ha_release: "0.58" -ha_category: System Monitor -ha_iot_class: "Cloud Polling" ---- - -The `vultr` sensor platform will allow you to view current bandwidth usage and pending charges against your [Vultr](https://www.vultr.com/) subscription. - -To use this sensor, you must set up your [Vultr hub](/components/vultr/). - --The following examples assume a subscription that has an ID of `123456` and a label of `Web Server` -
- -Minimal `configuration.yaml` (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`): - -```yaml -sensor: - - platform: vultr - subscription: 123456 -``` - -{% configuration %} -subscription: - description: The Vultr subscription to monitor, this can be found in the URL when viewing a subscription. - required: true - type: string -name: - description: The name to give this sensor. - required: false - default: "Vultr {Vultr subscription label} {monitored condition name}" - type: string -monitored_conditions: - description: List of items you want to monitor for each subscription. - required: false - detault: All conditions - type: list - keys: - current_bandwidth_used: - description: The current (invoice period) bandwidth usage in Gigabytes (GB). - temperature: - pending_charges: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$). -{% endconfiguration %} - -Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_used` and `sensor.server_pending_charges`): - -```yaml -sensor: - - platform: vultr - name: Server {} - subscription: 123456 - monitored_conditions: - - current_bandwidth_used - - pending_charges -``` - -Custom `configuration.yaml` with only one condition monitored (produces `sensor.web_server_bandwidth`): -```yaml -sensor: - - platform: vultr - name: Web Server Bandwidth - subscription: 123456 - monitored_conditions: - - current_bandwidth_used -``` diff --git a/source/_components/switch.vultr.markdown b/source/_components/switch.vultr.markdown deleted file mode 100644 index 8844c897dad..00000000000 --- a/source/_components/switch.vultr.markdown +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: page -title: "Vultr Switch" -description: "Instructions on how to set up Vultr switches within Home Assistant." -date: 2017-10-17 21:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: vultr.png -ha_category: System Monitor -ha_release: "0.58" -ha_iot_class: "Cloud Polling" ---- - -The `vultr` switch platform allows you to control (start/stop) your -[Vultr](https://www.vultr.com/) subscription. - -To control your Vultr subscription, you first have to set up -your [Vultr hub](/components/vultr/). - -## {% linkable_title Configuration %} - -Minimal `configuration.yaml` (produces `switch.vultr_web_server`): - -```yaml -# Example configuration.yaml entry -switch: - - platform: vultr - subscription: YOUR_SUBSCRIPTION_ID -``` - -{% configuration %} -subscription: - description: List of droplets you want to control. - required: true - type: string -name: - description: The name you want to give this switch. - required: false - default: "Vultr {subscription label}" - type: string -{% endconfiguration %} - -## {% linkable_title Additional Examples %} - -Full example that produces `switch.amazing_server`, assuming a subscription -that has an ID of `123456` and a label of `Web Server`: - -```yaml -# Example configuration.yaml entry -switch: - - platform: vultr - name: Amazing Server - subscription: 123456 -``` diff --git a/source/_components/vultr.markdown b/source/_components/vultr.markdown index f5313ff065e..d960c282972 100644 --- a/source/_components/vultr.markdown +++ b/source/_components/vultr.markdown @@ -8,14 +8,28 @@ comments: false sharing: true footer: true featured: false -ha_category: System Monitor +ha_category: + - System Monitor + - Binary Sensor + - Sensor + - Switch ha_release: "0.58" logo: vultr.png ha_iot_class: "Cloud Polling" +redirect_from: + - /components/binary_sensor.vultr/ + - /components/sensor.vultr/ + - /components/switch.vultr/ --- 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. +There is currently support for the following device types within Home Assistant: + +- [Binary Sensor](#binary-sensor) +- [Sensor](#sensor) +- [Switch](#switch) + ## {% linkable_title Configuration %} Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/#settingsapi). @@ -38,3 +52,151 @@ api_key: required: true type: string {% endconfiguration %} + +## {% linkable_title Binary sensor %} + +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. + +### {% linkable_title Configuration %} + +To use this binary sensor, you first have to set up your Vultr hub. + ++The following examples assume a subscription that has an ID of `123456` and a label of `Web Server` +
+ +Minimal `configuration.yaml` (produces `binary_sensor.vultr_web_server`): + +```yaml +# Example configuration.yaml entry +binary_sensor: + - platform: vultr + subscription: 123456 +``` + +{% configuration %} +subscription: + description: The subscription you want to monitor, this can be found in the URL when viewing a server. + required: true + type: string +name: + description: The name you want to give this binary sensor. + required: false + default: "Vultr {subscription label}" + type: string +{% endconfiguration %} + +### {% linkable_title Full example %} + +Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`): + +```yaml +binary_sensor: + - platform: vultr + name: totally_awesome_server + subscription: 12345 +``` + +## {% linkable_title Sensor %} + +The `vultr` sensor platform will allow you to view current bandwidth usage and pending charges against your [Vultr](https://www.vultr.com/) subscription. + +To use this sensor, you must set up your Vultr hub. + ++The following examples assume a subscription that has an ID of `123456` and a label of `Web Server` +
+ +Minimal `configuration.yaml` (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`): + +```yaml +sensor: + - platform: vultr + subscription: 123456 +``` + +{% configuration %} +subscription: + description: The Vultr subscription to monitor, this can be found in the URL when viewing a subscription. + required: true + type: string +name: + description: The name to give this sensor. + required: false + default: "Vultr {Vultr subscription label} {monitored condition name}" + type: string +monitored_conditions: + description: List of items you want to monitor for each subscription. + required: false + detault: All conditions + type: list + keys: + current_bandwidth_used: + description: The current (invoice period) bandwidth usage in Gigabytes (GB). + temperature: + pending_charges: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$). +{% endconfiguration %} + +Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_used` and `sensor.server_pending_charges`): + +```yaml +sensor: + - platform: vultr + name: Server {} + subscription: 123456 + monitored_conditions: + - current_bandwidth_used + - pending_charges +``` + +Custom `configuration.yaml` with only one condition monitored (produces `sensor.web_server_bandwidth`): + +```yaml +sensor: + - platform: vultr + name: Web Server Bandwidth + subscription: 123456 + monitored_conditions: + - current_bandwidth_used +``` + +## {% linkable_title Switch %} + +The `vultr` switch platform allows you to control (start/stop) your [Vultr](https://www.vultr.com/) subscription. + +To control your Vultr subscription, you first have to set up your Vultr hub. + +### {% linkable_title Configuration %} + +Minimal `configuration.yaml` (produces `switch.vultr_web_server`): + +```yaml +# Example configuration.yaml entry +switch: + - platform: vultr + subscription: YOUR_SUBSCRIPTION_ID +``` + +{% configuration %} +subscription: + description: List of droplets you want to control. + required: true + type: string +name: + description: The name you want to give this switch. + required: false + default: "Vultr {subscription label}" + type: string +{% endconfiguration %} + +### {% linkable_title Additional Examples %} + +Full example that produces `switch.amazing_server`, assuming a subscription that has an ID of `123456` and a label of `Web Server`: + +```yaml +# Example configuration.yaml entry +switch: + - platform: vultr + name: Amazing Server + subscription: 123456 +``` \ No newline at end of file