Section 3: library functions
brlapi_writeArgumentsPacket_t – Synopsis#include <brlapi_protocol.h> Data Fieldsuint32_t flags unsigned char data Detailed DescriptionStructure of extended write packets Field Documentationunsigned char brlapi_writeArgumentsPacket_t::dataFlags to tell which fields are present uint32_t brlapi_writeArgumentsPacket_t::flagsAuthorGenerated automatically by Doxygen for BrlAPI from the source code.
Writing on the braille display – Write text to the braille display. Data Structuresstruct brlapi_writeArguments_t Macros#define BRLAPI_DISPLAY_DEFAULT -1 #define BRLAPI_CURSOR_LEAVE -1 #define BRLAPI_CURSOR_OFF 0 #define BRLAPI_WRITEARGUMENTS_INITIALIZER { BRLAPI_DISPLAY_DEFAULT, 0, 0, NULL, -1, NULL, NULL, BRLAPI_CURSOR_LEAVE, NULL } Functionsint BRLAPI_STDCALL brlapi_writeText (int cursor, const char *text) int BRLAPI_STDCALL brlapi__writeText (brlapi_handle_t *handle, int cursor, const char *text)…
brlapi_versionPacket_t – Synopsis#include <brlapi_protocol.h> Data Fieldsuint32_t protocolVersion Detailed DescriptionStructure of version packets Field Documentationuint32_t brlapi_versionPacket_t::protocolVersionAuthorGenerated automatically by Doxygen for BrlAPI from the source code.
Version of the BrlAPI library – Macros#define BRLAPI_RELEASE ‘0.6.0’ #define BRLAPI_MAJOR 0 #define BRLAPI_MINOR 6 #define BRLAPI_REVISION 0 Detailed DescriptionMacro Definition Documentation#define BRLAPI_MAJOR 0Library major version. #define BRLAPI_MINOR 6Library minor version. #define BRLAPI_RELEASE ‘0.6.0’Library version. #define BRLAPI_REVISION 0Library revision. AuthorGenerated automatically by Doxygen for BrlAPI from the source code.
Deprecated names – Data Structuresstruct brlapi_writeStruct Macros#define brlapi_settings_t brlapi_connectionSettings_t #define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER #define brl_keycode_t brlapi_keyCode_t #define brl_type_t brlapi_packetType_t #define BRLCOMMANDS NULL #define BRL_KEYCODE_MAX BRLAPI_KEY_MAX #define brlapi_initializeConnection brlapi_openConnection #define brlapi_getTty brlapi_enterTtyMode #define brlapi_getTtyPath brlapi_enterTtyModeWithPath #define brlapi_leaveTty brlapi_leaveTtyMode #define brlapi_unignoreKeyRange brlapi_acceptKeyRange #define brlapi_unignoreKeySet brlapi_acceptKeySet #define brlapi_getRaw brlapi_enterRawMode #define brlapi_leaveRaw brlapi_leaveRawMode #define brlapi_suspend brlapi_suspendDriver #define brlapi_resume brlapi_resumeDriver #define…
Deprecated names – Data Structuresstruct brlapi_writeStruct Macros#define brlapi_settings_t brlapi_connectionSettings_t #define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER #define brl_keycode_t brlapi_keyCode_t #define brl_type_t brlapi_packetType_t #define BRLCOMMANDS NULL #define BRL_KEYCODE_MAX BRLAPI_KEY_MAX #define brlapi_initializeConnection brlapi_openConnection #define brlapi_getTty brlapi_enterTtyMode #define brlapi_getTtyPath brlapi_enterTtyModeWithPath #define brlapi_leaveTty brlapi_leaveTtyMode #define brlapi_unignoreKeyRange brlapi_acceptKeyRange #define brlapi_unignoreKeySet brlapi_acceptKeySet #define brlapi_getRaw brlapi_enterRawMode #define brlapi_leaveRaw brlapi_leaveRawMode #define brlapi_suspend brlapi_suspendDriver #define brlapi_resume brlapi_resumeDriver #define…
Entering & leaving tty mode – How to take control of ttys for direct braille display / read. Macros#define BRLAPI_TTY_DEFAULT -1 Functionsint BRLAPI_STDCALL brlapi_enterTtyMode (int tty, const char *driver) int BRLAPI_STDCALL brlapi__enterTtyMode (brlapi_handle_t *handle, int tty, const char *driver) int BRLAPI_STDCALL brlapi_enterTtyModeWithPath (int *ttys, int count, const char *driver) int BRLAPI_STDCALL brlapi__enterTtyModeWithPath (brlapi_handle_t *handle, int…
Driver-Specific modes – Raw and Suspend Modes mechanism. Functionsint BRLAPI_STDCALL brlapi_enterRawMode (const char *driver) int BRLAPI_STDCALL brlapi__enterRawMode (brlapi_handle_t *handle, const char *driver) int BRLAPI_STDCALL brlapi_leaveRawMode (void) int BRLAPI_STDCALL brlapi__leaveRawMode (brlapi_handle_t *handle) ssize_t BRLAPI_STDCALL brlapi_sendRaw (const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi__sendRaw (brlapi_handle_t *handle, const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi_recvRaw (void *buffer, size_t…
Deprecated names – Data Structuresstruct brlapi_writeStruct Macros#define brlapi_settings_t brlapi_connectionSettings_t #define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER #define brl_keycode_t brlapi_keyCode_t #define brl_type_t brlapi_packetType_t #define BRLCOMMANDS NULL #define BRL_KEYCODE_MAX BRLAPI_KEY_MAX #define brlapi_initializeConnection brlapi_openConnection #define brlapi_getTty brlapi_enterTtyMode #define brlapi_getTtyPath brlapi_enterTtyModeWithPath #define brlapi_leaveTty brlapi_leaveTtyMode #define brlapi_unignoreKeyRange brlapi_acceptKeyRange #define brlapi_unignoreKeySet brlapi_acceptKeySet #define brlapi_getRaw brlapi_enterRawMode #define brlapi_leaveRaw brlapi_leaveRawMode #define brlapi_suspend brlapi_suspendDriver #define brlapi_resume brlapi_resumeDriver #define…
Error handling – How to handle errors. Data Structuresstruct brlapi_error_t Macros#define BRLAPI_ERROR_SUCCESS 0 #define BRLAPI_ERROR_NOMEM 1 #define BRLAPI_ERROR_TTYBUSY 2 #define BRLAPI_ERROR_DEVICEBUSY 3 #define BRLAPI_ERROR_UNKNOWN_INSTRUCTION 4 #define BRLAPI_ERROR_ILLEGAL_INSTRUCTION 5 #define BRLAPI_ERROR_INVALID_PARAMETER 6 #define BRLAPI_ERROR_INVALID_PACKET 7 #define BRLAPI_ERROR_CONNREFUSED 8 #define BRLAPI_ERROR_OPNOTSUPP 9 #define BRLAPI_ERROR_GAIERR 10 #define BRLAPI_ERROR_LIBCERR 11 #define BRLAPI_ERROR_UNKNOWNTTY 12 #define BRLAPI_ERROR_PROTOCOL_VERSION 13 #define BRLAPI_ERROR_EOF 14…
Error handling – How to handle errors. Data Structuresstruct brlapi_error_t Macros#define BRLAPI_ERROR_SUCCESS 0 #define BRLAPI_ERROR_NOMEM 1 #define BRLAPI_ERROR_TTYBUSY 2 #define BRLAPI_ERROR_DEVICEBUSY 3 #define BRLAPI_ERROR_UNKNOWN_INSTRUCTION 4 #define BRLAPI_ERROR_ILLEGAL_INSTRUCTION 5 #define BRLAPI_ERROR_INVALID_PARAMETER 6 #define BRLAPI_ERROR_INVALID_PACKET 7 #define BRLAPI_ERROR_CONNREFUSED 8 #define BRLAPI_ERROR_OPNOTSUPP 9 #define BRLAPI_ERROR_GAIERR 10 #define BRLAPI_ERROR_LIBCERR 11 #define BRLAPI_ERROR_UNKNOWNTTY 12 #define BRLAPI_ERROR_PROTOCOL_VERSION 13 #define BRLAPI_ERROR_EOF 14…
Deprecated names – Data Structuresstruct brlapi_writeStruct Macros#define brlapi_settings_t brlapi_connectionSettings_t #define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER #define brl_keycode_t brlapi_keyCode_t #define brl_type_t brlapi_packetType_t #define BRLCOMMANDS NULL #define BRL_KEYCODE_MAX BRLAPI_KEY_MAX #define brlapi_initializeConnection brlapi_openConnection #define brlapi_getTty brlapi_enterTtyMode #define brlapi_getTtyPath brlapi_enterTtyModeWithPath #define brlapi_leaveTty brlapi_leaveTtyMode #define brlapi_unignoreKeyRange brlapi_acceptKeyRange #define brlapi_unignoreKeySet brlapi_acceptKeySet #define brlapi_getRaw brlapi_enterRawMode #define brlapi_leaveRaw brlapi_leaveRawMode #define brlapi_suspend brlapi_suspendDriver #define brlapi_resume brlapi_resumeDriver #define…
Entering & leaving tty mode – How to take control of ttys for direct braille display / read. Macros#define BRLAPI_TTY_DEFAULT -1 Functionsint BRLAPI_STDCALL brlapi_enterTtyMode (int tty, const char *driver) int BRLAPI_STDCALL brlapi__enterTtyMode (brlapi_handle_t *handle, int tty, const char *driver) int BRLAPI_STDCALL brlapi_enterTtyModeWithPath (int *ttys, int count, const char *driver) int BRLAPI_STDCALL brlapi__enterTtyModeWithPath (brlapi_handle_t *handle, int…
Error handling – How to handle errors. Data Structuresstruct brlapi_error_t Macros#define BRLAPI_ERROR_SUCCESS 0 #define BRLAPI_ERROR_NOMEM 1 #define BRLAPI_ERROR_TTYBUSY 2 #define BRLAPI_ERROR_DEVICEBUSY 3 #define BRLAPI_ERROR_UNKNOWN_INSTRUCTION 4 #define BRLAPI_ERROR_ILLEGAL_INSTRUCTION 5 #define BRLAPI_ERROR_INVALID_PARAMETER 6 #define BRLAPI_ERROR_INVALID_PACKET 7 #define BRLAPI_ERROR_CONNREFUSED 8 #define BRLAPI_ERROR_OPNOTSUPP 9 #define BRLAPI_ERROR_GAIERR 10 #define BRLAPI_ERROR_LIBCERR 11 #define BRLAPI_ERROR_UNKNOWNTTY 12 #define BRLAPI_ERROR_PROTOCOL_VERSION 13 #define BRLAPI_ERROR_EOF 14…
Driver-Specific modes – Raw and Suspend Modes mechanism. Functionsint BRLAPI_STDCALL brlapi_enterRawMode (const char *driver) int BRLAPI_STDCALL brlapi__enterRawMode (brlapi_handle_t *handle, const char *driver) int BRLAPI_STDCALL brlapi_leaveRawMode (void) int BRLAPI_STDCALL brlapi__leaveRawMode (brlapi_handle_t *handle) ssize_t BRLAPI_STDCALL brlapi_sendRaw (const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi__sendRaw (brlapi_handle_t *handle, const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi_recvRaw (void *buffer, size_t…
Driver-Specific modes – Raw and Suspend Modes mechanism. Functionsint BRLAPI_STDCALL brlapi_enterRawMode (const char *driver) int BRLAPI_STDCALL brlapi__enterRawMode (brlapi_handle_t *handle, const char *driver) int BRLAPI_STDCALL brlapi_leaveRawMode (void) int BRLAPI_STDCALL brlapi__leaveRawMode (brlapi_handle_t *handle) ssize_t BRLAPI_STDCALL brlapi_sendRaw (const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi__sendRaw (brlapi_handle_t *handle, const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi_recvRaw (void *buffer, size_t…
Deprecated names – Data Structuresstruct brlapi_writeStruct Macros#define brlapi_settings_t brlapi_connectionSettings_t #define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER #define brl_keycode_t brlapi_keyCode_t #define brl_type_t brlapi_packetType_t #define BRLCOMMANDS NULL #define BRL_KEYCODE_MAX BRLAPI_KEY_MAX #define brlapi_initializeConnection brlapi_openConnection #define brlapi_getTty brlapi_enterTtyMode #define brlapi_getTtyPath brlapi_enterTtyModeWithPath #define brlapi_leaveTty brlapi_leaveTtyMode #define brlapi_unignoreKeyRange brlapi_acceptKeyRange #define brlapi_unignoreKeySet brlapi_acceptKeySet #define brlapi_getRaw brlapi_enterRawMode #define brlapi_leaveRaw brlapi_leaveRawMode #define brlapi_suspend brlapi_suspendDriver #define brlapi_resume brlapi_resumeDriver #define…
Driver-Specific modes – Raw and Suspend Modes mechanism. Functionsint BRLAPI_STDCALL brlapi_enterRawMode (const char *driver) int BRLAPI_STDCALL brlapi__enterRawMode (brlapi_handle_t *handle, const char *driver) int BRLAPI_STDCALL brlapi_leaveRawMode (void) int BRLAPI_STDCALL brlapi__leaveRawMode (brlapi_handle_t *handle) ssize_t BRLAPI_STDCALL brlapi_sendRaw (const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi__sendRaw (brlapi_handle_t *handle, const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi_recvRaw (void *buffer, size_t…
BrlAPI’s protocol – Instructions and constants for BrlAPI ‘s protocol. Data Structuresstruct brlapi_header_t struct brlapi_versionPacket_t struct brlapi_authClientPacket_t struct brlapi_authServerPacket_t struct brlapi_errorPacket_t struct brlapi_getDriverSpecificModePacket_t struct brlapi_writeArgumentsPacket_t union brlapi_packet_t Macros#define BRLAPI_PROTOCOL_VERSION ((uint32_t) 8) /** Communication protocol version */ #define BRLAPI_MAXPACKETSIZE 512 #define BRLAPI_PACKET_VERSION ‘v’ #define BRLAPI_PACKET_AUTH ‘a’ #define BRLAPI_PACKET_GETDRIVERNAME ‘n’ #define BRLAPI_PACKET_GETDISPLAYSIZE ‘s’ #define BRLAPI_PACKET_ENTERTTYMODE ‘t’ #define…
BrlAPI’s protocol – Instructions and constants for BrlAPI ‘s protocol. Data Structuresstruct brlapi_header_t struct brlapi_versionPacket_t struct brlapi_authClientPacket_t struct brlapi_authServerPacket_t struct brlapi_errorPacket_t struct brlapi_getDriverSpecificModePacket_t struct brlapi_writeArgumentsPacket_t union brlapi_packet_t Macros#define BRLAPI_PROTOCOL_VERSION ((uint32_t) 8) /** Communication protocol version */ #define BRLAPI_MAXPACKETSIZE 512 #define BRLAPI_PACKET_VERSION ‘v’ #define BRLAPI_PACKET_AUTH ‘a’ #define BRLAPI_PACKET_GETDRIVERNAME ‘n’ #define BRLAPI_PACKET_GETDISPLAYSIZE ‘s’ #define BRLAPI_PACKET_ENTERTTYMODE ‘t’ #define…