From 6d150158ce67c3973432ba62fbb6d40151afbdde Mon Sep 17 00:00:00 2001 From: Martin Riedel Date: Fri, 31 Jan 2020 00:07:48 -0500 Subject: [PATCH 1/5] Add documentation for Carson integration. --- source/_integrations/carson.markdown | 61 ++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 source/_integrations/carson.markdown diff --git a/source/_integrations/carson.markdown b/source/_integrations/carson.markdown new file mode 100644 index 000000000000..96e0cdd7aa40 --- /dev/null +++ b/source/_integrations/carson.markdown @@ -0,0 +1,61 @@ +--- +title: Carson +description: Instructions on how to integrate your Carson.live Account within Home Assistant. +ha_category: + - Camera + - Lock +ha_release: 0.105.0 +ha_iot_class: Cloud Polling +ha_config_flow: true +ha_codeowners: + - '@rado0x54' +--- + +The `carson` implementation allows you to integrate your [Carson.live](https://carson.live/) account in Home Assistant. + +There is currently support for the following device types within Home Assistant: + +- [Camera](#camera) +- [Lock](#lock) + +## Configuration + +Go to the integrations page in your config and click on new integration -> Carson. + +By default, the Carson integration will retrieve accessible cameras from the Carson Interface (e.g. Cameras that you also see within the Carson App). +However, it is also possible to retrieve the cameras directly via the Eagle Eye API (which Carson uses for Integration), which may allow access to +more cameras. + +## YAML configuration + +YAML configuration is around for people that prefer YAML, but it's not preferred! + +To enable device linked in your [Carson.live](https://carson.live/) account, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +carson: + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +{% configuration %} +username: + description: The username for accessing your Carson account (usually an e-mail). + required: true + type: string +password: + description: The password for accessing your Carson account. + required: true + type: string +{% endconfiguration %} + +## Camera + +Once you have enabled the [Carson integration](/integrations/carson), you can start using the camera platform. +Cameras support image (snapshot) and video stream functionality. + +## Lock + +Once you have enabled the [Carson integration](/integrations/carson), you can start using the lock platform. You will see all the doors available to you. +Doors can be opened (both via service lock.open and lock.unlock). Note, that Carson does **not** support the `lock.lock` service, since doors "auto-lock" after a short amount of time. From a8f5c86fadfc24a39d78d70b34f9aa5037a29b07 Mon Sep 17 00:00:00 2001 From: Martin Riedel Date: Fri, 31 Jan 2020 09:50:24 -0500 Subject: [PATCH 2/5] Update source/_integrations/carson.markdown Co-Authored-By: Klaas Schoute --- source/_integrations/carson.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/carson.markdown b/source/_integrations/carson.markdown index 96e0cdd7aa40..0755ad5c7243 100644 --- a/source/_integrations/carson.markdown +++ b/source/_integrations/carson.markdown @@ -4,7 +4,7 @@ description: Instructions on how to integrate your Carson.live Account within Ho ha_category: - Camera - Lock -ha_release: 0.105.0 +ha_release: 0.105 ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: From c527afc3b13121bbc2e917bb98dabca17355dfaa Mon Sep 17 00:00:00 2001 From: Martin Riedel Date: Fri, 31 Jan 2020 09:50:33 -0500 Subject: [PATCH 3/5] Update source/_integrations/carson.markdown Co-Authored-By: Klaas Schoute --- source/_integrations/carson.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/carson.markdown b/source/_integrations/carson.markdown index 0755ad5c7243..70fc884f8e7d 100644 --- a/source/_integrations/carson.markdown +++ b/source/_integrations/carson.markdown @@ -20,7 +20,7 @@ There is currently support for the following device types within Home Assistant: ## Configuration -Go to the integrations page in your config and click on new integration -> Carson. +Go to the integrations page in your config and click on new **integration** -> **Carson**. By default, the Carson integration will retrieve accessible cameras from the Carson Interface (e.g. Cameras that you also see within the Carson App). However, it is also possible to retrieve the cameras directly via the Eagle Eye API (which Carson uses for Integration), which may allow access to From ff1acea651edac2939be48fddc18e9beaf6da732 Mon Sep 17 00:00:00 2001 From: Martin Riedel Date: Fri, 31 Jan 2020 10:07:32 -0500 Subject: [PATCH 4/5] Integrated PR review, added reference to camera and lock integrations. --- source/_integrations/carson.markdown | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/source/_integrations/carson.markdown b/source/_integrations/carson.markdown index 70fc884f8e7d..bea70b2bcd72 100644 --- a/source/_integrations/carson.markdown +++ b/source/_integrations/carson.markdown @@ -52,10 +52,14 @@ password: ## Camera -Once you have enabled the [Carson integration](/integrations/carson), you can start using the camera platform. -Cameras support image (snapshot) and video stream functionality. +Once you have enabled the Carson integration, you can start using the camera platform. +The following camera services are supported: `play_stream`, `record`, `snapshot` + +Please see the [camera integration](/integrations/camera) for more information about using camera-related services. ## Lock -Once you have enabled the [Carson integration](/integrations/carson), you can start using the lock platform. You will see all the doors available to you. -Doors can be opened (both via service lock.open and lock.unlock). Note, that Carson does **not** support the `lock.lock` service, since doors "auto-lock" after a short amount of time. +Once you have enabled the Carson integration, you can start using the lock platform. You will see all the doors available to you. +Doors can be opened (both via service `lock.open` and `lock.unlock`). Note, that Carson does **not** support the `lock.lock` service, since doors "auto-lock" after a short amount of time. + +Please see the [lock integration](/integrations/lock) for more information about using camera-related services. From 677b0aa2e980d25543dfda723cee3b844c3a928f Mon Sep 17 00:00:00 2001 From: Martin Riedel Date: Fri, 31 Jan 2020 10:10:51 -0500 Subject: [PATCH 5/5] Fixed typo. --- source/_integrations/carson.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/carson.markdown b/source/_integrations/carson.markdown index bea70b2bcd72..edc6fa9a3aea 100644 --- a/source/_integrations/carson.markdown +++ b/source/_integrations/carson.markdown @@ -62,4 +62,4 @@ Please see the [camera integration](/integrations/camera) for more information a Once you have enabled the Carson integration, you can start using the lock platform. You will see all the doors available to you. Doors can be opened (both via service `lock.open` and `lock.unlock`). Note, that Carson does **not** support the `lock.lock` service, since doors "auto-lock" after a short amount of time. -Please see the [lock integration](/integrations/lock) for more information about using camera-related services. +Please see the [lock integration](/integrations/lock) for more information about using lock-related services.