FarSync SDK - The Developers Toolkit for FarSync adapter products

The Developers Toolkit

The SDK includes support for writing applications on both Linux and Windows and contains documentation, working sample applications, development and test utility applications. There is everything a user needs to rapidly develop and test a wide variety of applications such as specialist synchronous (HDLC framed) protocols or transparent bitstream data requirements including Audio, MPEG Video T-DMB and DAB ETI.

Our Engineering department provides free email and telephone assistance to application developers using the API as part of the package provided when the FarSync SDK is purchased.

This toolkit is not appropriate for the FarSync X25 range of products, they are supplied with their own toolkit.

Product API Details

Windows SDCI API

The SDCI API allows applications to exactly control the type of data sent and received in both bit synchronous data and transparent bitstream formats. The SDCI API manual in Adobe PDF format provides a comprehensive set of function call definitions and helpful advice on the best way to utilise the interface. The sample applications for HDLC and bitstream operation are written in C.

Synchronous data

The SDCI API has been extended to allow applications to exactly control the type of data sent and received in both bit synchronous (HDLC framed) data and transparent bitstream formats. The SDCI SDK contains everything a user needs to rapidly develop and test applications for such requirements as supporting specialist synchronous protocols or transparent data requirements such as Audio, MPEG Video T-DMB and DAB ETI. Adapters supporting extended clocking options are supported by the API.

Asynchronous Data

To operate a port with asynchronous data under Windows, the FarSync driver supports a subset of the standard Win32 COMM API as detailed in Microsoft's MSDN Documentation. This enables applications that currently interface to standard serial ports on Windows to be easily ported to use FarSync ports in asynchronous mode. As an alternative to using the Win32 COMM interface, SDCI clients also have the option of using much of the same code to support FarSync ports in either asynchronous or synchronous modes e.g. the same data transfer IOCTLs. Asynchronous mode access is available purchasers of the FarSync cards supporting Async, for details check the individual FarSync product information.

Sample Applications

A number of easy to follow sample applications are provided demonstrating the wide variety of features available with the card. This includes a kernel mode sample for those customers who require the ultimate performance. GUI based demonstration and test utilities are supplied capable of utilizing the wide range of features supported by the card.

Further information on the SDCI API

 

Screenshot of SDCIDemo utility program supplied with the FarSync SDK that tests and demonstrates the a FarSync cards capabilities

 

Linux Raw Sockets API

The Linux API allows applications to send and receive HDLC format (bitsync) frames and also transparent bitstreams with the raw sockets based API. The sample application supplied with the Developers Toolkit demonstrates both modes of operation.

The API can supports data rates of over 10 Mbits/s per port, with all the ports individually selectable for speed, clocking direction and mode of operation (HDLC or Transparent). For the maximum speeds supported by a particular adapter check that FarSync products technical specification.

Frame sizes up to 32 Kbytes are supported in HDLC mode to allow support for a wide variety of specialist synchronous protocols. The transparent bit stream is suitable for transparent data requirements such as Audio, MPEG Video T-DMB and DAB ETI.

The API allow the full range of internal clock speeds to be selected and also selection of extended clocking options for the FarSync adapters that support them.

Asynchronous operation is not available from the Raw Sockets API.

The source for the application and drivers is included, with the Linux API manual provided in Adobe PDF format.

 

Microsoft, Windows, and the Windows logo are trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries.
All trademarks and registered trademarks are acknowledged.
Changes are periodically made to the information herein; these changes will be incorporated into new editions of the publication. FarSite Communications may make improvements and/or changes in the products and/or programs described in this publication at any time.

Last updated: 11-Sep-2008