HomeAutomation

HomeAutomation is smart home automation system that connects to HomeKit.

By subscribing to events that happen in the HomeKit ecosystem, you are able to perform complex automations that can be written and tested in Swift.

Main goals:

• ability to create of complex automations (see HAImplemenations)
• cooperation with HomeKit: You can/should still use the Home.app/HomePods etc. for manually setting entities

Architecture

---
title: FlowKit Architecture
---

flowchart TB
    subgraph iOS/catalyst
        subgraph FlowKitAdapterApp
            subgraph ActorSystem Part 1
                HomeKitCommandReceiver[HomeKit Command Reveiver]
                HomeEventReceiverRef[HomeEvent Reveiver Ref]
            end
            HomeKit[fa:fa-home HomeKit]
            FlowKitAdapter
        end
    end

    WebSocket@{ shape: das, label: "WebSocket" }

    subgraph Docker
    subgraph HomeAutomationServer
         subgraph ActorSystem Part 2
                HomeKitCommandReceiverRef[HomeKit Command Reveiver Ref]
                HomeEventReceiver[HomeEvent Reveiver]
            end
        HomeAutomationService{{fa:fa-server Home Automation Service}}
        StorageAdapter[Storage Adapter]
    end
    subgraph MySQL
        MySQLDB[(MySQL Database)]
    end
    end

    HomeAutomationService -->|run commands, e.g. turnOn light| HomeKitCommandReceiverRef
    HomeKitCommandReceiverRef -->|WebSocket| HomeKitCommandReceiver
    HomeKitCommandReceiver -->FlowKitAdapter

    FlowKitAdapter -->|HomeEvent, e.g. light turned on| HomeEventReceiverRef
    HomeEventReceiverRef -->|WebSocket| HomeEventReceiver
    HomeEventReceiver --> HomeAutomationService
    FlowKitAdapter <--> HomeKit
    HomeAutomationService <--> StorageAdapter

    StorageAdapter <--> MySQLDB

Loading

Project Structure & Glossary

• FlowKit Server: Vapor server that contains the business logic e.g. receives HomeEvents, triggers automations, servers the config and persists Entities.
• HomeAutomationKit: Package the contains the entities etc. that are shared between the server and other parts of the system.
• FlowKit Adapter: A macOS catalyst/iOS app that must run in foreground (because of HomeKit privacy implications). It sends HomeEvents to the server and receives commands (e.g. HomeManagableAction) that will be forwarded to HomeKit.

Besides the main project structure there are a few more elements in the project that are defined here:

• Entity: characteristic of a device in HomeKit, e.g. the light sensor of a Eve Motion device.
• HomeEvent: event that might trigger an automation, e.g. .sunrise or the change of an entity.
• HomeManagableAction: action that will can be processed by the FlowKit Adapter app.

Further Information

• Server Setup
• FlowKit Adapter Setup