Skip to content

Update docs on RPi5 compatibility #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
momenso merged 1 commit into from
Feb 16, 2025
Merged

Update docs on RPi5 compatibility #144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,24 @@ A simple node.js module for reading temperature and relative humidity using a co
$ npm install node-dht-sensor
```

For use with the Raspberry Pi 5, creating dependency on libgpiod, installation is as follows:
### Installing on Raspberry Pi 5 (libgpiod requirement)

```shell session
$ npm install node-dht-sensor --use_libgpiod=true
When running node-dht-sensor on a Raspberry Pi 5 (or newer), you must install libgpiod (and its development headers) before you build. If you try to install the module with --use_libgpiod=true without having libgpiod-dev installed, the build will fail.

For Raspberry Pi OS (Debian-based), use:

```sh
sudo apt-get update
sudo apt-get install -y libgpiod-dev
```

After installing libgpiod-dev, build node-dht-sensor with:

```sh
npm install node-dht-sensor --use_libgpiod=true
```

The above accounts for the architectural changes in the Raspberry Pi 5 which are incompatible with the BCM2835 library.
> Note: Specifying --use_libgpiod=true compiles and links against libgpiod for GPIO access, because the BCM2835 library does not work on Raspberry Pi 5’s architecture. If you omit --use_libgpiod=true, node-dht-sensor defaults to using BCM2835, which is compatible with older Raspberry Pi models.

## Usage

Expand Down Expand Up @@ -208,7 +219,7 @@ Standard node-gyp commands are used to build the module. So, just make sure you

### Tracing and Debugging

Verbose output from the module can be enabled by by specifying the `--dht_verbose=true` flag when installing the node via npm.
Verbose output from the module can be enabled by specifying the `--dht_verbose=true` flag when installing the node via npm.

```shell session
$ npm install node-dht-sensor --dht_verbose=true
Expand All @@ -222,7 +233,7 @@ $ node-gyp configure -- -Ddht_verbose=true

### Appendix A: Quick Node.js installation guide

There are many ways you can get Node.js installed on your Raspberry Pi. Here is just one of way you can do it.
There are many ways you can get Node.js installed on your Raspberry Pi. Here is just one way you can do it.

```shell session
$ wget https://nodejs.org/dist/v14.15.4/node-v14.15.4-linux-armv7l.tar.xz
Expand Down