https://github.com/samjrdn/pirev-node

Raspberry Pi hardware revision utility for node.js
https://github.com/samjrdn/pirev-node

detect javascript nodejs pi raspberry raspberry-pi raspberrypi revision rpi version

Last synced: about 2 months ago
JSON representation

Raspberry Pi hardware revision utility for node.js

• Host: GitHub
• URL: https://github.com/samjrdn/pirev-node
• Owner: samjrdn
• License: mit
• Created: 2018-09-13T03:06:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-12T02:32:36.000Z (over 3 years ago)
• Last Synced: 2023-11-20T16:23:43.732Z (over 1 year ago)
• Topics: detect, javascript, nodejs, pi, raspberry, raspberry-pi, raspberrypi, revision, rpi, version
• Language: JavaScript
• Size: 302 KB
• Stars: 1
• Watchers: 0
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pirev

[![npm version](https://img.shields.io/npm/v/pirev.svg?style=flat)](https://yarnpkg.com/en/package/pirev)

[![license](https://img.shields.io/npm/l/pirev.svg?style=flat)](https://opensource.org/licenses/MIT)

A tiny, zero-dependency utility providing hardware revision information for Raspberry Pi devices. All information is parsed from the device's [revision code](https://www.raspberrypi.org/documentation/hardware/raspberrypi/revision-codes/README.md) located in `/proc/cpuinfo`.

## Installation

```

yarn add pirev

```

or

```

npm install pirev

```

## Usage

### Asynchronous

```

const pirev = require('pirev');

pirev.getInfo().then(({ revision }) => {

  console.log(`Raspberry Pi ${revision.type}`);

});

```

### Synchronous

```

const pirev = require('pirev');

const { revision } = pirev.getInfoSync();

console.log(`Raspberry Pi ${revision.type}`);

```

## Error handling

Running the utility on a device which is **not** a Raspberry Pi will result in an error being thrown.

```

pirev.getInfo()

  .then(({ revision }) => console.log(`Raspberry Pi ${revision.type}`))

  .catch(() => console.warn('Not a Raspberry Pi device!'));

```

or

```

try {

  const { revision } = pirev.getInfoSync();

  console.log(`Raspberry Pi ${revision.type}`);

} catch {

  console.warn('Not a Raspberry Pi device!');

}

```