C API for BALTECH SDK

§ brp_Legic_TransparentCommand4000()

brp_errcode brp_Legic_TransparentCommand4000 ( brp_protocol  protocol,
unsigned  CmdCode,
brp_buf  CmdParams,
size_t  CmdParams_len,
unsigned  Timeout,
unsigned *  Status,
brp_buf Resp,
size_t *  Resp_len,
brp_mempool mempool 
)

Transparent command to directly access the LEGIC reader chip modules from the 4000 series, e.g. the SM-4200 or SM-4500.

Every command which is defined in the LEGIC documentation for the SM-4x00 chip may be executed using this pass-through command.

For the direct communication with the SM-4x00 LEGIC defines a protocol frame that consists of the following fields (refer also to LEGIC documentation):

LEN | CMD | DATA[] | CRC —|—|—|—

The reader firmware handles this frame protocol internally by calculating and appending the LEN and CRC fields automatically. The host application only specifies the fields CMD and DATA in the transparent command parameters.

The protocol frame for the response consists of the following fields:

LEN | CMD | STAT | DATA[] | CRC —|—|—|—|—

Similar to the command frame protocol also the response frame protocol is handled by the reader firmware. It verifies the CRC checksum and removes the LEN, CMD and CRC fields. Only STAT and DATA are returned to the host.

Parameters
[in]protocolused to execute the command
[in]CmdCodeCommand code of command to be executed. This parameter equals the parameter CMD in the LEGIC documentation.
[in]CmdParamsCommand specific parameter bytes. This parameter contains all command related parameters also referred to as DATA. Please don't mix the preceding length value up with the LEN field in the LEGIC documentation!
[in]CmdParams_len
[in]TimeoutCommand execution timeout in ms. The parameter specifies the maximum time the device should wait for a response from the SM4x00 before it interrupts command execution and returns a status message. The required value is not specified exactly by LEGIC. It depends on the particular command and its parameters. In case the reader returns the BRP status code Lga.ErrCommunication the selected timeout might be too small.
[out]StatusThe received SM4x00 specific status code. This response parameter equals the parameter STAT in the LEGIC documentation.
[out]RespThe received command response bytes. Please don't mix the preceding length value up with the LEN field in the LEGIC documentation!
[out]Resp_len
[in]mempoolis used to store response data. Maybe NULL to use an internal mempool, in this case the data is only available until another command uses the internal mempool