9fa7906aef
* Made it possible to define multiple octoprint printers * style fix * Added configuration option for octoprint port * SSL support in octoprint platform configuration * Octoprint component now auto loads sensor and binary_sensor platforms * preliminary support for auto discovery of octoprint servers * Moved sensors and binary sensors configuration into main octoprint configuration * Using base_url as the key for storing api in the octoprint component * made sure to not supersede the platforms' domains * bugfix: continue setting up other printers if one fails * flake8 style correction * Added icons to sensors * Fail platform setup if no printers were successfully added * Simplified custom validator
84 lines
2.7 KiB
Python
84 lines
2.7 KiB
Python
"""
|
|
Support for monitoring OctoPrint binary sensors.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/binary_sensor.octoprint/
|
|
"""
|
|
import logging
|
|
|
|
import requests
|
|
|
|
from homeassistant.components.octoprint import (BINARY_SENSOR_TYPES,
|
|
DOMAIN as COMPONENT_DOMAIN)
|
|
from homeassistant.components.binary_sensor import BinarySensorDevice
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEPENDENCIES = ['octoprint']
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the available OctoPrint binary sensors."""
|
|
if discovery_info is None:
|
|
return
|
|
|
|
name = discovery_info['name']
|
|
base_url = discovery_info['base_url']
|
|
monitored_conditions = discovery_info['sensors']
|
|
octoprint_api = hass.data[COMPONENT_DOMAIN][base_url]
|
|
|
|
devices = []
|
|
for octo_type in monitored_conditions:
|
|
new_sensor = OctoPrintBinarySensor(
|
|
octoprint_api, octo_type, BINARY_SENSOR_TYPES[octo_type][2],
|
|
name, BINARY_SENSOR_TYPES[octo_type][3],
|
|
BINARY_SENSOR_TYPES[octo_type][0],
|
|
BINARY_SENSOR_TYPES[octo_type][1], 'flags')
|
|
devices.append(new_sensor)
|
|
add_entities(devices, True)
|
|
|
|
|
|
class OctoPrintBinarySensor(BinarySensorDevice):
|
|
"""Representation an OctoPrint binary sensor."""
|
|
|
|
def __init__(self, api, condition, sensor_type, sensor_name, unit,
|
|
endpoint, group, tool=None):
|
|
"""Initialize a new OctoPrint sensor."""
|
|
self.sensor_name = sensor_name
|
|
if tool is None:
|
|
self._name = '{} {}'.format(sensor_name, condition)
|
|
else:
|
|
self._name = '{} {}'.format(sensor_name, condition)
|
|
self.sensor_type = sensor_type
|
|
self.api = api
|
|
self._state = False
|
|
self._unit_of_measurement = unit
|
|
self.api_endpoint = endpoint
|
|
self.api_group = group
|
|
self.api_tool = tool
|
|
_LOGGER.debug("Created OctoPrint binary sensor %r", self)
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return true if binary sensor is on."""
|
|
return bool(self._state)
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the class of this sensor, from DEVICE_CLASSES."""
|
|
return None
|
|
|
|
def update(self):
|
|
"""Update state of sensor."""
|
|
try:
|
|
self._state = self.api.update(
|
|
self.sensor_type, self.api_endpoint, self.api_group,
|
|
self.api_tool)
|
|
except requests.exceptions.ConnectionError:
|
|
# Error calling the api, already logged in api.update()
|
|
return
|