@rf24/rf24

The node.js binding for the rf24-rs project (written in rust).

This package is only functional on Linux machines. Although, installing this package in non-Linux environments will provide the typing information used on Linux.

See the docs for more detail about the API.

Install

To install from npmjs.com:

npm install @rf24/rf24
Copy

To build from source:

yarn install
yarn build:debug
Copy

Examples

The examples are written in Typescript and located in the repository's root path "examples/node/ts". To compile them to Javascript, run the following commands:

yarn install
yarn build:examples
Copy

Afterwards the Javascript files are located "examples/node/js". To run them just pass the example file's path to the node interpreter:

node examples/node/js/gettingStarted.js
Copy