# gpio-in-domapic > Handler to be used by Domapic modules for controlling a gpio in "in" mode Latest version **1.1.0** (published 2019-03-05) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install gpio-in-domapic pnpm add gpio-in-domapic yarn add gpio-in-domapic bun add gpio-in-domapic ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2019-03-05 | | First published | 2018-12-15 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 12.5 KB | | Known vulnerabilities | 0 (+7 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | Javier Brea | | Maintainers | javierbrea | | Keywords | domapic, raspberry, gpio, iot, domotic | ## Links - npm: https://www.npmjs.com/package/gpio-in-domapic - Repository: https://github.com/javierbrea/gpio-in-domapic - Homepage: https://github.com/javierbrea/gpio-in-domapic#readme - Issues: https://github.com/javierbrea/gpio-in-domapic/issues - npm.io page: https://npm.io/package/gpio-in-domapic ## Dependencies (3) - [death](https://npm.io/package/death.md) 1.1.0 - [onoff](https://npm.io/package/onoff.md) 3.2.2 - [lodash](https://npm.io/package/lodash.md) 4.17.11 ## Recent versions - 1.1.0 (latest) — 2019-03-05 - 1.0.0 — 2018-12-15 ## README # Gpio In Domapic > Handler to be used internally by Domapic Modules for controlling a gpio in \"in\" mode [![Build status][travisci-image]][travisci-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Quality Gate][quality-gate-image]][quality-gate-url] [![js-standard-style][standard-image]][standard-url] [![NPM dependencies][npm-dependencies-image]][npm-dependencies-url] [![Last commit][last-commit-image]][last-commit-url] [![Last release][release-image]][release-url] [![NPM downloads][npm-downloads-image]][npm-downloads-url] [![License][license-image]][license-url] --- ## Intro This package provides a Domapic handler for controlling a gpio in "in" mode using the [onoff][onoff-url] library internally. Passing to it a Domapic module instance, it will retrieve the module instance configuration defined when started the service, and will configure the gpio based on it. Just define which are your module "options keys" for configuring the gpio, and the handler will automatically load the configuration. Or you can also set the options with fixed values programatically. ## Installation ```bash npm i gpio-in-domapic -save ``` ## Usage #### `new Gpio(domapicModule, [options[, configurationKeys]])` * `options` `` Object containing default values for options. Will apply these values if no configuration keys are provided. * `debounceTimeout` `` Defines the debounce time for emitting gpio events. * `configurationKeys` `` Object defining configuration keys from which the options will be loaded. * `gpio` `` Key defining the configuration property in which the gpio number is defined. Default is `gpio`. * `debounceTimeout` `` Key defining the configuration property in which the `debounceTimeout` option for the gpio is defined. ##### Instance * `gpio.init()` `async method`. Initializes the gpio retrieving configuration, etc. * `gpio.status` `getter`. Returns the current gpio status. * `gpio.events` `getter`. Returns gpio eventEmitter object. Read the events chapter for further info. ##### Statics * `eventNames` `` Object containing gpio event names. #### Events Gpio instances emit events through an `eventEmitter` object exposed in the `events` getter. Event names are exposed in the Gpio static object `eventNames`. Available events are: * `Gpio.eventNames.ON`. Emitted when gpio status change to `true` * `Gpio.eventNames.OFF`. Emitted when gpio status change to `false` * `Gpio.eventNames.CHANGE`. Emitted whenever the gpio status changes. It sends the new status as first argument to subscribed listeners. * `Gpio.eventNames.ERROR`. Emitted whenever the gpio throws an error. It sends the error as first argument to subscribed listeners. ## Example In the next example, the `gpio-in-domapic` package is used to create a [Domapic Module][domapic-service-url] having an state for returning a door status, and emitting an event when the door status changes. It also allow users to decide the debounce time when starting the module. ```js const path = require('path') const domapic = require('domapic-service') const gpioIn = require('gpio-in-domapic') domapic.createModule({ packagePath: path.resolve(__dirname), customConfig: { gpio: { type: 'number', describe: 'Set gpio number for the door sensor' }, debounce: { type: 'number', describe: 'Set debounce timeout for the door sensor', default: 1000 } } }).then(async dmpcModule => { const doorSensor = new gpioIn.Gpio(dmpcModule, { }, { debounceTimeout: 'debounce' }) await dmpcModule.register({ door: { description: 'Door status', data: { type: 'boolean' }, state: { description: 'Returns current door status', handler: () => doorSensor.status }, event: { description: 'Door status has changed' } } }) await doorSensor.init() doorSensor.events.on(gpioIn.Gpio.eventNames.CHANGE, newValue => { dmpcModule.tracer.debug('Door status has changed', newValue) dmpcModule.events.emit('door', newValue) }) return dmpcModule.start() }) ``` Now, the module can be started using the `debounce` option, which Gpio will use as `debounceTimeout`: ```bash node server.js --gpio=18 --debounce=1500 ``` [coveralls-image]: https://coveralls.io/repos/github/javierbrea/gpio-in-domapic/badge.svg?branch=master [coveralls-url]: https://coveralls.io/github/javierbrea/gpio-in-domapic [travisci-image]: https://travis-ci.com/javierbrea/gpio-in-domapic.svg?branch=master [travisci-url]: https://travis-ci.com/javierbrea/gpio-in-domapic [last-commit-image]: https://img.shields.io/github/last-commit/javierbrea/gpio-in-domapic.svg [last-commit-url]: https://github.com/javierbrea/gpio-in-domapic/commits [license-image]: https://img.shields.io/npm/l/gpio-in-domapic.svg [license-url]: https://github.com/javierbrea/gpio-in-domapic/blob/master/LICENSE [npm-downloads-image]: https://img.shields.io/npm/dm/gpio-in-domapic.svg [npm-downloads-url]: https://www.npmjs.com/package/gpio-in-domapic [npm-dependencies-image]: https://img.shields.io/david/javierbrea/gpio-in-domapic.svg [npm-dependencies-url]: https://david-dm.org/javierbrea/gpio-in-domapic [quality-gate-image]: https://sonarcloud.io/api/project_badges/measure?project=gpio-in-domapic&metric=alert_status [quality-gate-url]: https://sonarcloud.io/dashboard?id=gpio-in-domapic [release-image]: https://img.shields.io/github/release-date/javierbrea/gpio-in-domapic.svg [release-url]: https://github.com/javierbrea/gpio-in-domapic/releases [standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg [standard-url]: http://standardjs.com/ [onoff-url]: https://www.npmjs.com/package/onoff [domapic-service-url]: https://www.npmjs.com/package/domapic-service --- _Source: https://npm.io/package/gpio-in-domapic · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._