core README

The project's README from github.com/home-assistant/core. As one markdown file: README.md.

Home Assistant |Chat Status|

Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.

Check out home-assistant.io <https://home-assistant.io>__ for a demo <https://demo.home-assistant.io>, installation instructions <https://home-assistant.io/getting-started/>, tutorials <https://home-assistant.io/getting-started/automation/>__ and documentation <https://home-assistant.io/docs/>__.

|screenshot-states|

|screenshot-integrations|

The system is built using a modular approach so support for other devices or actions can be implemented easily. See also the section on architecture <https://developers.home-assistant.io/docs/architecture_index/>__ and the section on creating your own components <https://developers.home-assistant.io/docs/creating_component_index/>__.

If you run into issues while using Home Assistant or during development of a component, check the Home Assistant help section <https://home-assistant.io/help/>__ of our website for further help and information.

|ohf-logo|

.. |Chat Status| image:: https://img.shields.io/discord/330944238910963714.svg :target: https://www.home-assistant.io/join-chat/ .. |screenshot-states| image:: https://raw.githubusercontent.com/home-assistant/core/dev/.github/assets/screenshot-states.png :target: https://demo.home-assistant.io .. |screenshot-integrations| image:: https://raw.githubusercontent.com/home-assistant/core/dev/.github/assets/screenshot-integrations.png :target: https://home-assistant.io/integrations/ .. |ohf-logo| image:: https://www.openhomefoundation.org/badges/home-assistant.png :alt: Home Assistant - A project from the Open Home Foundation :target: https://www.openhomefoundation.org/

core (home-assistant/core)

Searching Database…

91.6K ·GitHub
What is this?Home Assistant is an open-source home automation platform that puts local control and privacy first, letting you connect and control smart home devices from one hub instead of relying on cloud services.
Is this a library or a full application?It is a full application (a server you run) built on a modular integration system, so support for new devices or services can be added as plug-in components.
How do I get it running?The recommended way is running it on a Raspberry Pi or a local server; installation instructions and a demo are available on the project's website.
Do I need Python or any specific hardware first?It's written in Python, and the project is commonly deployed via Docker; a Raspberry Pi is the typical low-cost hardware target but any local server works too.
What should I check if something doesn't work?If you hit issues using or developing a component, the Home Assistant help section on the website is the place to look for support.
Where can I run this, besides a Raspberry Pi?Any local server you own can run it; it's not tied specifically to Raspberry Pi hardware.
Does it send my smart home data to the cloud?No — the project's core design principle is local control, keeping automation and data processing on your own hardware rather than a cloud service.
Can I add support for my own custom device?Yes, the modular architecture is designed so new integrations for devices or services can be implemented without touching the core.
Does it support MQTT devices?Yes, MQTT is one of the listed supported protocols/topics for connecting IoT devices.
Is there a GUI to see my devices' state?Yes, the README shows screenshots of a states dashboard and featured integrations UI.
Size
901.7 MB
Stars
91.6K
Age
13y
Commits · 90 Days