History

Wouter Born 6bf59605bd Use Spotless sortpom plug-in (#4618 ) This simplifies the sortpom configuration and also allows for checking and reformatting them using the spotless:check and spotless:apply Maven goals. Signed-off-by: Wouter Born <github@maindrain.net>		2025-02-23 19:04:47 +01:00
..
src	Start license headers with `/` instead of `/*` (#4544 )	2025-01-07 21:48:56 +01:00
.classpath	Update Eclipse files (#4514 )	2024-12-24 07:02:47 +01:00
.project	[bin2json] Binary to JSON converter initial contribution (#611 )	2019-09-01 12:57:58 +02:00
NOTICE	[bin2json] Binary to JSON converter initial contribution (#611 )	2019-09-01 12:57:58 +02:00
README.md	[bin2json] Binary to JSON converter initial contribution (#611 )	2019-09-01 12:57:58 +02:00
pom.xml	Use Spotless sortpom plug-in (#4618 )	2025-02-23 19:04:47 +01:00

README.md

Binary data to JSON format converter

This bundle can be used to convert binary data to JSON format.

This bundle utilize awesome Java Binary Block Parser. See more details about the library and parse rule syntax from page Java Binary Block Parser.

Example usage:


// @formatter:off
/*
 * Frame format:
 * +----+----+-----+-----+-----+-------+-----+----+-------+
 * | CC | 64 |  F  | <D> | <S> | <LEN> | <DATA>   | <CRC> |
 * +----+----+-----+-----+-----+-------+-----+----+-------+
 * |<------------------ HDR ---------->|
 *                                     |<----- LEN ------>|
 *      |<-------------------- CRC -------------->|
 *
 */

String frameParserRule =
          "ubyte          cc;"                   // 0xCC, 204
        + "ubyte          start;"                // 0x64, 100
        + "ubyte          flag;"                 // 0x85, 133
        + "ubyte          destinationAddress;"   // 0xFD, 253
        + "ubyte          sourceAddress;"        // 0x0A, 10
        + "ubyte          dataLen;"              // 0x0B, 11
        + "ubyte[dataLen] data;"                 // 0x2101A0010000030A040000, 33 1 160 1 0 0 3 10 4 0 0
        + "ushort         crc;";                 // 0x8C17, 35863


final byte[] testdata = new byte[] {
        (byte) 0xCC,
        (byte) 0x64,
        (byte) 0x85,
        (byte) 0xFD,
        (byte) 0x0A,
        (byte) 0x0B,
        (byte) 0x21, (byte) 0x01, (byte) 0xA0, (byte) 0x01, (byte) 0x00, (byte) 0x00, (byte) 0x03, (byte) 0x0A, (byte) 0x04, (byte) 0x00, (byte) 0x00,
        (byte) 0x8C, (byte) 0x17 };
// @formatter:on

JsonObject json = new Bin2Json(frameParserRule).convert(testdata);
logger.debug(json.toString());

Outputs:

{
  "cc": 204,
  "start": 100,
  "flag": 133,
  "destinationaddress": 253,
  "sourceaddress": 10,
  "datalen": 11,
  "data": [
    33,
    1,
    160,
    1,
    0,
    0,
    3,
    10,
    4,
    0,
    0
  ],
  "crc": 35863
}