Integration with Third Party Device

Prev Next

Integration via Wiegand

The Wiegand feature enables the Akuvox device to act as a controller or a card reader.

Set it up on the web Device > Wiegand > Wiegand interface.

  • Wiegand Display Mode: Select the Wiegand card code format from the provided options.

  • Wiegand Card Reader Mode: It is automatically configured when Input is the Wiegand Transfer Mode. If Output is the Wiegand Transfer Mode, the transmission format should be identical between the door phone and the third-party device.

  • Wiegand Transfer Mode:

    • Input: The device serves as a receiver.

    • Output: The device serves as a sender and can directly output the data, such as card code.

    • Convert To Card No. Output: The device serves as a sender and cannot directly output data, such as the face data.

  • Wiegand Input Data Order: Set the Wiegand input data sequence between Normal and Reversed. If you select Reversed, then the input card number will be reversed.

  • Wiegand Output Data Order: Determine the sequence of the card data after the Wiegand conversion.

    For example, if the card data is 0x11 0x22 0x33 0x44 0x55, it will be 0x33 0x44 0x55 after the Wiegand conversion(e.g., Wiegand 26). If Reversed is selected, the card data is 0x55 0x44 0x33.

  • Wiegand Output Basic Data Order: Set the sequence of the card data before going through Wiegand conversion and outputting the card code.

    For example, if the card data is 0x11 0x22 0x33 0x44 and the Reversed option is selected, the data will be 0x44 0x33 0x22 0x11.

  • Wiegand Output CRC Enabled: It is enabled by default for Wiegand data inspection. Disabling it may lead to integration failure with third-party devices.

Note

Click here to view more information on Wiegand settings including:

  • Akuvox devices work as Wiegand input/output;

  • Wiegand Card Reader Connection.

Integration via HTTP API

HTTP API is designed to achieve a network-based integration between the third-party device and the Akuvox device.

Set it up on the web Setting > HTTP API interface.

  • Enabled:  Enable or disable the HTTP API function for third-party integration. If the function is disabled, any request to initiate the integration will be denied and return HTTP 403 forbidden status.

  • Authorization Mode: It is Digest by default. You are required to fill in the username and  password for the authentication. In the Authorization field of the HTTP request header, use the Base64 encode method to encode the username and password.

  • User Name: Enter the user name for authentication. The default is admin.

  • Password: Enter the password for authentication. The default is admin.

  • 1st IP-5th IP: Enter the IP address of the third-party devices when the Allowlist authorization is selected for the integration.

Please refer to the following description for the authentication mode:

NO.

Authorization Mode

Description

1

None

No authentication is required for HTTP API as it is only used for demo testing.

2

Normal

This mode is used by Akuvox developers only.

3

Allowlist

If this mode is selected, you are only required to fill in the IP address of the third-party device for the authentication. The allowlist is suitable for operation in the LAN.

4

Basic

If this mode is selected, you are required to fill in the username and password for the authentication. In the Authorization field of the HTTP request header, use the Base64 encode method to encode of username and password.

5

Digest

The password encryption method only supports MD5. MD5( Message-Digest Algorithm) in Authorization field of HTTP request header: WWW-Authenticate: Digest realm="HTTPAPI",qop="auth,auth-int",nonce="xx", opaque="xx".

6

Token

This mode is used by Akuvox developers only.

Integration via RS485

You can connect the device to an external device such as SR01 or an OSDP-based card reader via RS485. To make the connection effective, you need to select the right RS485 mode.

Click here to view the detailed configuration of the OSDP feature.

To set it up, go to the Device > RS485 interface.

  • Apply RS485 Setting To:

    • Disabled: The RS485 function is disabled.

    • OSDP: The device is connected to an OSDP-based external device such as a card reader.

    • Security Relay: The device is connected to Akuvox Security Relay, SR01.

  • Encryption: Check this option when the protocol is encrypted.

  • Transfer Mode: Select the RS485 working mode, Output, or Input.

  • SCBK Value: Secure Communication Key Value.

    • When it is filled, OSDP will use this value for encryption, employing a customized protocol for communication.

    • When it is left empty, OSDP will use the default encrypted protocol for communication.

Power Output Control

The device can serve as a power supply for the external relays. Click here to view power output requirements.

To set it up, go to Access Control > Relay > 12V Power Output interface.

  • Power Output Type:

    • Always: Provide continuous power to the third-party device.

    • Triggered by Open Relay: Provide power to the third-party device via 12 output and GND interface during the timeout when the status of relays is shifted from low to high.