https://github.com/thomaschaaf/node-ftdi
FTDI bindings for Node.js
https://github.com/thomaschaaf/node-ftdi
Last synced: about 1 year ago
JSON representation
FTDI bindings for Node.js
- Host: GitHub
- URL: https://github.com/thomaschaaf/node-ftdi
- Owner: thomaschaaf
- License: mit
- Created: 2013-11-21T13:55:57.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T05:33:52.000Z (over 2 years ago)
- Last Synced: 2025-04-12T15:15:58.700Z (about 1 year ago)
- Language: C++
- Size: 636 KB
- Stars: 46
- Watchers: 7
- Forks: 39
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
eeeee eeeee eeeee eeee e eeeee
8 8 8 88 8 8 8 8 8 "
8e 8 8 8 8e 8 8eee 8e 8eeee
88 8 8 8 88 8 88 e 88 88
88 8 8eee8 88ee8 88ee 88 8ee88 8ee88
eeee eeeee eeeee e
8 8 8 8 8
8eee 8e 8e 8 8e
88 88 88 8 88
88 88 88ee8 88
[](https://npmjs.org/package/ftdi)
# Prerequisites:
**Make sure you installed the ftdi driver: [ftdi](http://www.ftdichip.com/Drivers/D2XX.htm)**
If you're are using a Linux distribution or Mac OS X you can run the **install.sh** script file to install the ftdi driver...
For Windows the libs are shipped with this module.
# Installation
npm install ftdi
This assumes you have everything on your system necessary to compile ANY native module for Node.js. This may not be the case, though, so please ensure the following are true for your system before filing an issue about "Does not install". For all operatings systems, please ensure you have Python 2.x installed AND not 3.0, [node-gyp](https://github.com/TooTallNate/node-gyp) (what we use to compile) requires Python 2.x.
### Windows:
Ensure you have Visual Studio 2010 installed. If you have any version OTHER THAN VS 2010, please read this: https://github.com/TooTallNate/node-gyp/issues/44
### Mac OS X:
Ensure that you have at a minimum the xCode Command Line Tools installed appropriate for your system configuration. If you recently upgrade OS, it probably removed your installation of Command Line Tools, please verify before submitting a ticket.
Verify that it is installed by running ```xcode-select --install```
### Linux:
You know what you need for you system, basically your appropriate analog of build-essential. Keep rocking!
If you the vendorId and productId are both zero you have to unload the driver before using your node app like this:
```
rmmod ftdi_sio
rmmod usbserial
```
# Usage
## Listing or finding devices
```nodejs
var ftdi = require('ftdi');
ftdi.find(0x27f4, 0x0203, function(err, devices) {}); // returns all ftdi devices with
// matching vendor and product id
```
## Create an FtdiDevice
```nodejs
var ftdi = require('ftdi');
var device = new ftdi.FtdiDevice({
locationId: 0,
serialNumber: 0
});
// or
var device = new ftdi.FtdiDevice(0); // index in list function
```
## All together
```nodejs
var ftdi = require('ftdi');
ftdi.find(0x27f4, 0x0203, function(err, devices) {
var device = new ftdi.FtdiDevice(devices[0]);
device.on('error', function(err) {
});
device.open({
baudrate: 115200,
databits: 8,
stopbits: 1,
parity: 'none',
flowcontrol: 'none', // can be 'none', 'rts_cts', 'dtr_dsr', 'xon_xoff'
// bitmode: 'cbus', // for bit bang
// bitmask: 0xff // for bit bang
},
function(err) {
device.on('data', function(data) {
});
device.write([0x01, 0x02, 0x03, 0x04, 0x05], function(err) {
});
});
});
```
### Bit Bang infos
bitmask: Is always a number (one byte).
bitmode: Can be directly a number (one byte) like 0x20 or a string like 'cbus'.
mapping:
```nodejs
var bitmodes = {
'reset' : 0x00,
'async' : 0x01,
'mpsse' : 0x02,
'sync' : 0x04,
'mcu' : 0x0B,
'fast' : 0x10,
'cbus' : 0x20,
'single': 0x40
};
/**
* 0x00 = Reset
* 0x01 = Asynchronous Bit Bang
* 0x02 = MPSSE (FT2232, FT2232H, FT4232H and FT232H devices only)
* 0x04 = Synchronous Bit Bang (FT232R, FT245R, FT2232, FT2232H, FT4232H and FT232H devices only)
* 0x08 = MCU Host Bus Emulation Mode (FT2232, FT2232H, FT4232H and FT232H devices only)
* 0x10 = Fast Opto-Isolated Serial Mode (FT2232, FT2232H, FT4232H and FT232H devices only)
* 0x20 = CBUS Bit Bang Mode (FT232R and FT232H devices only)
* 0x40 = Single Channel Synchronous 245 FIFO Mode (FT2232H and FT232H devices only)
*/
```
# Troubleshoot
### Windows
### Mac OS X
Error message:
Can't open ftdi device: FT_DEVICE_NOT_OPENED
Try to unload the Apple FTDI Driver by running the following command:
```sudo kextunload -b com.apple.driver.AppleUSBFTDI```
### Linux
# Release Notes
## v1.2.2
- Fix wrong time.h header
## v1.2.0
- Add support for node v4, v5
## v1.1.0
- added bit bang support
## v1.0.3
- revert "ready for node >= 0.11.4"
## v1.0.2
- fix allocation/deallocation mismatch
## v1.0.1
- ready for node >= 0.11.4
## v1.0.0
- first release
# License
Copyright (c) 2014 Kaba AG
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.