Integration with Third-Party Devices

Integration via Wiegand

Set it up on the Intercom > Advanced > Wiegand interface.

• Wiegand Type: The transmission format should be identical between the door phone and the third-party device.

• Wiegand Mode:

  • Input: The device serves as a receiver.

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

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

• Wiegand Input Clear Time: When the interval of entering passwords exceeds the time. All entered passwords will be cleared.

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

• Wiegand Display Mode: Select the Wiegand card code format from the provided options: 8H10D, 6H3D5D(W26), 6H8D, 8HN, 8HR, RAW, and 8HR10D.

  • Ignore Facility Code: This option is available when 6H3D5D(WG26) is selected. When enabled, the first three bits of the cards will be ignored for successful card reading.

• RF Card Verification: Available when Output or Convert to Card No. Output is selected. When enabled, the device will verify whether the card code is assigned to a user. If it is not, a prompt "Opening Door Failed" will pop up on the door phone screen. When disabled, the door phone will not perform local verification.

• Wiegand Output 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 CRC: It is enabled by default for Wiegand data inspection. Disabling it may lead to integration failure with third-party devices.

• Wiegand Open Relay: Check the relay to be triggered through Wiegand.

• Convert To Wiegand Output: Available when Output is selected as Wiegand Transfer Mode. This option determines the output PIN format.

  • Disabled: Turn off the feature.

  • 8 bits per digit: When users press "1" on the keypad, the binary data will be transmitted in 8 bits, "11100001".

  • 4 bits per digit: When users press "1" on the keypad, the binary data will be transmitted in 4 bits, "0001".

  • All at once: After users enter the whole PIN code, the data will be transmitted according to the Wiegand card reader mode. For example, “123456” will be converted to “01e240” in Wiegand 26.

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

Set it up on the web Intercom > HTTP API interface for the integration.

• HTTP API: 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.

• Auth Mode: Select among the following options: None, Normal, Allowlist, Basic, Digest, and Token for authorization type, which will be explained in detail in the following chart.

• User Name: Enter the user name when Basic or Digest authorization mode is selected. The default username is admin.

• Password: Enter the password when Basic or Digest authorization mode is selected. The default password 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:

Power Output Control

Set it up on the Intercom > Relay interface.

• 12V Power Output:

  • Disabled: Disable the power output function;

  • 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.

    • Time Out (Sec): Select the power supply time duration after the relay is triggered from 3, 5, and 10. It is 3 seconds by default. The power output is 12V, and the maximum output amperage is 0.8A.

  • Security Relay A: The device can work with the security relay.

Integration via RS485

Set it up on the Intercom > RS485 interface.

• Disabled: The RS485 function is disabled.

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

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

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

    • Local Relay Verification: When Output is selected, set whether to carry out the access credentials verification. When unchecked, door-opening failure prompts will not be given.

  • 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.

• Security Relay: Select this option when the device works with the SR01.

Integration with Third-party Access Control Server

The device can transmit QR codes, card data, and face data to a third-party server without doing any verification. The generation and verification of the data are conducted on the third-party server.

To set it up, go to Intercom > Relay > Third Party Integration interface.

• List:

  • None: Disable the function.

  • General: Transmit the QR code-linked HTTP URL in Akuvox’s method.

    • HTTP URL: Enter the HTTP command format provided by the third-party service provider. After scanning the QR code, the HTTP command will carry the dynamic QR code information automatically before it is sent to the QR code server for verification. See the example: http://{Server IP}:8090/api/visitor/scan?codeKey={QRCode}&deviceId={DeviceID}.

    • Device ID: The device ID is provided by the third-party server. It will be added to the HTTP command automatically when using a QR code for door access.

  • Customize: Transmit QR code, RF card, and face data in a customized method.

    • Prompt on LCD: Select Default to adopt the Akuvox door phone’s door-opening prompt; Select Return Value to use the return value from the third-party server as the prompt.

    • Remote Verification: Check the access method(s) to be verified by the third-party server. When Face is checked, the face data will be converted into feature values and sent to the third-party server in a string format.

    • HTTP URL: Enter the HTTP command in a format provided by the third-party service provider. After QR code scanning, card swiping, or facial recognition, the HTTP command will carry the dynamic information automatically before it is sent to the server for verification. See the example: http://{Server IP}:8090/api/visitor/scan?codeKey={QRCode}/{CardCode}/{FaceData}&deviceId={DeviceID}. For example, if a user swipes the RF card, the URL will be http://192.168.35.123:8090/api/visitor/scan?codeKey={QRCode}/45678999/{FaceData}&deviceId=1.

    • Device ID: The device ID is provided by the third-party server. It will be added to the HTTP command automatically when using the QR code, RF card, or facial recognition for door access.

Integration with Control4

To enable the integration, turn on a switch on the Intercom > Control4 interface.

• Control4: When enabled, High Security Mode, RTSP Authentication, and Discovery Mode will all be disabled.