https://github.com/drom/node-iio
libiio bindings for Node.js
https://github.com/drom/node-iio
Last synced: 11 days ago
JSON representation
libiio bindings for Node.js
- Host: GitHub
- URL: https://github.com/drom/node-iio
- Owner: drom
- License: mit
- Created: 2018-05-26T02:06:06.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-03T14:04:10.000Z (almost 6 years ago)
- Last Synced: 2025-03-31T20:38:13.917Z (about 2 months ago)
- Language: C
- Size: 59.6 KB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/drom/node-iio)
[](https://badge.fury.io/js/libiio)
Linux Industrial Input/Output ([IIO](https://wiki.analog.com/software/linux/docs/iio/iio)) Subsystem library ([libiio](https://wiki.analog.com/resources/tools-software/linux-software/libiio)) bindings for Node.js
### Dependencies
This module depends on [libiio package](https://github.com/analogdevicesinc/libiio) being installed on your system.
### Install
`npm i libiio`
### Usage
```js
const iio = require('libiio');
for(let i = 0; i < iio.get_backends_count(); i++) {
console.log(iio.get_backend(i));
}
```
### API
Most of API calls are directly mapped to [libiio API](http://analogdevicesinc.github.io/libiio/) without `iio_` prefix.
| name | description |
|:-----------------------------------|:---------------------------------------------------------------|
| library_get_version | Get the version of the libiio library |
| get_backends_count | Get the number of available backends |
| get_backend | Retrieve the name of a given backend |
| create_scan_context | Create a scan context |
| scan_context_get_info_list | Enumerate available contexts |
| create_context_from_uri | Create a context from a URI description |
| context_info_get_uri | Get a uri of a discovered context **+ index** |
| context_info_get_description | Get a description of a discovered context **+ index** |
| context_get_devices_count | Enumerate the devices found in the given context |
| context_get_device | Get the device present at the given index |
| | |
| device_get_id | Retrieve the device ID (e.g. iio:device0) |
| device_get_name | Retrieve the device name (e.g. xadc) |
| device_get_attrs_count | Enumerate the device-specific attributes of the given device |
| device_get_attr | Get the device-specific attribute present at the given index |
| device_attr_read | Read the content of the given device-specific attribute |
| device_get_channels_count | Enumerate the channels of the given device |
| device_get_channel | Get the channel present at the given index |
| | |
| channel_is_output | Return True if the given channel is an output channel |
| channel_get_id | Retrieve the channel ID (e.g. voltage0) |
| channel_get_name | Retrieve the channel name (e.g. vccint) |
| channel_is_enabled | Returns True if the channel is enabled |
| channel_get_type | Get the type of the given channel |
| channel_disable | Disable the given channel |
| channel_enable | Enable the given channel |
| channel_get_attrs_count | Enumerate the channel-specific attributes of the given channel |
| channel_get_attr | Get the channel-specific attribute present at the given index |
| channel_attr_read | Read the content of the given channel-specific attribute |
| | |
| channel_attr_write_raw | Set the value of the given channel-specific attribute |
| channel_attr_write | Set the value of the given channel-specific attribute |
### License
[MIT](LICENSE)