npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

binary-version-reader

v2.5.1

Published

If you're building firmware on the Particle Platform, you might be curious to see the metadata stored in your firmware! This module will read any metadata stored in the various modules (bootloader, system, user), and help you understand any dependencies.

Downloads

2,406

Readme

The Particle Binary Version Reader!

If you're building firmware on the Particle Platform, you might be curious to see the metadata stored in your firmware! This module will read any metadata stored in the various modules (bootloader, system, user), and help you understand any dependencies.

Build Status

Usage

    const Reader = require('binary-version-reader').HalModuleParser;
    const reader = new Reader();
    reader.parseFile('your_binary.bin', function(fileInfo, err) {
        console.log(fileInfo);
    });

You can also get the raw output of binary-version-reader by using it as a command line tool without installing it.

npx binary-version-reader your_binary.bin

Example output

{
	"filename": "/.../040_user-part.bin",
	"fileBuffer": "<Buffer ...>",
	"crc": {
		"ok": 1,
		"storedCrc": "b138f375",
		"actualCrc": "b138f375"
	},
	"prefixInfo": {
		"moduleStartAddy": "80a0000",
		"moduleEndAddy": "80a128c",
		"moduleVersion": 2,
		"platformID": 6,
		"moduleFunction": 5,
		"moduleIndex": 1,
		"depModuleFunction": 4,
		"depModuleIndex": 2,
		"depModuleVersion": 1
	},
	"suffixInfo": {
		"productId": -1,
		"productVersion": -1,
		"fwUniqueId": "f9f552aa98d7e3eab750862a01743024a4d05514021598a4341b3d83b37eda36",
		"reserved": 0,
		"suffixSize": 36,
		"crcBlock": "b138f375"
	}
}

Testing firmware binaries

When you need to create a firmware binary for an integration test, you can use the provided firmwareTestHelper instead of relying on fixtures in your application.

const { firmwareTestHelper, ModuleInfo } = require('binary-version-reader');
const binary = firmwareTestHelper.createFirmwareBinary({ productId: 123, productVersion: 6, platformId: 10, deps: [ { func: ModuleInfo.FunctionType.SYSTEM_PART, index: 1, version: 1210 } ] });

Releasing changes

Packages are only released from the master branch after peer review.

  1. make sure you have the latest:
    • $ git checkout master
    • $ git pull
  2. make sure tests pass
    • $ npm test
  3. bump the version
    • $ npm version <major|minor|patch>
  4. push your tags:
    • $ git push origin main --follow-tags