# node-atgpio

> Advantech IIoT GPIO module

Latest version **3.0.1** (published 2023-08-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install node-atgpio
pnpm add node-atgpio
yarn add node-atgpio
bun add node-atgpio
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2023-08-17 |
| First published | 2017-10-23 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 327.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Zhirong.Hsu |
| Maintainers | advantech-iiot |
| Keywords | GPIO, Advantech, IIoT |

## Links

- npm: https://www.npmjs.com/package/node-atgpio
- Repository: https://github.com/Advantech-IIoT/node-atgpio
- Homepage: https://github.com/Advantech-IIoT/node-atgpio#readme
- Issues: https://github.com/Advantech-IIoT/node-atgpio/issues
- npm.io page: https://npm.io/package/node-atgpio

## Dependencies (1)

- [node-addon-api](https://npm.io/package/node-addon-api.md) ^5.0.0

## Recent versions

- 3.0.1 (latest) — 2023-08-17
- 1.0.0 — 2019-11-07
- 0.2.4 — 2018-02-09
- 0.2.3 — 2018-02-08
- 0.2.2 — 2017-10-23

## README

# node-atgpio
Node.js Integration for Advantech IIoT GPIO function.

Notice that an Advantech IIoT Platform SDK have to be installed to make this node works correctly.
Advantech IIoT Platform SDK download link is shown below:

Windows:
  https://github.com/Advantech-IIoT/Platform-SDK/tree/master/windows/bin

Linux:
  https://github.com/Advantech-IIoT/Platform-SDK/tree/master/linux/bin

## Installation
``` bash
$ npm install node-atgpio
```
## Usage
GPIO provide following functions in this module.
  - Get GPIO Count (the number of GPIO pins in the device.)
  - Read/Write GPIO Value. HIGH(1), LOW(0)
  - Read/Write GPIO Pin Tye INPUT(1), OUTPUT(0)

## Example
Please refer to [`demo.js`](./demo.js).

## Quickstart
All these examples use the virtual numbering (0~n) and assume that the
example is started with:

```js
var gpio = require('node-atgpio');
```

### Get GPIO count
Get the number of GPIO pins in the device.

```js
var count = gpio.count();
console.log('There are ' + count + 'GPIO(s)');
```


### Read a pin
Setup pin 0 for read-only input and print its current value:

```js
gpio.setup(0, gpio.INPUT);
console.log('Pin 0 is currently set ' + (gpio.read(0) ? 'high' : 'low'));
```

### Write a pin
Setup pin 4 for output and set its value to 0 (low):

```js
gpio.setup(4, gpio.OUTPUT, gpio.LOW);
```

or

```js
gpio.setup(4, gpio.OUTPUT);
gpio.write(4, gpio.LOW);
```

### Get a pin type
Check the pin 0 is an input or output.

```js
console.log('Pin 0 is an' + (gpio.getmode(0) ? 'Input' : 'Output'));
```

## Tested Platform
- Windows 10 Enterprise LTSC with node.js 18.14.1

## History
- 3.0.1 - June 2023 : update for NODE_MODULE_VERSION=108 (C++ addons use Node-API)
- 1.0.0 - November 2019 : update for NODE_MODULE_VERSION=64 (C++ addons use Native Abstractions for Node.js)
- 0.2.2 - October 2017 : Initial Release

## License
Copyright 2023 ADVANTECH Corp. under [the Apache 2.0 license](LICENSE).

---
_Source: https://npm.io/package/node-atgpio · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._