d9999f36e8
* Added a ThingSpeak component * Forgot a colon. Fixed it * Some config variables are better required * New requirements created by the script * Updated the .coveragerc * Fixed small linting errors * Removed unneccessary validation * Even more linting error fixes * Changed the way the component listens to state changes * Removed unneccessary declaration of 'state' variable, referring to new_state instead
70 lines
2 KiB
Python
70 lines
2 KiB
Python
"""A component to submit data to thingspeak."""
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.const import (
|
|
CONF_API_KEY, CONF_ID, CONF_WHITELIST,
|
|
STATE_UNAVAILABLE, STATE_UNKNOWN)
|
|
from homeassistant.helpers import state as state_helper
|
|
import homeassistant.helpers.config_validation as cv
|
|
import homeassistant.helpers.event as event
|
|
|
|
REQUIREMENTS = ['thingspeak==0.4.0']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DOMAIN = 'thingspeak'
|
|
TIMEOUT = 5
|
|
|
|
# Validate the config
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
DOMAIN: vol.Schema({
|
|
vol.Required(CONF_API_KEY): cv.string,
|
|
vol.Required(CONF_ID): int,
|
|
vol.Required(CONF_WHITELIST): cv.string
|
|
}),
|
|
}, extra=vol.ALLOW_EXTRA)
|
|
|
|
|
|
def setup(hass, config):
|
|
"""Setup the thingspeak environment."""
|
|
import thingspeak
|
|
|
|
# Read out config values
|
|
conf = config[DOMAIN]
|
|
api_key = conf.get(CONF_API_KEY)
|
|
channel_id = conf.get(CONF_ID)
|
|
entity = conf.get(CONF_WHITELIST)
|
|
|
|
try:
|
|
channel = thingspeak.Channel(
|
|
channel_id, api_key=api_key, timeout=TIMEOUT)
|
|
channel.get()
|
|
except:
|
|
_LOGGER.error("Error while accessing the ThingSpeak channel. "
|
|
"Please check that the channel exists and your "
|
|
"API key is correct.")
|
|
return False
|
|
|
|
def thingspeak_listener(entity_id, old_state, new_state):
|
|
"""Listen for new events and send them to thingspeak."""
|
|
if new_state is None or new_state.state in (
|
|
STATE_UNKNOWN, '', STATE_UNAVAILABLE):
|
|
return
|
|
try:
|
|
if new_state.entity_id != entity:
|
|
return
|
|
_state = state_helper.state_as_number(new_state)
|
|
except ValueError:
|
|
return
|
|
try:
|
|
channel.update({'field1': _state})
|
|
except:
|
|
_LOGGER.error(
|
|
'Error while sending value "%s" to Thingspeak',
|
|
_state)
|
|
|
|
event.track_state_change(hass, entity, thingspeak_listener)
|
|
|
|
return True
|