C API for BALTECH SDK
brp_protocol.h File Reference

Implements the core BRP protocol. More...

#include "protocol.h"

Go to the source code of this file.

Macros

BRP_MODE_XXX

Specifies the run mode / frame format of BRP protocol.

#define BRP_MODE_STD   0x00
 Standard mode. More...
 
#define BRP_MODE_NONE   BRP_MODE_STD
 legacy define More...
 
#define BRP_MODE_CONTINUOUS   0x01
 Continous mode. More...
 
#define BRP_MODE_REPEAT   0x02
 Repeat mode. More...
 
#define BRP_MODE_BREAK   0x03
 Stop continuous / repeat mode. More...
 

Functions

BRP_LIB brp_protocol brp_create_brp (void)
 Creates a new BRP protocol. More...
 
BRP_LIB brp_errcode brp_exec_cmd (brp_protocol protocol, int cmd_code, brp_buf param_buf, size_t param_len, brp_buf resp_buf, size_t max_resp_len, size_t *resp_len, brp_time cmd_timeout)
 Runs a command on the BRP device connected via the assigned protocol. More...
 
BRP_LIB brp_errcode brp_send_cmd (brp_protocol protocol, int cmd_code, brp_buf param_buf, size_t param_len, brp_time cmd_timeout, int mode)
 Sends a command frame via a BRP protocol. More...
 
BRP_LIB brp_errcode brp_recv_cmd (brp_protocol protocol, brp_buf resp_buf, size_t max_resp_len, size_t *resp_len, brp_time timeout)
 Returns the response of a command runned on the BRP device connected via base_protocol. More...
 
BRP_LIB brp_errcode brp_break_cmd (brp_protocol protocol)
 Stops a command that was run with brp_send_cmd() with the mode parameter set to in BRP_MODE_CONTINUOUS or BRP_MODE_REPEAT. More...
 

Detailed Description

Implements the core BRP protocol.

Definition in file brp_protocol.h.