particle-iot/binary-version-reader

Name: binary-version-reader

Owner: Particle

Description: a node.js module to parse versions and information from system modules and firmware for any particle device

Created: 2015-06-11 15:43:29.0

Updated: 2018-05-10 16:33:49.0

Pushed: 2018-05-10 17:13:03.0

Homepage: null

Size: 675

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

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.

Usage

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

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"
}

Known issues

• missing better documentation / examples
• tests for newer platforms as they become available