OSDP readers management

Owned by Technical Service Specialist
Last updated: Jan 18, 2024
2 min read

The reader element allows to get state of OSDP reader device, add new device and etc.

Requests for management:

newosdpreader - add a new OSDP reader to the network, command execution takes some time. Extra options are:

  • k - user session ID;

  • name - the name of the element, the length is not more than 63 characters;

  • defbaud - default baud rate of reader, can be 9600, 19200, 38400, 57600, 115200, new readers usually have the “9600” default baud rate;

  • defaddr - default address of OSDP protocol, can be 0-126, new readers usually have the “0” default address;

  • defkey - default secured key of OSDP protocol, hexadecimal string with length of 32 symbols (“0123456789abcdefABCDEF” symbols only), new readers usually have the “303132333435363738393a3b3c3d3e3f” default key string;

  • addr - new address of the reader in network, can be 0-126;

  • key - new secured key, hexadecimal string with length of 32 symbols (“0123456789abcdefABCDEF” symbols only), must not be equal the default key “303132333435363738393a3b3c3d3e3f”.

If the new element is successfully created, the response is:

<error type="no error" id="407002" />

 

delosdpreader - remove the OSDP reader module and all related elements. Extra options:

  • k - user session ID;

  • module - ID of the module.

 

seekosdpreader - request for configuration purposes, it gives out 5 sound signals and 5 flashing LEDs on the desired OSDP reader. Extra options:

  • k - user session ID;

  • id - ID of the reader element.

 

getelement - read the reader element. Extra options:

  • k - user session ID;

  • id - ID of the reader element.

Information about the reader element looks like:

<element id="407002" module="2301" num="1" clas="devhwr" type="osdp reader" name="Reader BIG" state="idle" addr="34" key="000102030405060708090a0b0c0d0e0f" />

The “key“ field may not be if the user does not have enough rights to access.

The “state“ field can be:

  • not connected - the reader is not connected to the network;

  • idle - the reader is in working state;

  • normal - the read card is valid, access granted;

  • alarm - the read card is not valid, access denied.

 

updateelement - editing an OSDP reader element. Extra options are:

  • k - user session ID;

  • name - the name of the element, the length is not more than 63 characters;

  • addr - address of the reader in network, can be 0-126;

  • key - secured key, hexadecimal string with length of 32 symbols (“0123456789abcdefABCDEF” symbols only).