bitsandbytes/README.md

A simple and light weight framework to decode binary or stream messages.

#BITS and BYTES#
A simple and light weight framework to decode binary or stream messages.
>
> npm install bitsandbytes
>

-----------------------
Bit Operations
--------------

```
var BitsAndBytes = require('bitsandbytes');
var decoder = new BitsAndBytes();

var msg = '4564654654657894916574879836';
var bufferStreams = new Buffer(msg,'hex');

//Big Endian
console.log("Bit : ",
decoder.decodeBE(bufferStreams,{type : 'bit',start :0 , length : 1, bitStart : 0, bitLength:3, signed:false }));

//Little Endian
console.log("Bit : ",
decoder.decodeLE(bufferStreams,{type : 'bit',start :0 , length : 1, bitStart : 0, bitLength:3, signed:false }));

\\start (Byte Start Position)
\\length (No of Bytes to consider)
\\bitStart (Start of bit position)
\\bitLength (No of bits to consider)

```


###Byte Operations###

Big-Endian
------------
```
var BitsAndBytes = require('bitsandbytes');
var decoder = new BitsAndBytes();

var msg = '4564654654657894916574879836';
var bufferStreams = new Buffer(msg,'hex');

console.log("8 Bit Integer : ",decoder.decodeBE(bufferStreams,{type : 'int8', start:0 }));
console.log("8 Bit Unsigned Integer",decoder.decodeBE(bufferStreams,{type : 'uint8', start:0 }));
console.log("16 Bit Integer : ",decoder.decodeBE(bufferStreams,{type : 'int16', start:0 }));
console.log("16 Bit Unsigned Integer : ",decoder.decodeBE(bufferStreams,{type : 'uint16', start:0 }));
console.log("32 Bit Integer : ",decoder.decodeBE(bufferStreams,{type : 'int32', start:0 }));
console.log("32 Bit Unsigned Integer : ",decoder.decodeBE(bufferStreams,{type : 'uint32', start:0 }));

console.log("Float : ",decoder.decodeBE(bufferStreams,{type : 'float', start:0 }));
console.log("Double : ",decoder.decodeBE(bufferStreams,{type : 'double', start:0 }));

console.log("Ascii : ",decoder.decodeBE(bufferStreams,{type : 'ascii', start:0, length : 4 }));
console.log("Utf8 : ",decoder.decodeBE(bufferStreams,{type : 'utf8', start:0, length : 4 }));
console.log("Hex : ",decoder.decodeBE(bufferStreams,{type : 'hex', start:0, length : 4 }));
console.log("Size : ",decoder.decodeBE(bufferStreams,{type : 'size', length : 4 }));

console.log("Byte : ",decoder.decodeBE(bufferStreams,{type : 'byte',start :0, length : 4 }));
console.log("Bit : ",
decoder.decodeBE(bufferStreams,{type : 'bit',start :0 , length : 1, bitStart : 0, bitLength:3, signed:false }));
\\start (Byte Start Position) 
\\length (No of Bytes to consider) 
\\bitStart (Start of bit position) 
\\bitLength (No of bits to consider)

```



Little-Endian
----------------
```
var BitsAndBytes = require('bitsandbytes');
var decoder = new BitsAndBytes();

var msg = '4564654654657894916574879836';
var bufferStreams = new Buffer(msg,'hex');

console.log("8 Bit Integer : ",decoder.decodeLE(bufferStreams,{type : 'int8', start:0 }));
console.log("8 Bit Unsigned Integer",decoder.decodeLE(bufferStreams,{type : 'uint8', start:0 }));
console.log("16 Bit Integer : ",decoder.decodeLE(bufferStreams,{type : 'int16', start:0 }));
console.log("16 Bit Unsigned Integer : ",decoder.decodeLE(bufferStreams,{type : 'uint16', start:0 }));
console.log("32 Bit Integer : ",decoder.decodeLE(bufferStreams,{type : 'int32', start:0 }));
console.log("32 Bit Unsigned Integer : ",decoder.decodeLE(bufferStreams,{type : 'uint32', start:0 }));

console.log("Float : ",decoder.decodeLE(bufferStreams,{type : 'float', start:0 }));
console.log("Double : ",decoder.decodeLE(bufferStreams,{type : 'double', start:0 }));

console.log("Ascii : ",decoder.decodeLE(bufferStreams,{type : 'ascii', start:0, length : 4 }));
console.log("Utf8 : ",decoder.decodeLE(bufferStreams,{type : 'utf8', start:0, length : 4 }));
console.log("Hex : ",decoder.decodeLE(bufferStreams,{type : 'hex', start:0, length : 4 }));
console.log("Size : ",decoder.decodeLE(bufferStreams,{type : 'size', length : 4 }));

console.log("Byte : ",decoder.decodeLE(bufferStreams,{type : 'byte',start :0, length : 4 }));
console.log("Bit : ",
decoder.decodeLE(bufferStreams,{type : 'bit',start :0, length : 1, bitStart : 0, bitLength:3, signed:false }));
\\start (Byte Start Position) 
\\length (No of Bytes to consider) 
\\bitStart (Start of bit position) 
\\bitLength (No of bits to consider)
```

> **Note:**
>  It will supports more complex decoding formats in a simple way. Detailed documentation will be provided soon.