About
File is a built-in Home Assistant integration that writes notifications to a local file and reads values from files into sensors. It adds a notifier that appends messages to a chosen file path, with an option to add a timestamp to each notification. It also adds a sensor that takes its value from a local file, with a unit of measurement and a value template that renders the state from the file content. A read file action returns the contents of a file, which is useful in automations and scripts. Everything runs locally, and setup and later changes to options happen in the UI.
Automatic summary of Home Assistant's source code. Something wrong? Get in touch
Supports
Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Updated with Home Assistant Ships and updates with every Home Assistant release.
Provides
- Sensors
Setting it up
It is added under Settings, Devices and services, with Add integration.
Notification to file service
- File pathA local file path to write the notification to
- TimestampAdd a timestamp to the notification
File sensor
- File pathThe local file path to retrieve the sensor value from
- Unit of measurementUnit of measurement for the sensor
- Value templateA template to render the sensor's value based on the file content
After setup
- TimestampAdd a timestamp to the notification
- Unit of measurementUnit of measurement for the sensor
- Value templateA template to render the sensor's value based on the file content
Texts from Home Assistant's source code, Apache License 2.0.
Actions
- Read fileReads a file and returns the contents.Fields: File encoding, File name
Shows in Vulpo
Chart card, Apple Watch.Information
- Installs
- 6.6k sharing analytics
- Connection
- Works locally
- Upkeep
- Part of Home Assistant
- Category
- DIY and makers, Web and data connectors
- Kind
- Built-in integration
- Needs
- Built into Home Assistant
- Domain
file










