Light

deepsyx / pigpio-mock Goto Github PK

View Code? Open in Web Editor NEW

20.0 4.0 9.0 62 KB

Package used for locally developing node apps with pigpio.

JavaScript 100.00%

raspberry-pi nodejs hardware

pigpio-mock's Introduction

Pigpio-mock

Article: https://viktorkirilov.me/post/mocking-raspberry-gpios/

A mock library used for raspberry pi development on your local machine. It copies all method from https://github.com/fivdi/pigpio and logs information to the console, instead of controlling the Raspberry's GPIO pins.

Example

You can also check examples folder.

const Gpio = require("pigpio-mock").Gpio;
const led = new Gpio(13, { mode: Gpio.OUTPUT });
let dutyCycle = 0;

setInterval(function() {
	led.pwmWrite(dutyCycle);

	dutyCycle += 50;
	if (dutyCycle > 255) {
		dutyCycle = 0;
	}
}, 500);

should output:

[GPIO 13 / constructor] Initializing...
[GPIO 13 / constructor] Setting mode = 1
[GPIO 13 / pwmWrite-analogWrite] Setting dutyCycle = 0
[GPIO 13 / pwmWrite-analogWrite] Setting dutyCycle = 50
[GPIO 13 / pwmWrite-analogWrite] Setting dutyCycle = 100
[GPIO 13 / pwmWrite-analogWrite] Setting dutyCycle = 150
[GPIO 13 / pwmWrite-analogWrite] Setting dutyCycle = 200
[GPIO 13 / pwmWrite-analogWrite] Setting dutyCycle = 250

Installation

It is as simple as:

yarn add pigpio-mock

and you can use it in your code as:

const pigpio = process.env.NODE_ENV !== "production" ? 
    require("pigpio-mock") : 
    require("pigpio");

Implemented classes:

Gpio
GpioBank
Notifier

Contribution

All kind of contribution will be greatly appreciated.

Pull requests

We're using https://github.com/enhancv/prettier for automatic code formating
Please provide tests. We're aiming for 100% code coverage

Running tests

yarn test

pigpio-mock's People

Contributors

Stargazers

Watchers

Forkers

rafaelquines vector-kerr baskeboler edob bahamut657 grebneerg cinderblock coollision slash28cu

pigpio-mock's Issues

initialize and terminate methods

Hello.

Congratulations by mock.

Can you implements initialize and terminate methods, for I can use your lib?

Or need I make a fork and implements it?

Pigpio.initialize() and Pigpio.terminate();

Thanks

Update on npm

would it be possible to update the version of pigpio-mock on npm?

pwmRange is not a function

It looks like the mock Gpio object uses a variable called "pwmRange" as well as a function called "pwmRange".

When the constructor is executed, the pwmRange variable replaces the pwmRange function of the Gpio object.

Sample code to demonstrate:

const Gpio = require( "pigpio-mock" ).Gpio;

PWM_FREQ = 50;
PWM_RANGE = 1000;

VAL_MIN = 10;
VAL_MAX = 100;

// Output the pwmRange value of the Gpio object prototype
// This should be (and is) the pwmRange function
console.log( "Gpio prototype pwmRange is:", Gpio.prototype.pwmRange );

// Create a Gpio (mock) object
const servo = new Gpio( 17, { mode: Gpio.OUTPUT } );

// Output the pwmRange value of a Gpio instance
// This *should* be a function, but it is actually the current pwmRange value (default=0)
console.log( "Gpio instance pwmRange is:", servo.pwmRange );

// Set PWM freq
servo.pwmFrequency( PWM_FREQ );

// This will fail because it is a function call on an integer value, rather than on the
// desired pwmRange function
servo.pwmRange( PWM_RANGE );

// Write some PWM values
servo.pwmWrite( VAL_MIN );
servo.pwmWrite( VAL_MAX );

A fix would probably be to change the internal pwmRange variable to include a prefix such as an underscore (e.g., _pwmrange) to separate it from the function with the same name.

extend eventemitter

For me to use mock and to be compatible with pigpio which "inherts" event emitter and thus for use when mocking interrupts (which I am doing) your Gpio class should extend eventemitter. A simple change.

class Gpio extends EventEmitter {
  constructor(pin, options) {
    super()

pr to follow

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.