BIN to HEX converter

Converts a bin array to an (Intel) HEX string. More specifically I8HEX since only record types 00 and 01 are being used.

Usage

Can be used in both nodeJs and Browser context, you only need to supply the binary data in form of a Uint8Array:

import BinToHex from "bin-to-hex";

const data = new Uint8Array([0xDE, 0xAD, 0xBE, 0xEF]);
const converter = new BinToHex();
const hex = converter.convert(data);

console.log(hex)

Alternatively you can pass configuration to the consturctur, the following values are assumed to be the defaults if you do not instantiate with parameters:

import BinToHex from "bin-to-hex";

const maxBytes = 10;
const offset = 0;
const empty = null;
const converter = new BinToHex(maxBytes, offset, empty);

Those parameters additionally have setters and getters:

converter.setMaxBytes(4);
converter.getMaxBytes();

maxBytes: The maximum amount of data bytes per record
offset: Offset for the address in case the data should not start at 0x00
empty: If empty value is set, bytes with this value will be removed from the resulting HEX. If the flash hast the value 0xFF after bein erased, the hex file does not need to include those segments of memory, reducing the overall file size of the HEX file.

You can provide the binary data to the convert methods in different ways, for example by reading a local file or converting a Blob to a Buffer.

HEX format

Each line in a HEX file represents a chunk of data at a specific address:

:{RCLEN}{ADDRESS}{RECTYPE}{DATA}{CHECKSUM}

:: Startcode
RCLEN: Length of {DATA} in bytes
ADDRESS: The address of the data (16 Bit)
RECTYPE: Record type - this can either be 00 (Data) or 01 (End of file)
DATA: {RCLEN} amount of data bytes
CHECKSUM: Checksum over the whole record ({ADDRESS}, {RECTYPE} and {DATA})

Every HEX file ends with a 01 (End of file) record.

The binary representation of 0xDEADBEEF would end up in the following HEX file representation:

:04 0000 00 DEADBEEF

Development

yarn install

Run linter

yarn lint

Run tests

yarn test

Build for NPM

yarn build

Publish to NPM

Lint, test and build

yarn pre-publish

and finally publish to NPM

yarn publish

Using locally

In order to use the library locally it needs to be linked like so:

In the root directory of this library run: yarn link
Make sure a build exists yarn build
In the root directory where you want to use this library run yarn link "bin-to-hex"

Then you can import and use the library:

import BinToHex from 'bin-to-hex';

const data = new Uint8Array([0xDE, 0xAD, 0xBE, 0xEF]);
const converter = new BinToHex();
const hex = converter.convert(data);

console.log(hex);

Contributing

Contributions are very welcome, please direct your PRs against the develop branch.

stylesuxx/bin-to-hex