# 6lowpan

> 6LoWPAN module

Latest version **0.0.6** (published 2015-07-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install 6lowpan
pnpm add 6lowpan
yarn add 6lowpan
bun add 6lowpan
```

## 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.6 |
| Published | 2015-07-07 |
| First published | 2015-04-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jesus Alejandro Ayala Bonilla |
| Maintainers | jebus |
| Keywords | 6lowpan, iot, thread, zigbee, ipv6, 802.15.4 |

## Links

- npm: https://www.npmjs.com/package/6lowpan
- Repository: https://github.com/Alex-Ayala-Bonilla/6lowpan
- Issues: https://github.com/Alex-Ayala-Bonilla/6lowpan/issues
- npm.io page: https://npm.io/package/6lowpan

## Dependencies (1)

- [bitmagic](https://npm.io/package/bitmagic.md) *

## Recent versions

- 0.0.6 (latest) — 2015-07-07
- 0.0.5 — 2015-04-21
- 0.0.4 — 2015-04-15

## README

# 6lowpan
A nodejs module to parse, create and test 6lowpan frames.
Version 0.0.6 alpha

## Installation

Via npm:

    npm install 6lowpan
    
## Features
 * Initial iphc parse, iphc header and inline header

## Examples

### Example 1

```js
var frameBuffer = new Buffer('60ffffffffffffffffffffffffffffffffffffffffffffffffffffffff', 'hex');

var sixlo = require('6lowpan');


	sixlo.parse(frameBuffer, function(data, error){
		console.log(data.pattern); // LOWPAN_IPHC
		console.log(data.iphc); // the iphc header 
		console.log(data.inline); // inline Header
		console.log(data.payload); // the payload remaining
	});

```

### Example 2

```js
var frameBuffer = new Buffer('60ffffffffffffffffffffffffffffffffffffffffffffffffffffffff', 'hex');

var sixlo = require('6lowpan');

var parse = new sixlo.iphc(frameBuffer);
var type = parse.type();
console.log('Pattern: ' + type);
console.log(type === 'LOWPAN_IPHC'); //true
console.log(type === 'IPv6' ); // false
console.log(type === 'LOWPAN_HC1' ); // false
console.log(type === 'LOWPAN_BC0' ); // false
console.log(type === 'ESC' ); // false
console.log(type === 'MESH' ); // false
console.log(type === 'FRAG1' ); // false
console.log(type === 'FRAGN' ); // false
console.log(parse.iphc());
console.log(parse.inlineHeader());
console.log(parse.payload());


```


## TODOs
  * Add Extension Headers
  * Add more documentation
  * Add IPv6 - Uncompressed IPv6 Addresses
  * Add LOWPAN_HC1 - LOWPAN_HC1 compressed IPv6
  * Add LOWPAN_BC0 - LOWPAN_BC0 broadcast
  * Add MESH       - Mesh Header
  * Add FRAG1      - Fragmentation Header (first) 
  * Add FRAGN      - Fragmentation Header (subsequent)
  * Add descriptions for each field of the iphc header.
  * Validator of 6lowpan frame.
  * Desfragmentation
  * Functionality to create a 6lowpan frame from user data (json config)

## Doing
 * Extension Headers

   
## History

### 0.0.4 Initial Commit

 * Initial Commit
 * nitial iphc parse, iphc header and inline header.
  
### 0.0.5 Updates

 * Object functionality.
 * Update example 2.

### 0.0.6 Updates

 * Added: IPv6 Next Header Compression.
 * Modified: Project tree

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