https://github.com/stylesuxx/bin-to-hex

Convert BIN data to HEX string in JavaScript
https://github.com/stylesuxx/bin-to-hex

Last synced: about 1 month ago
JSON representation

Convert BIN data to HEX string in JavaScript

• Host: GitHub
• URL: https://github.com/stylesuxx/bin-to-hex
• Owner: stylesuxx
• License: gpl-3.0
• Created: 2022-12-09T18:11:56.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T01:24:15.000Z (almost 2 years ago)
• Last Synced: 2023-03-13T08:15:45.166Z (over 1 year ago)
• Language: TypeScript
• Size: 111 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BIN to HEX converter

Converts a bin array to an [(Intel) HEX](https://en.wikipedia.org/wiki/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:

```JavaScript

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:

```JavaScript

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:

```JavaScript

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](https://developer.mozilla.org/en-US/docs/Web/API/Blob/arrayBuffer) 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:

1. In the root directory of this library run: ```yarn link```

2. Make sure a build exists ```yarn build```

3. 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:

```javascript

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.