@abpd2001/rpicam/README.md

A lightweight library to control CSI-2 camera modules via any raspberry pi can read camera module but is dependent to shell.

# Raspberry pi camera library for node.js

**Simple** and **lightweight** library for taking control of _Raspberry Pi Camera_ for Node (JS/TS).

## Table of contents

- [Table of contents](#table-of-contents)
- [Introduction](#introduction)
- [Installation](#installation)
- [Features](#features)
- [Technicals](#technicals)

  - [Properties](#properties)

    - [`tasks`](#tasks)
    - [`live`](#live)

  - [Serves](#serves)

    - [`serveStill`](#servestill)
    - [`serveStillSync`](#servestillsync)
    - [`serveStillCustom`](#servestillcustom)
    - [`serveStillCustomSync`](#servestillcustomsync)
    - [`serveVideo`](#servevideo)
    - [`serveVideoSync`](#servevideosync)
    - [`serveVideoCustom`](#servevideocustom)
    - [`serveVideoCustomSync`](#servevideocustomsync)

  - [Streams](#streams)

    - [`serveLive`](#servelive)

  - [Stats](#stats)
    - [`isReady`](#isready)
    - [`isReadySync`](#isreadysync)
  - [Reservations](#reservations)
    - [`killTask`](#killtask)
    - [`killAllTasks`](#killalltasks)
    - [`reserve`](#reserve)
    - [`unlockReserve`](#unlockreserve)

## Introduction

`rpicam-apps-lite` is a linux package `rpi-cam` npm library dependent to it and used for controlling _Raspberry Pi Camera_ series connects via CSI-2 socket and other ports.

**Warning:** This library only test on these Linux distros and not recommended to use windows or other OS not supported for `rpicam-apps-lite` package, also is not fast as a C/C++ custom drivers and use shell tools!

- Debian
- Ubuntu
- Raspbian

## Installation

In first you need to setup dependent packages, so run this command to check already installed or not:

```bash
apt list --installed rpicam-apps-lite  # for Debian based distros.
# or
yum list --installed rpicam-apps-lite  # for REHL based distros (not recommended).
```

_Note: if already downloaded, skip downloading, else continue._

then download package by this command:

```bash
sudo apt install rpicam-apps-lite  # for Debian based distros.
# or
sudo yum install rpicam-apps-lite  # for REHL based distros (not recommended).
```

at last step, install library on your node.js project:

```bash
npm install rpi-cam
```

## Features

Is lightweight, user friendly and professionals also can use this as a advanced library access them to every options like **zooming** or adding **effects** and **capturing method** and mores supported in `rpicam-apps-lite`.

Some advatage of using this library:

- its user-friendly and has advanced tools for professionals.
- its lightweight.
- all tools in `rpicam-apps-lite` is usable on this library.
- can wait and reserve camera to avoid **race-condition** bugs.
- also can do advanced method of capturing videos and photos like _burst shots_, _capturing last 30 minutes_ or _live streaming_ and others...

## Technicals