FarSync SDK - The Developers Toolkit for FarSync adapter products

FarSync products

The FarSync SDK Developers Toolkit provides everything the developer requires to use the APIs on the full range of FarSync adapters

The Developers Toolkit

The SDK includes support for writing applications for the FarSync range of products on both Linux and Windows. It contains documentation, working sample applications, user libraries and test utility applications. There is everything a user needs to rapidly develop and test a wide variety of applications using synchronous (HDLC framed) protocols, asynchronous data or transparent bitstream including Audio, MPEG Video T-DMB, DAB STI and DAB ETI with the bitstream encoder and decoders provided.

The FarSync SDK supports APIs on the following products
Products supported by the SDK Product Code Windows API Linux API
FarSync T1U FS4140 yes yes
FarSync T2U FS4240 yes yes
FarSync T4U FS4440 yes yes
FarSync T4U+Async FS4441 yes yes
FarSync T4E FS4444 yes yes
FarSync T4E+ FS4446 yes yes
FarSync TE1 FS4150 yes yes
FarSync TE1R FS4151 yes yes
FarSync T2Ue FS4250 yes yes
FarSync T4Ue FS4450 yes yes
FarSync T4Ue+Async FS4451 yes yes
FarSync Flex FS4100 yes yes
FarSync M1P v2 FS4133 yes no

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 specialist X.25 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 and E1 operation

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 to over 10Mbits/s. 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. Through the SDCI API an application can be rapidly developed for such requirements as supporting specialist synchronous protocols or transparent data requirements including Audio, MPEG Video T-DMB, DAB STI and DAB ETI.

Adapters with extended clocking features such as the FarSync T4E and FarSync T4E+ are supported by the API.

Asynchronous Operation

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. Dynamic switching between Async and Sync operation is supported.

Asynchronous operation is available for the FarSync T4U+Async, T4E, T4E+, T4Ue+Async and Flex.

Sample Applications

A number of easy to follow sample applications are provided demonstrating the wide variety of features available with the adapters. 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 adapters.

Even more information and application screenshots on the SDCI API

Linux Raw Sockets API

The Linux API allows applications to send and receive HDLC format (bitsync) frames and also transparent bitstreams using the Raw Sockets based API.

Sample applications supplied with the Developers Toolkit demonstrate both modes of operation. The source for the applications and drivers are included, with the Linux API manuals provided in Adobe PDF format. A monitor program is included in the Linux support that allows data sent and received by the application to be recorded in hex format.

Synchronous and E1 Operation

The API can supports data rates to 10 Mbits/s per port, with all the ports individually selectable for speed, clocking direction and mode of operation. For the maximum speeds supported by a particular adapter check the FarSync products particular 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 mode is suitable for transparent data requirements such as Audio, MPEG Video T-DMB, DAB STI and DAB ETI. See also the General Bitstream encoding and decoding library which can help shortcut the development time needed for these types of applications

The API allow the full range of internal clock speeds to be selected and also selection of extended clocking options supported by FarSync adapters such as the FarSync T4E and FarSync T4E+.

LAPB Operation

An API to the LAPB protocol is available though the RAW sockets interface, all the ports on the adapter can be addressed by this method.

Asynchronous Operation

Asynchronous operation is available from the standard TTY interface for the FarSync T4U+Async, T4E, T4E+, T4Ue+Async and Flex. Dynamic switching between Async and Sync operation is supported.

General Purpose Bitstream Encoding and Decoding Library

A library is provided that allows low level encoding and decoding of the transparent bitstream for speedy application development or your Windows or Linux application. The library can be configured to identify and extract most fixed-length byte-oriented user frames; where frames can be defined in terms of single or alternate synchronizing patterns, frame length and number of sync patterns to acquire sync. It provides for example provide low level frame handling for E1, DAB-ETI or DAB-STI.

Windows and Linux sample send and receive programs demonstrating common modes of operation are supplied with sample data files.

DAB modes supported:

ETI
ETI(NI, G.703) - on the FarSync TE1 and FarSync TE1R
ETI(NI, V.11) - on the FarSync T1U, FarSync T2U, FarSync T2Ue, FarSync T4U, FarSync T4Ue, FarSync T4E, FarSync T4E+ and FarSync Flex.

STI
STI(PI, G.703) - on the FarSync TE1 and FarSync TE1R
STI(PI, V.11) - on the FarSync T1U, FarSync T2U, FarSync T2Ue, FarSync T4U, FarSync T4Ue, FarSync T4E, FarSync T4E+ and FarSync Flex.

For Windows the library is available in 32 bit form for 32 bit based applications.

For Linux the library is available in 32 and 64 bit form.

FarSync SDK - Developers Toolkit, what's included
Reference manuals Windows SDCI user manual,
Linux Raw Sockets user manuals,
LAPB API,
RS485 application guidelines (for the FarSync Flex)
Bitstream encoder/decoder user manual
Sample programs Sample applications supplied that use the SDCI API, Raw Sockets APIs and the bitstream encoder/decoder. There are also adapter performance check and adapter function test applications
Source code Sample C applications and Linux drivers source code supplied
Bitstream encoding and decoding Library and sample programs supporting decoding of bitstream data, can be configured to support many different fixed length bitstreams such as ETI, STI and E1 framing.
Customer Support We provide free email and telephone assistance to the application developer using the API as part of the package provided when the FarSync SDK is purchased.
Order Information

Product Name

Description

Product Code

FarSync SDK Linux and Windows Developers Toolkit for the FarSync adapters - this is required if you want to write software to use the FarSync adapter APIs.
Note: This toolkit is not appropriate for the FarSync X25 range of products or the FarLinX Gateways, they are supplied with their own toolkit. 		FS9610

19-Feb-2010