From f4e89d497bab9641ef080e2d4c934319f8a24ba6 Mon Sep 17 00:00:00 2001 From: Kyle Gunger Date: Thu, 20 Feb 2025 15:00:12 -0500 Subject: Update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index f39b59a..aff1da3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # Interconnect -Interconnect daemon for OpenSmarts. Manages all connected devices, and stores settings/user scripts. \ No newline at end of file +Interconnect daemon for OpenSmarts. This is an implementation of the logical hub for OpenSmarts devices. + +Its responsabilities are (in *hub mode*): +- Maintain an internal graph of the network (uuids, keys, and *endpoints*) +- Keep and run all the *automation scripts* as required +- Manage/push new state information to smart home devices as required by users or scripts +- Store/forward state information from smart home devices as requested by users or scripts +- Pair new devices when requested by users + +Its responsabilities are (in *endpoint mode*): +- Present all onboard logical endpoints as iot devices +- Pair and maintain keys with other smart home software +- Forward commands from the paired hub to underlying onboard devices +- Forward new data from underlying onboard devices to other smart home software + +This daemon is meant to run as the underlying logical smart home hub for a given network. +Current focus is on the basic features of device management, automation, and extensability, but +future work will be done on different setup modes to run a "hub device" as a bridge or endpoint +so that it can be managed (and expose its connected devices) to/from other smart home software +such as HomeAssistant or AppleHomeKit. -- cgit v1.2.3