From db0ecd8229dba7332d361915f02dedf67a14676e Mon Sep 17 00:00:00 2001 From: Pierre Kil Date: Tue, 25 Mar 2025 10:50:55 +0100 Subject: [PATCH 1/4] Create integrate-gateway-with-openremote.md --- .../integrate-gateway-with-openremote.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/tutorials/integrate-gateway-with-openremote.md diff --git a/docs/tutorials/integrate-gateway-with-openremote.md b/docs/tutorials/integrate-gateway-with-openremote.md new file mode 100644 index 0000000..d2a236b --- /dev/null +++ b/docs/tutorials/integrate-gateway-with-openremote.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 4 +--- + +# Integrate a gateway or controller with a central OpenRemote instance + +An example for connecting your personal gateway or controller to OpenRemote. This tutorial explains how to link an individual user's gateway (e.g. Home Asistant, OpenHAB, Smappee) to an OpenRemote central instance. +This use case is relevant for organisations which want to enable their users to connect their centralised service in OpenRemote to their user's individual gateways or controllers. + +## Create a restricted service user in OpenRemote + +First of all create a service user in OpenRemote: + +* go to the users page and select 'add service user' +* create a (service) user name +* select the Realm role: 'Restricted user' and select which assets this service user shpuld have access (Linked assets) +* select the correct roles: 'read assets' and 'write attributes' to allow the service user to read and write (if you want him to be able to write) to the attributes of the asset he is linked to +* don't forget to add the configuration items 'Acces restricted read' and 'Access restricted write' (if you want him to be able to write to this attribute) to the attributes of the assets the service user is linked to + +Once you saved the service user, a secret is generated. Store the secret as you will need it later. + +## Linking with Home Assistant + +To enable a user of OpenHAB to link to the central OpenRemote instance, the user will need: +* a service user name +* a secret +* the URL path to the asset and attributes the user has access to + + + +## Linking with OpenHAB + +To enable a user of OpenHAB to link to the central OpenRemote instance, the user will need: +* a service user name +* a secret +* the URL path to the asset and attributes the user has access to + +Within OpenHAB.... + + +**IGNORE: Example to add a figure.** +![Fahrenheit attribute as filled by the flow](img/flow-the-fahrenheit-result.png) From 30fd20cf6d0190132f1166a8529c6d1fba2b5b5e Mon Sep 17 00:00:00 2001 From: Pierre Kil Date: Tue, 25 Mar 2025 10:51:50 +0100 Subject: [PATCH 2/4] Update integrate-gateway-with-openremote.md --- docs/tutorials/integrate-gateway-with-openremote.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/tutorials/integrate-gateway-with-openremote.md b/docs/tutorials/integrate-gateway-with-openremote.md index d2a236b..2cb5028 100644 --- a/docs/tutorials/integrate-gateway-with-openremote.md +++ b/docs/tutorials/integrate-gateway-with-openremote.md @@ -39,4 +39,5 @@ Within OpenHAB.... **IGNORE: Example to add a figure.** + ![Fahrenheit attribute as filled by the flow](img/flow-the-fahrenheit-result.png) From 70cda4d9ee1fbb063e2ec704e91808b82c91025d Mon Sep 17 00:00:00 2001 From: Wouter Born Date: Tue, 25 Mar 2025 14:07:57 +0100 Subject: [PATCH 3/4] Improve documentation --- docs/tutorials/integrate-gateway-with-openremote.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/tutorials/integrate-gateway-with-openremote.md b/docs/tutorials/integrate-gateway-with-openremote.md index 2cb5028..9fb98d7 100644 --- a/docs/tutorials/integrate-gateway-with-openremote.md +++ b/docs/tutorials/integrate-gateway-with-openremote.md @@ -4,7 +4,8 @@ sidebar_position: 4 # Integrate a gateway or controller with a central OpenRemote instance -An example for connecting your personal gateway or controller to OpenRemote. This tutorial explains how to link an individual user's gateway (e.g. Home Asistant, OpenHAB, Smappee) to an OpenRemote central instance. +An example for connecting your personal gateway or controller to OpenRemote. +This tutorial explains how to link an individual user's gateway (e.g. Home Asistant, openHAB, Smappee) to an OpenRemote central instance. This use case is relevant for organisations which want to enable their users to connect their centralised service in OpenRemote to their user's individual gateways or controllers. ## Create a restricted service user in OpenRemote @@ -21,21 +22,21 @@ Once you saved the service user, a secret is generated. Store the secret as you ## Linking with Home Assistant -To enable a user of OpenHAB to link to the central OpenRemote instance, the user will need: +To enable a user of Home Assistant to link to the central OpenRemote instance, the user will need: * a service user name * a secret * the URL path to the asset and attributes the user has access to -## Linking with OpenHAB +## Linking with openHAB -To enable a user of OpenHAB to link to the central OpenRemote instance, the user will need: +To enable a user of openHAB to link to the central OpenRemote instance, the user will need: * a service user name * a secret * the URL path to the asset and attributes the user has access to -Within OpenHAB.... +Within openHAB.... **IGNORE: Example to add a figure.** From 7f2603a41f261695d7b110230956ff768b6b4184 Mon Sep 17 00:00:00 2001 From: Pierre Kil Date: Sun, 6 Apr 2025 12:04:52 +0200 Subject: [PATCH 4/4] Update and rename integrate-gateway-with-openremote.md to connect-your-gateway-to-openremote.md --- ...with-openremote.md => connect-your-gateway-to-openremote.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename docs/tutorials/{integrate-gateway-with-openremote.md => connect-your-gateway-to-openremote.md} (96%) diff --git a/docs/tutorials/integrate-gateway-with-openremote.md b/docs/tutorials/connect-your-gateway-to-openremote.md similarity index 96% rename from docs/tutorials/integrate-gateway-with-openremote.md rename to docs/tutorials/connect-your-gateway-to-openremote.md index 9fb98d7..a260046 100644 --- a/docs/tutorials/integrate-gateway-with-openremote.md +++ b/docs/tutorials/connect-your-gateway-to-openremote.md @@ -2,7 +2,7 @@ sidebar_position: 4 --- -# Integrate a gateway or controller with a central OpenRemote instance +# Connect your gateway or controller to OpenRemote An example for connecting your personal gateway or controller to OpenRemote. This tutorial explains how to link an individual user's gateway (e.g. Home Asistant, openHAB, Smappee) to an OpenRemote central instance.