Skip to content

Blink documentation update #2293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 5, 2017
Merged

Blink documentation update #2293

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9af8c62
Blink documentation update
fronzbot Mar 19, 2017
de3762e
Fixed double ticks and bad sentence
fronzbot Mar 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions source/_components/blink.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,16 @@ 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. The image can only be updated in Home Assistant every 60 seconds in order to not overwhelm Blink's servers with API requests.
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.

Services:
There are three services availiabe for the blink platform:
- arm_system
- arm_camera
- snap_picture
- force_update

For arm_system, the value sent can be either "True" or "False" and will arm and disarm the whole blink system, respectively
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
```json
Expand All @@ -50,21 +51,23 @@ Arm system example
}
```

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 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:
```json
{
"friendly_name": "Living Room",
"device_armed": "False"
}
```

The blink.snap_picture service takes the camera name as the payload and with take a new picture with your camera.
The `blink.snap_picture` service takes the camera name as the payload and with take a new picture with your camera.
```
{
"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
Expand Down