mirror of
https://github.com/home-assistant/core.git
synced 2025-08-13 15:30:03 +00:00
.github
docs
homeassistant
components
ads
alarm_control_panel
alexa
automation
binary_sensor
calendar
camera
climate
cloud
config
counter
cover
device_tracker
emulated_hue
fan
frontend
google_assistant
group
homematic
http
image_processing
light
lock
mailbox
media_player
mqtt
notify
persistent_notification
recorder
remember_the_milk
remote
scene
sensor
__init__.py
abode.py
ads.py
airvisual.py
alarmdecoder.py
alpha_vantage.py
amcrest.py
android_ip_webcam.py
apcupsd.py
api_streams.py
arduino.py
arest.py
arlo.py
arwn.py
bbox.py
bh1750.py
bitcoin.py
blink.py
blockchain.py
bloomsky.py
bme280.py
bom.py
broadlink.py
buienradar.py
canary.py
cert_expiry.py
citybikes.py
coinmarketcap.py
comed_hourly_pricing.py
comfoconnect.py
command_line.py
cpuspeed.py
crimereports.py
cups.py
currencylayer.py
darksky.py
deluge.py
demo.py
deutsche_bahn.py
dht.py
discogs.py
dnsip.py
dovado.py
dsmr.py
dte_energy_bridge.py
dublin_bus_transport.py
dwd_weather_warnings.py
dweet.py
dyson.py
ebox.py
ecobee.py
eddystone_temperature.py
efergy.py
eight_sleep.py
eliqonline.py
emoncms.py
enocean.py
envirophat.py
envisalink.py
etherscan.py
fail2ban.py
fastdotcom.py
fedex.py
fido.py
file.py
fitbit.py
fixer.py
fritzbox_callmonitor.py
fritzbox_netmonitor.py
gearbest.py
geizhals.py
geo_rss_events.py
gitter.py
glances.py
google_travel_time.py
google_wifi.py
gpsd.py
gtfs.py
haveibeenpwned.py
hddtemp.py
history_stats.py
hive.py
homematic.py
hp_ilo.py
htu21d.py
hydroquebec.py
imap.py
imap_email_content.py
influxdb.py
ios.py
irish_rail_transport.py
isy994.py
juicenet.py
kira.py
knx.py
kwb.py
lacrosse.py
lastfm.py
linux_battery.py
london_air.py
london_underground.py
loopenergy.py
luftdaten.py
lyft.py
metoffice.py
mfi.py
mhz19.py
miflora.py
min_max.py
modbus.py
modem_callerid.py
mold_indicator.py
moon.py
mopar.py
mqtt.py
mqtt_room.py
mvglive.py
mysensors.py
nederlandse_spoorwegen.py
nest.py
netatmo.py
netdata.py
neurio_energy.py
nut.py
nzbget.py
octoprint.py
ohmconnect.py
onewire.py
openevse.py
openexchangerates.py
openhardwaremonitor.py
opensky.py
openweathermap.py
otp.py
pi_hole.py
pilight.py
plex.py
pocketcasts.py
pushbullet.py
pvoutput.py
pyload.py
qnap.py
radarr.py
raincloud.py
random.py
rest.py
rflink.py
rfxtrx.py
ring.py
ripple.py
sabnzbd.py
scrape.py
season.py
sensehat.py
serial.py
serial_pm.py
shodan.py
skybeacon.py
skybell.py
sleepiq.py
sma.py
snmp.py
sonarr.py
speedtest.py
statistics.py
steam_online.py
supervisord.py
swiss_hydrological_data.py
swiss_public_transport.py
synologydsm.py
systemmonitor.py
sytadin.py
tado.py
tahoma.py
tank_utility.py
tcp.py
ted5000.py
tellduslive.py
tellstick.py
temper.py
template.py
tesla.py
thethingsnetwork.py
thinkingcleaner.py
tibber.py
time_date.py
toon.py
torque.py
tradfri.py
transmission.py
travisci.py
twitch.py
uber.py
uk_transport.py
upnp.py
ups.py
uptime.py
usps.py
vasttrafik.py
vera.py
verisure.py
version.py
viaggiatreno.py
volvooncall.py
vultr.py
waqi.py
whois.py
wink.py
worldclock.py
worldtidesinfo.py
worxlandroid.py
wsdot.py
wunderground.py
xbox_live.py
xiaomi_aqara.py
yahoo_finance.py
yr.py
yweather.py
zabbix.py
zamg.py
zha.py
zigbee.py
zoneminder.py
zwave.py
switch
system_log
telegram_bot
timer
tts
vacuum
weather
wink
zha
zwave
__init__.py
abode.py
alarmdecoder.py
alert.py
amcrest.py
android_ip_webcam.py
apcupsd.py
api.py
apple_tv.py
arduino.py
arlo.py
asterisk_mbox.py
axis.py
bbb_gpio.py
blink.py
bloomsky.py
browser.py
canary.py
comfoconnect.py
configurator.py
conversation.py
datadog.py
demo.py
device_sun_light_trigger.py
dialogflow.py
digital_ocean.py
discovery.py
dominos.py
doorbird.py
downloader.py
duckdns.py
dweet.py
dyson.py
ecobee.py
eight_sleep.py
emoncms_history.py
enocean.py
envisalink.py
feedreader.py
ffmpeg.py
foursquare.py
gc100.py
google.py
google_domains.py
graphite.py
hassio.py
hdmi_cec.py
history.py
history_graph.py
hive.py
hue.py
ifttt.py
influxdb.py
input_boolean.py
input_datetime.py
input_number.py
input_select.py
input_text.py
insteon_local.py
insteon_plm.py
intent_script.py
introduction.py
ios.py
isy994.py
joaoapps_join.py
juicenet.py
keyboard.py
keyboard_remote.py
kira.py
knx.py
lametric.py
linode.py
lirc.py
litejet.py
logbook.py
logentries.py
logger.py
lutron.py
lutron_caseta.py
mailgun.py
map.py
maxcube.py
media_extractor.py
microsoft_face.py
mochad.py
modbus.py
mqtt_eventstream.py
mqtt_statestream.py
mycroft.py
mysensors.py
namecheapdns.py
neato.py
nest.py
netatmo.py
no_ip.py
nuimo_controller.py
octoprint.py
panel_custom.py
panel_iframe.py
pilight.py
plant.py
prometheus.py
proximity.py
python_script.py
qwikswitch.py
raincloud.py
raspihats.py
rest_command.py
rflink.py
rfxtrx.py
ring.py
rpi_gpio.py
rpi_pfio.py
rss_feed_template.py
satel_integra.py
script.py
scsgate.py
services.yaml
shell_command.py
shiftr.py
shopping_list.py
skybell.py
sleepiq.py
snips.py
spc.py
splunk.py
statsd.py
sun.py
tado.py
tahoma.py
tellduslive.py
tellstick.py
tesla.py
thethingsnetwork.py
thingspeak.py
toon.py
tradfri.py
twilio.py
updater.py
upnp.py
usps.py
velbus.py
velux.py
vera.py
verisure.py
volvooncall.py
vultr.py
wake_on_lan.py
weblink.py
websocket_api.py
wemo.py
xiaomi_aqara.py
zabbix.py
zeroconf.py
zigbee.py
zone.py
zoneminder.py
helpers
scripts
util
__init__.py
__main__.py
bootstrap.py
config.py
const.py
core.py
exceptions.py
loader.py
monkey_patch.py
package_constraints.txt
remote.py
setup.py
script
tests
virtualization
.coveragerc
.dockerignore
.gitattributes
.gitignore
.gitmodules
.hound.yml
.ignore
.travis.yml
CLA.md
CODEOWNERS
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile
LICENSE.md
MANIFEST.in
README.rst
pylintrc
requirements_all.txt
requirements_docs.txt
requirements_test.txt
requirements_test_all.txt
setup.cfg
setup.py
tox.ini

