step 5 / 6

Setup hardware

Now let’s open some doors! You will need the following hardware for a test setup:

  • IQ(s)

  • Repeater(s) – optional

  • Lock(s)

  • Tag(s)

  • Maintenance card

Below you may find the sequence of calls for the next steps. Those next steps being activating IQ and Lock, linking them into a “System Tree”, registering Tags and last granting access (which is done by creating accessors and access groups). More detail about the end-points and values you need to apply can be found online at the Developer page. Please be aware that hovering the coloured section provides more info.

Activate hardware: {{url}} -> https://hardware.my-clay.com/

POST {{url}}/v1/iqs

PATCH {{url}}/v1/iqs/{id}

properties
subscribed true

POST {{url}}/v1/locks

POST {{url}}/v1/repeaters (if you have a repeater)

Link locks and repeaters to IQs (Set IQ hardware tree):

PUT {{url}}/v1/iqs/{id}/tree

As a next step; Locks can be physically linked to the IQ by presenting the ‘Maintenance Card’ and Repeaters, by pressing the reset button. To review the state of the ‘Tree’, check the Locks and Repeaters for iq_link_state online. If Repeater is added in the ‘Tree’, reset the Repeater.

You can verify the IQ Hardware tree by requesting following call from the API:

GET {{url}}/v1/iqs/{id}/tree

Detaching lock(s):

If a lock needs to be moved to a different location or replaced, it needs to be detached from its current installation.  Detaching a lock is a process that consists of 2 steps:

1

First, a PATCH request is done on the lock endpoint (PATCH /v1/locks/{id}) with the following properties:

properties
iq_link_state detached_pending
accessor_id {id}
2

Second, the lock is removed from the tree by using the PUT request on the IQ (/v1/iqs/{id}/tree) endpoint.

Grant access:

In order to grant access, first you need to create an accessor.

POST {{url}}/v1/accessors

Register tags:

PATCH {{url}}/v1/locks/{id}

Assign tag to the accessor:

POST {{url}}/v1/accessors/{id}/assigned_tags

Present Tag to Lock. Lock will give you 3 beeps with red blinks, rejecting the tag. (no endpoint)

Create Lock Accessor Tag:

POST {{url}}/v1/lock_accessor_tags

Create access group (add an accessor, add a lock, add a time schedule to an access group):

POST {{url}}/v1/access_groups

POST {{url}}/v1/access_groups/{id}/accessors

POST {{url}}/v1/access_groups/{id}/locks

POST {{url}}/v1/access_groups/{id}/time_schedule

Grant offline access:

PATCH /v1/lock_accessor_tags/{id}

properties
tag_offline_access true
Easy office mode:

Easy office mode is a combination of the access granted through an access group, the toggle office mode for a tag.

POST/PATCH {{url}}/v1/lock_accessor_tags/{id}

properties
toggle_easy_office_mode true/false

PUT {{url}} /v1/locks/{id}/easy_office_mode_schedule

Manual office mode:

Manual office mode is a combination of the access granted through an access group, the toggle office mode for a tag.

POST/PATCH {{url}}/v1/lock_accessor_tags/{id}

properties
toggle_manual_office_mode true/false
Enum values:
iq/tree|hardware_type lock / repeater
lock|battery_level none / low / good / fresh
lock|iq_link_state detached / attached_pending / attached / detached_pending
lock|tag_registration_state not_started / in_progress
repeater|iq_link_state detached / attached_pending / attached / detached_pending