libvcomm  1.0
 All Data Structures Files Functions Variables Typedefs Macros Groups Pages
Functions
libvcomm API

Functions

VCOMMAPI int VCOMMCALL Vget_event (hid_device **vhandle, irevent_t *ev, int eventnum)
 Get single event from IRvoodoo. More...
 
VCOMMAPI int VCOMMCALL Vget_eventmap (hid_device **vhandle, eventmap_t *em)
 Get whole eventmap from IRvoodoo. More...
 
VCOMMAPI int VCOMMCALL Vget_ircode (hid_device **vhandle, ircode_t *ircode)
 Get last decoded IRcode from IRvoodoo. More...
 
VCOMMAPI int VCOMMCALL Vget_irframe (hid_device **vhandle, irframe_t *irframe)
 Get IRframe from IRvoodoo. More...
 
VCOMMAPI int VCOMMCALL Vget_fw_version (hid_device **vhandle, uint32_t *fwver)
 Get IRvoodoo firmware version. More...
 
VCOMMAPI int VCOMMCALL Vget_id (hid_device **vhandle, hwid_t *id)
 Get IRvoodoo hardware info. Gets MCU type and UUID. More...
 
VCOMMAPI int VCOMMCALL Vget_fw (hid_device **vhandle, uint8_t *fwdata)
 Download firmware from IRvoodoo. More...
 
VCOMMAPI int VCOMMCALL Vset_mode (hid_device **vhandle, int mode)
 Set IRvoodoo operation mode. More...
 
VCOMMAPI int VCOMMCALL Vset_led (hid_device **vhandle, int ledstate)
 Switch led on or off. More...
 
VCOMMAPI int VCOMMCALL Vclear_last (hid_device **vhandle)
 Clear last decoded IRcode and IRframe. More...
 
VCOMMAPI int VCOMMCALL Vclear_eventmap (hid_device **vhandle)
 Clear eventmap in EEPROM. More...
 
VCOMMAPI int VCOMMCALL Vset_ircode (hid_device **vhandle, ircode_t *ircode, cmdstat_t *cmdstat)
 Set and blast IRcode. More...
 
VCOMMAPI int VCOMMCALL Vset_event (hid_device **vhandle, ircode_t *from_ircode, ircode_t *to_ircode, cmdstat_t *cmdstat)
 Create and save IRevent to eventmap. More...
 
VCOMMAPI int VCOMMCALL Vset_irframe_page (hid_device **vhandle, uint8_t page_num, uint32_t *page_data, cmdstat_t *cmdstat)
 Set ... More...
 
VCOMMAPI int VCOMMCALL Vset_irframe_info (hid_device **vhandle, uint16_t num_pulses, cmdstat_t *cmdstat)
 Set ... More...
 
VCOMMAPI int VCOMMCALL Vset_irframe (hid_device **vhandle, irframe_t *irframe)
 Delete event from eventmap. More...
 
VCOMMAPI int VCOMMCALL Vclear_event_ircode (hid_device **vhandle, ircode_t *ircode, cmdstat_t *cmdstat)
 Delete event from eventmap. More...
 
VCOMMAPI int VCOMMCALL Vclear_event_num (hid_device **vhandle, int eventnum, cmdstat_t *cmdstat)
 Delete event NUM from eventmap. More...
 
VCOMMAPI int VCOMMCALL Vget_config (hid_device **vhandle, config_t *config)
 Get configuration from IRvoodoo. More...
 
VCOMMAPI int VCOMMCALL Vset_config (hid_device **vhandle, config_t *config)
 Set configuration. More...
 
VCOMMAPI int VCOMMCALL Vreset_config (hid_device **vhandle)
 Reset configuration to default values. More...
 
VCOMMAPI int VCOMMCALL Vget_stat (hid_device **vhandle, stat_t *stat)
 Get runtime statistics. More...
 
VCOMMAPI int VCOMMCALL Venter_isp (hid_device **vhandle, uint8_t time)
 Enter ISP mode. More...
 
VCOMMAPI int VCOMMCALL Vget_btn (hid_device **vhandle, uint8_t *state)
 Get button state. Useful for hardware testing. More...
 
VCOMMAPI int VCOMMCALL Vopen (hid_device **vhandle, char *serial)
 Open an IRvoodoo connection. More...
 
VCOMMAPI int VCOMMCALL Vclose (hid_device **vhandle)
 Close an IRvoodoo connection. More...
 
VCOMMAPI int VCOMMCALL Vcomm (hid_device **vhandle, request_t *req, response_t *resp)
 Send and receive data from IRvoodoo. More...
 
VCOMMAPI unsigned int VCOMMCALL Vtest (hid_device **vhandle)
 Test an IRvoodoo connection. More...
 
VCOMMAPI struct
hid_device_info *VCOMMCALL 
Vlist (void)
 Get list of connected IRvoodoo devices. More...
 

