# bropat/hassio-eufy-security-ws architecture

> Architecture diagram of the GitHub repository bropat/hassio-eufy-security-ws, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bropat/hassio-eufy-security-ws
- Repository: https://github.com/bropat/hassio-eufy-security-ws

## Overview

This repository distributes a Home Assistant add-on for eufy-security-ws. The documented user workflow is to add the repository, select the add-on, configure it, and start it; the add-on provides the eufy-security-ws service. Source excerpts were unavailable, so internal startup wiring and external service connections are not inferred.

Main entry points: [`eufy-security-ws/README.md`](https://github.com/bropat/hassio-eufy-security-ws/blob/master/eufy-security-ws/README.md) (eufy-security-ws add-on), [`eufy-security-ws/config.yaml`](https://github.com/bropat/hassio-eufy-security-ws/blob/master/eufy-security-ws/config.yaml) (Add-on configuration), [`eufy-security-ws`](https://github.com/bropat/hassio-eufy-security-ws/tree/master/eufy-security-ws) (eufy-security-ws service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_distribution["Add-on distribution"]
  node_addon["eufy-security-ws add-on<br/>[README.md]"]
  node_config["Add-on configuration<br/>[config.yaml]"]
end

subgraph group_runtime["Add-on runtime"]
  node_launcher["Startup script<br/>[run.sh]"]
  node_service["eufy-security-ws service"]
end

node_user(("Home Assistant user"))
node_ha["Home Assistant"]

node_user -->|"opens add-on store"| node_ha
node_ha -->|"installs and starts"| node_addon
node_user -->|"fills configuration"| node_config
node_addon -->|"uses configuration"| node_config
node_addon -->|"provides"| node_service

click node_addon "https://github.com/bropat/hassio-eufy-security-ws/blob/master/eufy-security-ws/README.md"
click node_config "https://github.com/bropat/hassio-eufy-security-ws/blob/master/eufy-security-ws/config.yaml"
click node_launcher "https://github.com/bropat/hassio-eufy-security-ws/blob/master/eufy-security-ws/run.sh"
click node_service "https://github.com/bropat/hassio-eufy-security-ws/tree/master/eufy-security-ws"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_addon,node_config,node_user toneBlue
class node_launcher,node_service toneAmber
class node_ha toneIndigo
```

## Components

### Add-on distribution

- [eufy-security-ws add-on](https://github.com/bropat/hassio-eufy-security-ws/blob/master/eufy-security-ws/README.md): `eufy-security-ws/README.md`
- [Add-on configuration](https://github.com/bropat/hassio-eufy-security-ws/blob/master/eufy-security-ws/config.yaml): `eufy-security-ws/config.yaml`

### Add-on runtime

- [Startup script](https://github.com/bropat/hassio-eufy-security-ws/blob/master/eufy-security-ws/run.sh): `eufy-security-ws/run.sh`
- [eufy-security-ws service](https://github.com/bropat/hassio-eufy-security-ws/tree/master/eufy-security-ws): `eufy-security-ws`

### Other components

- **Home Assistant user**
- **Home Assistant**

## Connections

- Home Assistant user → Home Assistant: opens add-on store
- Home Assistant → eufy-security-ws add-on: installs and starts
- Home Assistant user → Add-on configuration: fills configuration
- eufy-security-ws add-on → Add-on configuration: uses configuration
- eufy-security-ws add-on → eufy-security-ws service: provides
