ReadMe seems to be out of date

ludiazv / node-nrf24

nRF24 (nrf24l01/nrfl24l01+) radios in the nodejs way

MIT License

39 stars 15 forks source link

ReadMe seems to be out of date #1

Closed tobiasmuecksch closed 6 years ago

tobiasmuecksch commented 6 years ago

Hi @ludiazv ,

thanks for this awesome library. I'm currently trying to use it, but the ReadMe seems to be out of date.

For example:

Instead of var nrf24 = require("nRF24"); you have to const nrf24 = require("nrf24");.
var rf24 = nrf24.RF24(22, 0); does not work, you have to instantiate it instead: var rf24 = new nrf24.nRF24(22, 0);
You have to enable SPI

If pull requests are welcome, I will create one - in case I find out on my own how to run this library.

ludiazv commented 6 years ago

Thanks. That's True. To create the radio object 'new' keyword is mandatory. In fact the library raises an exception informing about that.

The documentation need improvement and correction. I need to review it as I have also spotted some errors on it. That need correction but yet haven't found time to do it.

I'm waiting for an update in the C++ library to update the library. In principle it should support:

Review of documentation: Still not complete and with errors as you have identify.
Document RF24Mesh & additional testing.
First Implementation of RF24Gateway directly on nodejs.
Better exception management.
IRQ line support to improve thro

PRs and Testing feedback are welcome as this node package is very new. What board ,OS, nodejs version are you using?

Regards,

tobiasmuecksch commented 6 years ago

@ludiazv Sorry for the late reply... I'm using a raspberry pi 3B and a raspberry pi zero. Both on the latest raspbian (Releasedate 2018-03-13)

ludiazv commented 6 years ago

I updated some days modifications on the documentacion and improved some points of the code. It should be working on your setup. As I have tested in a Zero W without problems. Are you still having problems?

Regards,

tobiasmuecksch commented 6 years ago

I got it working perfectly (alpha3). I just wanted to let you know, that the information in the readme isn't correct at some spots. But still, this is an amazing library. Thank you very much for that - you saved me hours.

Next week I will have some spare time, and will evaluate where I can help with some improvements.