An open API service indexing awesome lists of open source software.

https://github.com/microbit-foundation/microbit-universal-hex

TypeScript/JavaScript library to create micro:bit Universal Hex files.
https://github.com/microbit-foundation/microbit-universal-hex

microbit

Last synced: 10 months ago
JSON representation

TypeScript/JavaScript library to create micro:bit Universal Hex files.

Awesome Lists containing this project

README

          

# micro:bit Universal Hex TypeScript Library

microbit-universal-hex logo

[![GitHub Actions](https://github.com/microbit-foundation/microbit-universal-hex/actions/workflows/build.yml/badge.svg)](https://github.com/microbit-foundation/microbit-universal-hex/actions/workflows/build.yml)

TypeScript/JavaScript library to create micro:bit Universal Hex files for
micro:bit.

The Universal Hex file format was created to be able to contain the binary data
for micro:bit V1 and V2 boards in a single file, so that it works in all
versions of the micro:bit.

## Documentation

The documentation can be found in
https://microbit-foundation.github.io/microbit-universal-hex/.

## npm Package

To add this package to your project:

```
npm install @microbit/microbit-universal-hex
```

## Web Tool

microbit-universal-hex logo

An implementation example can be found in the
[docs/examples/webtool.html](docs/examples/webtool.html) file. This web tool can
generate a Universal Hex from two Intel Hex files.

It can be accessed online on this URL:
https://tech.microbit.org/software/universal-hex-creator/

There is also an example showing the reverse process of separating a Universal
Hex into individual Intel Hex files:
https://microbit-foundation.github.io/microbit-universal-hex/examples/separate.html

## License

This software is under the MIT open source license.

[SPDX-License-Identifier: MIT](LICENSE.md)

## Code of Conduct

Trust, partnership, simplicity and passion are our core values we live and
breathe in our daily work life and within our projects. Our open-source projects
are no exception. We have an active community which spans the globe and we
welcome and encourage participation and contributions to our projects by
everyone. We work to foster a positive, open, inclusive and supportive
environment and trust that our community respects the micro:bit code of conduct.

Please see our [code of conduct](https://microbit.org/safeguarding/) which
outlines our expectations for all those that participate in our community and
details on how to report any concerns and what would happen should breaches
occur.