# @zebrajaeger/raspberry-pi-camera-native

> Use your Raspberry Pi Camera Module with Node.js

Latest version **0.0.1** (published 2021-07-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @zebrajaeger/raspberry-pi-camera-native
pnpm add @zebrajaeger/raspberry-pi-camera-native
yarn add @zebrajaeger/raspberry-pi-camera-native
bun add @zebrajaeger/raspberry-pi-camera-native
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2021-07-16 |
| First published | 2021-07-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0 |
| Dependencies | 2 |
| Unpacked size | 23.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 1 |
| Author | Sandeep Mistry |
| Maintainers | zebrajaeger |
| Keywords | Raspberry Pi, Raspberry, Pi, Camera, native |

## Links

- npm: https://www.npmjs.com/package/@zebrajaeger/raspberry-pi-camera-native
- Repository: https://github.com/zebrajaeger/node-raspberry-pi-camera-native
- Issues: https://github.com/sandeepmistry/node-raspberry-pi-camera-native/issues
- npm.io page: https://npm.io/package/@zebrajaeger/raspberry-pi-camera-native

## Dependencies (2)

- [bindings](https://npm.io/package/bindings.md) ^1.5.0
- [node-addon-api](https://npm.io/package/node-addon-api.md) ^4.0.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2021-07-16

## README

# node-raspberry-pi-camera-native

- Forked to release a fixed version for the 'callback is not defined' issue.
- All dependencies have also been updated.
- This package name is @zebrajaeger/node-raspberry-pi-camera-native

Use your [Raspberry Pi Camera Module](https://www.raspberrypi.org/documentation/hardware/camera/README.md) with [Node.js](https://nodejs.org)

**NOTE:** Currently only supports still image capture.

## Prerequisites

 * Hardware
   * Raspberry Pi
   * [Raspberry Pi Camera module](https://www.raspberrypi.org/documentation/hardware/camera/README.md)

 * Software
   * [Raspberry Pi camera enabled](https://www.raspberrypi.org/documentation/configuration/camera.md)
   * Node.js 8 or later installed

## Install

```
npm install raspberry-pi-camera-native
```

## Usage

```javascript
// require module
const raspberryPiCamera = require('raspberry-pi-camera-native');

// add frame data event listener
raspberryPiCamera.on('frame', (frameData) => {
  // frameData is a Node.js Buffer
  // ...
});

// start capture
raspberryPiCamera.start();
```

### Events

#### Data

Listen for raw data events (partial frame data), `data` is a [Node.js Buffer](https://nodejs.org/dist/latest/docs/api/buffer.html)

```javascript
raspberryPiCamera.on('data', callback(data));
```

#### Frame

Listen for frame events (full frame data), `frameData` is a [Node.js Buffer](https://nodejs.org/dist/latest/docs/api/buffer.html)

```javascript
raspberryPiCamera.on('frame', callback(frameData));
```

### Actions

#### Start Capture

```javascript
raspberryPiCamera.start(options, callback);
```

Options is a object, with the following defaults:
```javascript
{
  width: 1280,
  height: 720,
  fps: 30,
  encoding: 'JPEG',
  quality: 75
}
```

Supported values:
 * `width`: `32` to `2592` (v1 camera) or `3280` (v2 camera)
 * `height`: `16` to `1944` (v1 camera) or `2464` (v2 camera)
 * `fps`: `1` to `90`
 * `encoding`: `'JPEG'` (hardware accelerated), `'GIF'`, `'PNG'`, `'PPM'`, `'TGA'`, `'BMP'` (see [mmal_encodings.h](https://github.com/raspberrypi/userland/blob/master/interface/mmal/mmal_encodings.h) for others)
 * `quality`: 1 - 100 (JPEG encoding quality)

#### Pause Capture

```javascript
raspberryPiCamera.pause(callback);
```

#### Resume Capture

```javascript
raspberryPiCamera.resume(callback);
```

#### Stop Capture

```javascript
raspberryPiCamera.stop(callback);
```

---
_Source: https://npm.io/package/@zebrajaeger/raspberry-pi-camera-native · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._