Detailed Description

Function Documentation

VCOMMAPI int VCOMMCALL Vclear_event_ircode ( hid_device **  vhandle,
ircode_t ircode,
cmdstat_t cmdstat 
)

Delete event from eventmap.

Find event from EventMap by IRcode and delete it.

Parameters
[in]vhandleIRvoodoo connection handle
[in]irframeIRframe to find
[out]cmdstatcommand response from IRvoodoo
Returns
This function returns 0 on success or error code on error.

Definition at line 295 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vclear_event_num ( hid_device **  vhandle,
int  eventnum,
cmdstat_t cmdstat 
)

Delete event NUM from eventmap.

Parameters
[in]vhandleIRvoodoo connection handle
[in]eventnumEvent number in eventmap
[out]cmdstatcommand response from IRvoodoo
Returns
This function returns 0 on success or error code on error.

Definition at line 318 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vclear_eventmap ( hid_device **  vhandle)

Clear eventmap in EEPROM.

Parameters
[in]vhandleIRvoodoo connection handle
Returns
This function returns 0 on success or error code on error.

Definition at line 167 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vclear_last ( hid_device **  vhandle)

Clear last decoded IRcode and IRframe.

Parameters
[in]vhandleIRvoodoo connection handle
Returns
This function returns 0 on success or error code on error.

Definition at line 154 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vclose ( hid_device **  vhandle)

Close an IRvoodoo connection.

Parameters
[in]vhandleIRvoodoo connection handle
Returns
This function returns 0 on success or error code on error.

Definition at line 91 of file vcomm.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vcomm ( hid_device **  vhandle,
request_t req,
response_t resp 
)

Send and receive data from IRvoodoo.

Parameters
[in]vhandleIRvoodoo connection handle
[in]reqrequest to IRvoodoo
[out]respresponse from IRvoodoo
Returns
This function returns 0 on success or error code on error.

Definition at line 100 of file vcomm.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Venter_isp ( hid_device **  vhandle,
uint8_t  time 
)

Enter ISP mode.

Enter ISP mode (become USB MSC device) for firmware upgrade. Restart IRvoodoo after n sec

Parameters
[in]vhandleIRvoodoo connection handle
[in]timeISP timeout (restart IRvoodoo to normal mode)

Definition at line 411 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_btn ( hid_device **  vhandle,
uint8_t *  state 
)

Get button state. Useful for hardware testing.

Parameters
[in]vhandleIRvoodoo connection handle
[out]statusIRvoodoo button status (1 button down, 0 button up)
Returns
This function returns 0 on success or error code on error.

Definition at line 429 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_config ( hid_device **  vhandle,
config_t config 
)

Get configuration from IRvoodoo.

Parameters
[in]vhandleIRvoodoo connection handle
[out]configIRvoodoo configuration structure
Returns
This function returns 0 on success or error code on error.

Definition at line 342 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_event ( hid_device **  vhandle,
irevent_t ev,
int  eventnum 
)

Get single event from IRvoodoo.

Parameters
[in]vhandleIRvoodoo connection handle
[out]evevent structure
[in]eventnumin Eventmap
Returns
This function returns 0 on success or error code on error.

Definition at line 17 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_eventmap ( hid_device **  vhandle,
eventmap_t em 
)

Get whole eventmap from IRvoodoo.

Parameters
[in]vhandleIRvoodoo connection handle
[out]emeventmap structure
Returns
This function returns 0 on success or error code on error.

Definition at line 35 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_fw ( hid_device **  vhandle,
uint8_t *  fwdata 
)

Download firmware from IRvoodoo.

Download (backup) whole flash memory content.

Parameters
[in]vhandleIRvoodoo connection handle
[out]fwdatapointer to databuffer. NB! buffer size must equal to flash size (32 * 1024 bytes)
Returns
This function returns 0 on success or error code on error.

Definition at line 108 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_fw_version ( hid_device **  vhandle,
uint32_t *  fwver 
)

Get IRvoodoo firmware version.

Parameters
[in]vhandleIRvoodoo connection handle
[out]fwverfirmware version
Returns
This function returns 0 on success or error code on error.

Definition at line 95 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_id ( hid_device **  vhandle,
hwid_t id 
)

Get IRvoodoo hardware info. Gets MCU type and UUID.

Parameters
[in]vhandleIRvoodoo connection handle
[out]idhardware info structure hwid_t
Returns
This function returns 0 on success or error code on error.

Definition at line 81 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_ircode ( hid_device **  vhandle,
ircode_t ircode 
)

Get last decoded IRcode from IRvoodoo.

Parameters
[in]vhandleIRvoodoo connection handle
[out]ircodeIRcode structure
Returns
This function returns 0 on success or error code on error.

Definition at line 51 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_irframe ( hid_device **  vhandle,
irframe_t irframe 
)

Get IRframe from IRvoodoo.

