Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xingrz/node-cp2102n
Cross-platform Node.js binding for controlling GPIOs on Silicon Labs CP2102N
https://github.com/xingrz/node-cp2102n
cp2102 cp2102n cp210x silicon-labs
Last synced: about 2 months ago
JSON representation
Cross-platform Node.js binding for controlling GPIOs on Silicon Labs CP2102N
- Host: GitHub
- URL: https://github.com/xingrz/node-cp2102n
- Owner: xingrz
- License: mit
- Created: 2022-07-08T13:19:38.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-07-13T03:37:00.000Z (over 2 years ago)
- Last Synced: 2024-09-14T11:45:11.360Z (4 months ago)
- Topics: cp2102, cp2102n, cp210x, silicon-labs
- Language: C++
- Homepage:
- Size: 85 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
node-cp2102n [](https://github.com/xingrz/node-cp2102n/actions/workflows/build.yml)
==========
[![][npm-version]][npm-url] [![][npm-downloads]][npm-url] [![license][license-img]][license-url] [![issues][issues-img]][issues-url] [![stars][stars-img]][stars-url] [![commits][commits-img]][commits-url]
Cross-platform Node.js binding for controlling GPIOs on Silicon Labs CP2102N.
## Installation
```sh
npm install --save cp2102n
```
### Prebuilt addon
This package shiped with prebuilt Node.js native addon for following platforms:
| | linux | darwin | win32 |
|-------|-------|--------|-------|
| x64 | ✓ | ✓ | TODO |
| arm | ✓ | n/a | n/a |
| arm64 | ✓ | TODO | |
### Build from source
```sh
npm install --save cp2102n --build-from-source
```
Additional build dependencies are required on different platforms:
#### Debian/Ubuntu
```sh
sudo apt install -y build-essential cmake ninja-build pkg-config libusb-1.0-0-dev
```
#### macOS
```sh
brew install cmake ninja pkg-config libusb
```
### Runtime depencencies
#### Debian/Ubuntu
```sh
sudo apt install -y libusb-1.0-0
```
#### macOS
```sh
brew install libusb
```
## Usage
```ts
import { openInterface } from 'cp2102n';
try {
const device = await openInterface('/dev/cu.usbserial-1140');
await device.set({ [0]: true, [6]: true });
device.close();
} catch (e) {
console.error(e);
}
```
## APIs
### `openInterface(path)`
* `path` - `string`
* Returns: `Promise`
Open an interface with `path` (i.e. `/dev/cu.usbserialXXX` on macOS, `/dev/ttyUSBX` on Linux). Throws if `path` is not a valid CP2102N device.
### Class: `CP2102N`
#### `cp2102n.set(state)`
* `state` - `{ [pin: number]: boolean }`
* Returns: `Promise<{ [pin: number]: boolean }>`
Set state of pins to high (`true`) or low (`false`). Returns the latest state.
#### `cp2102n.get()`
* Returns: `Promise<{ [pin: number]: boolean }>`
Get state of all PINs.
#### `cp2102n.setRaw(state, mask)`
* `state` - `number`
* `mask` - `number`
* Returns: `Promise`
Set state of masked pins in bits. Returns the latest state bits.
#### `cp2102n.getRaw()`
* Returns: `Promise`
Get state of pins in bits.
#### `cp2102n.close()`
Close interface.
## License
[MIT License](LICENSE)
[npm-version]: https://img.shields.io/npm/v/cp2102n.svg?style=flat-square
[npm-downloads]: https://img.shields.io/npm/dm/cp2102n.svg?style=flat-square
[npm-url]: https://www.npmjs.org/package/cp2102n
[license-img]: https://img.shields.io/github/license/xingrz/node-cp2102n?style=flat-square
[license-url]: LICENSE
[issues-img]: https://img.shields.io/github/issues/xingrz/node-cp2102n?style=flat-square
[issues-url]: https://github.com/xingrz/node-cp2102n/issues
[stars-img]: https://img.shields.io/github/stars/xingrz/node-cp2102n?style=flat-square
[stars-url]: https://github.com/xingrz/node-cp2102n/stargazers
[commits-img]: https://img.shields.io/github/last-commit/xingrz/node-cp2102n?style=flat-square
[commits-url]: https://github.com/xingrz/node-cp2102n/commits/master