fourteatoo.clj-blink.api — io.github.fourteatoo/clj-blink 0.1.1

The main API interface. Call register-client or authenticate-client and, with the returned client map, you can use the other primitives.

*client-name* clj

*device-id* clj

authenticate-client clj

(authenticate-client email password unique-id)

Authenticate client. Call this function to authenticate your client. The unique-id comes from a previous register-client. It is an error to call this function with an unique-id that is invalid or unknown to the server. Return a map that identifies the client and can be passed to all the other API functions.

fetch-media clj

(fetch-media client path & [as])

Fetch the media from the Blink server. The path is found in the :thumbnail and :media entries in the video maps. See get-videos.

get-camera-info clj

(get-camera-info client network camera)

Get configuration and status of a specific camera. Return a map of all the data about the camera.

get-camera-live-view clj

(get-camera-live-view client network camera)

Return a link to the camera live feed.

get-camera-sensors clj

(get-camera-sensors client network camera)

Return the status of a camera's sensors.

get-camera-usage clj

(get-camera-usage client)

Get the usage info of all cameras. Return a map.

get-command-status clj

(get-command-status client network command-id)

Return the status of command.

get-home-screen clj

(get-home-screen client)

Return the home screen. The home screen being a summary of info regarding a system and its devices.

get-network-status clj

(get-network-status client network)

Get the network status. Return a map with the current configuration of network.

get-networks clj

(get-networks client)

Get all the configured networks. Network being a collection of cameras hooked to the same Blink hub (aka sync module). Pass a client map as returned by authenticate-client or register-client.

get-sync-module clj

(get-sync-module client network)

Get the sync module of network. Return a map with the sync module's configuration.

get-user clj

(get-user client)

Get the user configuration. Return a map with the user data.

get-videos clj

(get-videos client & {:keys [since page]})

Get a list of videos currently saved in the cloud. The result is paginated and the :page number can be passed to specify subsequent pages. A starting epoch can be specified with the :since keyword argument.

motion-detection-disable clj

(motion-detection-disable client network camera)

Short for (set-motion-detection client network camera :disable)

motion-detection-enable clj

(motion-detection-enable client network camera)

Short for (set-motion-detection client network camera :enable)

new-thumbnail clj

(new-thumbnail client network camera)

Take a new still photograph with the sepcific camera on the specific network. The new thumbnail will replace the current one on the mobile app.

new-video-clip clj

(new-video-clip client network camera)

Take a new video with the sepcific camera on the specific network.

register-client clj

(register-client email password & {:keys [unique-id]})

Register a new client with the server. You need to call this function only once and save its output. This function will trigger the 2FA from Blink. You will be asked to enter a PIN that is delivered to you via email or SMS. Return a map that identifies the client in the successive API calls. An unique id is generated for you, but it can also be passed as keyword argument, if necessary. See authenticate-client.

set-motion-detection clj

(set-motion-detection client network camera action)

Enable or disable the motion detection of a specific camera. The parameter action should be either :eable or :disable

set-system-state clj

(set-system-state client network action)

Change the state of the system. action being either :arm or :disarm. Return a map with the actions performed on the network.

system-arm clj

(system-arm client network)

Shortcut for (set-system-state client network :arm).

system-disarm clj

(system-disarm client network)

Shortcut for (set-system-state client network :disarm).

update-network clj

(update-network client network)

Update a specific network. Network being a collection of cameras hooked to the same Blink hub (aka sync module). Pass a client and a network id. Return a map with the network current configuration.