This guide will outline how CHeKT Portal Users can use the "HTTP Request" option in the CHeKT Automation Rule programming menu to activate camera functions such as relays or lights.
Setting up the Rule:
In the Dealer Portal configuration menu for automation rules, start by selecting your Source Event. This is the event that will initiate the API Request. We will use Arming Change as our source event for the example. The Site Armed will cause the rule to take place when the state of the system is changed to armed:
For Action, Select HTTP Request:
In the expanded menu, you will need to select the type of request, enter the correct URL for the API request and the required login credential:
Choose a conditional filter if applicable.
Armed Status is not a filter option as the arming change is already selected as our initial source event
We will use no Operational Condition for our example:
Name your rule and add any additional helpful notes for your other Dealer Portal Users:
And click next:
Testing the Rule
When the source event is activated, that HTTP request should go out to the defined IP address automatically. You can see the record of the request in the site activity logs:
For each instance of your Source Event in the logs, you should see an HTTP Request.
In our example, arming was our source event. You can see the log of the HTTP request and success after the arming:
The log items can be expanded for more granular details.
In the request line, you can see the API request details:
For your test, you are looking for the success message:
In the event the request comes back with a failure:
- Ensure the bridge has local area network access to the IP range of the target camera
- Check the validity for the HTTP URL
- Ensure the correct security method has been selected
- Verify the presented authentication credentials are valid
With our CHeKT Camera Example:
When our Arm Request is successful and the state is changed to 0 (Closed) the DO+ and DO - terminals will have continuity.
- When our disarm Request is successful and the state is changed to 1 (open) the DO+ and DO - terminals will not have continuity.
This state-change can be manually toggled in the camera for troubleshooting in the "Trigger Actions" menu:
When the HTTP command from the bridge is working correctly, users will see the state change on this page between opened and closed as the associated Source Event is executed.