Skip to content
This repository

Open source drivers for the Novint Falcon haptic controller

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.txt
===========
libnifalcon 
===========

by Kyle Machulis <kyle@nonpolynomial.com>
Nonpolynomial Labs - http://www.nonpolynomial.com

Kinematics by Kevin Ouellet
http://sourceforge.net/users/kouellet/

NOTE: This file needs to be updated somemore, but I just want to get the beta done. :)

===========
Description
===========

libnifalcon is a development library for the NovInt Falcon, and is an open source, crossplatform alternative to NovInt's SDK. 

libnifalcon provides basic functionality to connect to the falcon and load firmware to the internal microcontroller. In addition, it comes with sample functionality made available through the firmware available in NovInt's drivers (the novint.bin file in TestUtilties and the nifalcon_test_fw files for the library source). This firmware is distributed in the firmware directory of the source distribution, and is required for the findfalcons utility to run.

Compilation directions are included in the INSTALL.txt file

=========================
NovInt Falcon Information
=========================

More information about the NovInt Falcon can be found at 

http://home.novint.com

Technical information, including protocol and hardware information, is available at

http://wiki.libnifalcon.sourceforge.net

====================
Library Requirements
====================

-----
cmake
-----
http://www.cmake.org

------
ftd2xx
------
http://www.ftdichip.com/Drivers/D2XX.htm

AND/OR

-------
libftdi
-------

http://www.intra2net.com/de/produkte/opensource/ftdi/

-----------------------------------------
GMTL (optional, for kinematics libraries)
-----------------------------------------

http://ggt.sourceforge.net/

----------------------------------------------
Boost (optional, for examples and utilities)
---------------------------------------------=

http://www.boost.org/




=====================
ftd2xx versus libftdi
=====================

libnifalcon can use one of two libraries to access the falcon: ftd2xx, distributed by the FTDI company, or libftdi, an open source version of the FTDI drivers. 

FTD2XX:
Windows: Fine
Linux: Fine
64-bit Linux: No 64-bit drivers available
OS X: Okish?

libftdi:
Windows: Untested (Recommended to use FTD2XX)
Linux: Fine
64-bit Linux: Fine
OS X: Fine

So, basically, ftd2xx is stable on windows and linux, iffy on OS X. libftdi is somewhat slower, but works everywhere. This is being worked on right now, see the following blog post for more details:

http://www.nonpolynomial.com/archives/2008/04/libusb-libftdi-latency-and-my-own-stupid.php

==================
Platform Specifics
==================

-------
Windows
-------

- NovInt uses the stock ftd2xx drivers, and it is recommended to use a ftd2xx version of libnifalcon on windows. If you have installed the drivers from NovInt's website, access through libnifalcon should "just work".
- libftdi drivers will require a libusb filter driver install. This is not recommended for programs that will be distributed publically, as it will require an uninstall of the usual FTDI drivers.

-----
Linux
-----

- Either ftd2xx or libftdi can be used on linux.
- 64-BIT USERS: There are no versions of ftd2xx drivers for 64-bit linux. libftdi has been tested and found to work fine with libnifalcon on 64-bit platforms.
- IF USING FTD2XX, make sure to read the instructions that come with it on setting up the proc system properly.
- Some installations of libftdi using debian apt-get seem to be a little unstable with libnifalcon (this has mainly been found on 64-bit machines). If you have installed libftdi from a prepackaged install and have stability issues accessing the falcon, it is recommended that you try compiling libftdi yourself.
- Programs built with libnifalcon (including example programs that come with the library) requires either root access (i.e. running under sudo) or correct udev based USB permissions to run as non-root.

---
OSX
---

- As of ftd2xx 0.1.4 for OS X, ftd2xx seems to have gotten decent stability on OS X. Kyle still uses libftdi.
Something went wrong with that request. Please try again.