diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index 086bb9a1799..e14d68d0d55 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -25,7 +25,13 @@ blink: password: YOUR_PASSWORD ``` +Configuration variables: + +- **username** (*Required*): Your username to login to Blink. +- **password** (*Required*): Your password to login to Blink. + Once loaded, your front end will have the following components: + * A camera image for each camera in your system. * A binary_sensor per camera that indicates whether motion detection is enabled. * A binary_sensor for the system that indicates if the system is armed or disarmed. @@ -33,25 +39,27 @@ Once loaded, your front end will have the following components: * A sensor per camera that reports battery level. * A sensor per camera that reports unread notification (ie. detected motion events). -Since the cameras are battery operated, the images are only updated in Home Assistant when the user manually forces a new photo. This image can be updated with the `blink.snap_picture` service followed by a `blink.force_update` service call to force Home Assistant to request an update from Blink's servers. If the `blink.force_update` service is not called, the image will be updated within a 180 second interval, set so that automatic server requests don't overwhelm the Blink API. As a note, all of the camera-specific sensors are only polled when a new image is requested from the camera. This means that relying on any of these sensors to provide timely and accurate data is not recommended. +Since the cameras are battery operated, the images are only updated in Home Assistant when the user manually forces a new photo. This image can be updated with the `snap_picture` service to force Home Assistant to request an update from Blink's servers. As a note, all of the camera-specific sensors are only polled when a new image is requested from the camera. This means that relying on any of these sensors to provide timely and accurate data is not recommended. Services: -There are three services availiabe for the blink platform: + +This services are available for the `blink` component: + - arm_system - arm_camera - snap_picture -- force_update -For `blink.arm_system`, the value sent can be either "True" or "False" and will arm and disarm the whole blink system, respectively -Arm system example +For `arm_system`, the value sent can be either `True` or `False` and will arm and disarm the whole Blink system. Arm system example: + ```json { "device_armed": "True" } ``` -Arm camera follows a similar structure, but each indidivual camera can have motion detection enabled or disabled. Because of this, you also need to supply a name. For example, if I have a camera named "Living Room" and I want to turn off motion detection on that camera, I'd call the `blink.arm_camera` service with the following payload: +Arm camera follows a similar structure, but each indidivual camera can have motion detection enabled or disabled. Because of this, you also need to supply a name. For example, if you have a camera named "Living Room" and you want to turn off motion detection on that camera, you would call the `arm_camera` service with the following payload: + ```json { "friendly_name": "Living Room", @@ -59,20 +67,14 @@ Arm camera follows a similar structure, but each indidivual camera can have moti } ``` -The `blink.snap_picture` service takes the camera name as the payload and with take a new picture with your camera. -``` +The `snap_picture` service takes the camera name as the payload and with take a new picture with your camera. + +```json { "friendly_name": "Living Room" } ``` -The `blink.force_update` service can simply be called with no payload to force a server update. - -Configuration variables: - -- **username** (*Required*): Your username to login to Blink -- **password** (*Required*): Your password to login to Blink -