Parameters
[in]vhandleIRvoodoo connection handle
[out]irframeIRframe structure
Returns
This function returns 0 on success or error code on error.

Definition at line 67 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vget_stat ( hid_device **  vhandle,
stat_t stat 
)

Get runtime statistics.

Parameters
[in]vhandleIRvoodoo connection handle
[out]statIRvoodoo runtime statistics
Returns
This function returns 0 on success or error code on error.

Definition at line 391 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI struct hid_device_info* VCOMMCALL Vlist ( void  )
read

Get list of connected IRvoodoo devices.

Returns
Returns linked list of hid_device_info structures or NULL (no devices connected).

Definition at line 16 of file vcomm.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vopen ( hid_device **  vhandle,
char *  serial 
)

Open an IRvoodoo connection.

Parameters
[out]vhandleIRvoodoo connection handle
[in]serialOpen specific IRvoodoo device by USB serial number.
Use NULL instead of serial to open first IRvoodoo device found.
Returns
This function returns 0 on success or error code on error.

Definition at line 28 of file vcomm.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vreset_config ( hid_device **  vhandle)

Reset configuration to default values.

Parameters
[in]vhandleIRvoodoo connection handle
Returns
This function returns 0 on success or error code on error.

Definition at line 376 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vset_config ( hid_device **  vhandle,
config_t config 
)

Set configuration.

Parameters
[in]vhandleIRvoodoo connection handle
[out]configIRvoodoo configuration structure
Returns
This function returns 0 on success or error code on error.

Definition at line 359 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vset_event ( hid_device **  vhandle,
ircode_t from_ircode,
ircode_t to_ircode,
cmdstat_t cmdstat 
)

Create and save IRevent to eventmap.

Parameters
[in]vhandleIRvoodoo connection handle
[in]from_ircodefrom IRcode
[in]to_ircodeto IRcode
[out]cmdstatcommand response from IRvoodoo
Returns
This function returns 0 on success or error code on error.

Definition at line 202 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vset_ircode ( hid_device **  vhandle,
ircode_t ircode,
cmdstat_t cmdstat 
)

Set and blast IRcode.

Parameters
[in]vhandleIRvoodoo connection handle
[in]ircodeIRcode to blast
[out]cmdstatVset_ircode command response from IRvoodoo
Returns
This function returns 0 on success or error code on error.

Definition at line 181 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vset_irframe ( hid_device **  vhandle,
irframe_t irframe 
)

Delete event from eventmap.

Find event from EventMap by IRcode and delete it.

Parameters
[in]vhandleIRvoodoo connection handle
[in]ircodeIRcode to find
[out]cmdstatcommand response from IRvoodoo
Returns
This function returns 0 on success or error code on error.

Definition at line 272 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vset_irframe_info ( hid_device **  vhandle,
uint16_t  num_pulses,
cmdstat_t cmdstat 
)

Set ...

Parameters
[in]vhandleIRvoodoo connection handle
[in]IRframepage number (0..15)
[in]pointerto page data (12 * uint_32t)
[out]cmdstatcommand response from IRvoodoo
Returns
This function returns 0 on success or error code on error.

Definition at line 250 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vset_irframe_page ( hid_device **  vhandle,
uint8_t  page_num,
uint32_t *  page_data,
cmdstat_t cmdstat 
)

Set ...

Parameters
[in]vhandleIRvoodoo connection handle
[in]IRframepage number (0..15)
[in]pointerto page data (12 * uint_32t)
[out]cmdstatcommand response from IRvoodoo
Returns
This function returns 0 on success or error code on error.

Definition at line 229 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vset_led ( hid_device **  vhandle,
int  ledstate 
)

Switch led on or off.

Parameters
[in]vhandleIRvoodoo connection handle
[in]ledstate(0 = LED off, 1 = LED on)
Returns
This function returns 0 on success or error code on error.

Definition at line 137 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI int VCOMMCALL Vset_mode ( hid_device **  vhandle,
int  mode 
)

Set IRvoodoo operation mode.

Operation modes:

  1. REQ_SET_MODE_NORMAL normal operation mode
  2. REQ_SET_MODE_CFG configuration mode. Out events (keyboard, mouse, ...) are disabled.
  3. REQ_SET_MODE_CAPT special capture mode for raw IR data capturing. Out events (keyboard, mouse, ...) are disabled.
Parameters
[in]vhandleIRvoodoo connection handle
[in]modeoperation mode
Returns
This function returns 0 on success or error code on error.

Definition at line 121 of file vactions.c.

Here is the call graph for this function:

VCOMMAPI unsigned int VCOMMCALL Vtest ( hid_device **  vhandle)

Test an IRvoodoo connection.

Parameters
[in]vhandleIRvoodoo connection handle
Returns
This function returns IRvoodoo firmware version

Definition at line 176 of file vcomm.c.

Here is the call graph for this function: