diff --git a/en/README.md b/en/README.md index f89933dc..d2499f73 100644 --- a/en/README.md +++ b/en/README.md @@ -1,4 +1,4 @@ -# Hello world! +# Home Assistant developer documentation -This is a test +Welcome to the Home Assistant development documentation. This is the place to learn all about how Home Assistant works and how you can extend it with support for your devices and services! diff --git a/en/architecture/README.md b/en/architecture/README.md index 1997c893..2429abbd 100644 --- a/en/architecture/README.md +++ b/en/architecture/README.md @@ -1 +1,20 @@ # WOW Architecture! + +Before we dive into the Home Assistant architecture, let's get a clear overview of the home automation landscape as a whole. This way, we can show how the different parts of Home Assistant fit into the picture. + +For more information about each part in this overview, check out our blog. Here's the tl;dr version of the blog: + + * Home Control is responsible for collecting information and controlling devices. + * Home Automation triggers commands based on user configurations. + * Smart Home triggers commands based on previous behavior. + +![Home Automation landscape](home_automation_landscape.svg) + +The Home Assistant core is responsible for Home Control. Home Assistant contains four parts which make this possible: + + * **Event Bus**: facilitates the firing and listening of events -- the beating heart of Home Assistant. + * **State Machine**: keeps track of the states of things and fires a `state_changed` event when a state has been changed. + * **Service Registry**: listens on the event bus for `call_service` events and allows other code to register services. + * **Timer**: sends a `time_changed` event every 1 second on the event bus. + +![Home Assistant core architecture](ha_architecture.svg) diff --git a/en/architecture/ha_architecture.svg b/en/architecture/ha_architecture.svg new file mode 100644 index 00000000..dbe41b93 --- /dev/null +++ b/en/architecture/ha_architecture.svg @@ -0,0 +1,856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + Home AssistantCore Architecture + + Timer + + Event Bus + + StateMachine + listen for events/fire event + + ServiceRegistry + + + + Light + + + + Many more... + Device Tracker + Switch + Components + set state + + + + + + + + call event listeners + publishservice + callservice + + + call_serviceevents + + service_calledevents + time_changedevents + state_changedevents + + diff --git a/en/architecture/home_automation_landscape.svg b/en/architecture/home_automation_landscape.svg new file mode 100644 index 00000000..c0fbca28 --- /dev/null +++ b/en/architecture/home_automation_landscape.svg @@ -0,0 +1,904 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + Lights + + + + Smart Home + + HomeAutomation + User + + Configuration + + Home Control + Commands + Information + + + + Switches + Many more... + Internet of Things + + + + + Commands + Information + Information + Commands + Information(ie. light is on) + Commands(ie. turn light on) + Graphic by Paulus Schoutsen 2014, CC BY 4.0 + +