# node-slam

> Node.js SLAM based on Intel® RealSense™ technology

Latest version **0.10.1** (published 2017-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-slam
pnpm add node-slam
yarn add node-slam
bun add node-slam
```

## 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.10.1 |
| Published | 2017-04-25 |
| First published | 2017-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 24 |
| Maintainers | kenny-yuan |

## Links

- npm: https://www.npmjs.com/package/node-slam
- Repository: https://github.com/01org/node-realsense
- Homepage: https://github.com/01org/node-realsense#readme
- Issues: https://github.com/01org/node-realsense/issues
- npm.io page: https://npm.io/package/node-slam

## Dependencies (3)

- [nan](https://npm.io/package/nan.md) ^2.4.0
- [bindings](https://npm.io/package/bindings.md) ^1.2.1
- [widl-nan](https://npm.io/package/widl-nan.md) ^0.1.23

## Recent versions

- 0.10.1 (latest) — 2017-04-25
- 0.10.0 — 2017-04-01
- 0.9.1 — 2017-02-27
- 0.0.1 — 2017-02-27

## README

# Intel® RealSense™ technology with JavaScript API for Linux OS

`node-slam`: Node.js Simultaneous Localization and Mapping (SLAM) module based on Intel® RealSense™ technology.

Please refer to [Release Note](https://github.com/01org/node-realsense/releases) for details of current release.

# Install
Prepare [environment](https://01org.github.io/node-realsense/doc/setup_environment.html) and then execute the following command in shell:
```
npm install --save node-slam
```

# Examples
The following example shows the basic usage of this module. Before executing it, connect an Intel® RealSense™ ZR300 Camera to your computer or developer board.

```
const slamModule = require('node-slam');

slamModule.createInstance().then(slam => {
  slam.on('tracking', (evtData) => {
    // Update on camera pose and etc.
    console.log('Camera tracking:', evtData.cameraPose, evtData.accuracy);

    slam.getOccupancyMapUpdate().then((mapData) => {
      // mapData is updated
      // TODO: process mapData.tileCount & etc.
    });

    // Optional: save map to disk
    // slam.saveOccupancyMapAsPpm('occupancy.ppm', true).then(() => {
    //   // Map is saved
    // });
  });

  slam.start().then(() => {
    console.log('Camera + algorithm started...');
  });
});
```

# Document
Please refer to the [project document home page](https://01org.github.io/node-realsense/), and also the details page listed below:
- [Concept and terms](https://software.intel.com/sites/products/realsense/slam/developer_guide.html)
- [SLAM Module document](https://01org.github.io/node-realsense/doc/spec/slam.html)
- [Common API document](https://01org.github.io/node-realsense/doc/spec/common.html)

---
_Source: https://npm.io/package/node-slam · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._