* Add File sensor * Use None and return * Remove I/O * Use less memory * No traceback if file is empty
99 lines
2.9 KiB
Python
99 lines
2.9 KiB
Python
"""
|
|
Support for sensor value(s) stored in local files.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.file/
|
|
"""
|
|
import os
|
|
import asyncio
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import (
|
|
CONF_VALUE_TEMPLATE, CONF_NAME, CONF_UNIT_OF_MEASUREMENT)
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_FILE_PATH = 'file_path'
|
|
|
|
DEFAULT_NAME = 'File'
|
|
|
|
ICON = 'mdi:file'
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_FILE_PATH): cv.string,
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
|
|
})
|
|
|
|
|
|
@asyncio.coroutine
|
|
def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
|
|
"""Set up the file sensor."""
|
|
file_path = config.get(CONF_FILE_PATH)
|
|
name = config.get(CONF_NAME)
|
|
unit = config.get(CONF_UNIT_OF_MEASUREMENT)
|
|
value_template = config.get(CONF_VALUE_TEMPLATE)
|
|
|
|
if value_template is not None:
|
|
value_template.hass = hass
|
|
|
|
async_add_devices(
|
|
[FileSensor(name, file_path, unit, value_template)], True)
|
|
|
|
|
|
class FileSensor(Entity):
|
|
"""Implementation of a file sensor."""
|
|
|
|
def __init__(self, name, file_path, unit_of_measurement, value_template):
|
|
"""Initialize the file sensor."""
|
|
self._name = name
|
|
self._file_path = file_path
|
|
self._unit_of_measurement = unit_of_measurement
|
|
self._val_tpl = value_template
|
|
self._state = None
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit the value is expressed in."""
|
|
return self._unit_of_measurement
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Return the icon to use in the frontend, if any."""
|
|
return ICON
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._state
|
|
|
|
def update(self):
|
|
"""Get the latest entry from a file and updates the state."""
|
|
try:
|
|
with open(self._file_path, 'r', encoding='utf-8') as file_data:
|
|
for line in file_data:
|
|
data = line
|
|
data = data.strip()
|
|
except (IndexError, FileNotFoundError, IsADirectoryError,
|
|
UnboundLocalError):
|
|
_LOGGER.warning("File or data not present at the moment: %s",
|
|
os.path.basename(self._file_path))
|
|
return
|
|
|
|
if self._val_tpl is not None:
|
|
self._state = self._val_tpl.async_render_with_possible_json_value(
|
|
data, None)
|
|
else:
|
|
self._state = data
|