Echelon OpenLDV - Manual (Page 5)

OpenLDV Programmer’s Guide v
Table of Contents
Welcome ......................................................................................................... iii
Audience ........................................................................................................ iii
Examples ....................................................................................................... iv
Related Documentation ................................................................................ iv
Chapter 1. Introduction ................................................................................... 1
Introduction to OpenLDV Networking ......................................................... 2
Client Applications .................................................................................. 3
OpenLDV Driver ...................................................................................... 3
Network Interfaces .................................................................................. 4
Installing the OpenLDV Software ................................................................ 5
Hardware and Software Requirements.................................................. 5
Downloading the OpenLDV Software .................................................... 5
Installing the OpenLDV Driver .............................................................. 6
Installing the OpenLDV SDK ................................................................. 6
Getting Started with the OpenLDV Driver .................................................. 7
Getting Started with the xDriver Component ............................................. 8
Chapter 2. Using the OpenLDV API ............................................................. 9
Introduction to OpenLDV Programming .................................................... 10
OpenLDV Application Architecture ............................................................ 11
Application Layer .................................................................................. 12
Presentation Layer ................................................................................ 13
Overview of the OpenLDV API ................................................................... 13
Referencing the OpenLDV Component ................................................ 14
Using Multiple Threads or Multiple Processes ................................... 14
The OpenLDV API ....................................................................................... 15
Working with Devices and Drivers ....................................................... 16
Using the OpenLDV API ....................................................................... 17
ldv_close() ............................................................................................... 18
ldv_free_device_info() ............................................................................ 18
ldv_free_driver_info() ............................................................................ 19
ldv_free_matching_devices() ................................................................. 20
ldv_get_device_info() ............................................................................. 20
ldv_get_driver_info() .............................................................................. 21
ldv_get_matching_devices() .................................................................. 22
ldv_get_version ...................................................................................... 22
ldv_locate_sicb() ..................................................................................... 23
ldv_open() ............................................................................................... 24
ldv_open_cap()........................................................................................ 25
ldv_read() ............................................................................................... 27
ldv_register_event() ............................................................................... 29
ldv_set_device_info() .............................................................................. 30
ldv_set_driver_info() .............................................................................. 31
ldv_write() .............................................................................................. 32
ldv_xlate_device_name() ....................................................................... 33
ldvx_open() ............................................................................................. 34
ldvx_register_window() ......................................................................... 36
ldvx_shutdown() ..................................................................................... 37
Structures and Enumerations for the Device API ..................................... 37
LDVDeviceInfo Structure ..................................................................... 37
LDVDevices Structure........................................................................... 38