SORACOM Developers

Documents

Binary Parser

Overview

Binary Parser converts binary payloads to JSON objects on SORACOM platform and the data is sent to destinations (SORACOM Beam / Funnel / Harvest. This feature is available on SORACOM Air for LoRaWAN and Sigfox.

Binary Parser has two types, Predefined Format and Custom Format.
Predefined Format is a fixed format created by Soracom. Custom Parser supports some types and simple calculation.

Sequence

binaryParserEnabled: truewill be added in parsed JSON.

Predefined Format

Predefined format parses data automatically.
Supported devices are below.

Device name Format
Sens'it @sensit

Format

flag:0:bool:7 temp:1:int:13:/10 humid:3:uint:8:/100 lat::float:32 long:float:32

[name]:[byte index]:[type]:[options]

Name

Available characters: Number, Alphabets, #, -, _, $.

Reserved Words (Using in LoRa, Sigfox paylods)

# LoRa
"date", "gatewayData", "data", "deveui"

# Sigfox
"device", "time", "station", "lat", "lng", "rssi", "data", "seqNumber", "data"

Byte Index

Types

Parser supports these types: bool, int, uint, float, and char.

Options

bool

Bit offset (Required)

int, uint

length (Required)

The bit length to read (1 - 32)

offset (Optional, default 7)
operations (Optional, limit: 5)

Available operators:

+, -, *, /


These operators have same priority. It means all calculations execute from left to right.

value:0:int:8:+10*2
1+10*2 = (1 + 10) * 2 = 22

float (IEEE 754)

length (Required. 32 or 64)
offset (Optional)
operations (Optional)

char

length (Required, 1 - 8)

The byte size to read.

Advanced Tips

Endianness

value:0:float:64:little-endian

How to setting

You can edit the format on the group config in user console or API

FAQ

Getting Started

SORACOM Air for Cellular

SORACOM Air for Sigfox

SORACOM Beam

SORACOM Canal/Direct/Door

SORACOM Endorse

SORACOM Funnel

SORACOM Gate

SORACOM Harvest

SORACOM Inventory

SORACOM Junction

SORACOM Krypton

SORACOM Lagoon

Service Detail

Developer Tools

pagetop