LIGO PRO BLE Protocol - Revision history

Admin: Initial Release [release]

2026-06-10T04:37:29Z

Initial Release [release]

Admin: /* Checksum Calculation Algorithm */

2026-06-10T04:27:28Z

Checksum Calculation Algorithm

← Older revision		Revision as of 04:27, 10 June 2026
Line 257:		Line 257:
	The checksum is calculated using Dallas APPLICATION NOTE 27 table method: ''Understanding and Using Cyclic Redundancy Checks with Dallas Semiconductor iButton Products''. One can use the following algorithms to calculate the checksum with a polynom <code>x^8 + x^5 + x^4 + 1</code> (C language):		The checksum is calculated using Dallas APPLICATION NOTE 27 table method: ''Understanding and Using Cyclic Redundancy Checks with Dallas Semiconductor iButton Products''. One can use the following algorithms to calculate the checksum with a polynom <code>x^8 + x^5 + x^4 + 1</code> (C language):

	<~~pre~~>		<syntaxhighlight lang="c" line>
	U8 CRC8(U8 data, U8 crc)		U8 CRC8(U8 data, U8 crc)
	{		{
Line 272:		Line 272:
	return crc;		return crc;
	}		}
	</~~pre~~>		</syntaxhighlight>

	<div class="noprint">		<div class="noprint">

Admin: /* Checksum Calculation Algorithm */

2026-06-10T04:21:02Z

Checksum Calculation Algorithm

← Older revision		Revision as of 04:21, 10 June 2026
Line 257:		Line 257:
	The checksum is calculated using Dallas APPLICATION NOTE 27 table method: ''Understanding and Using Cyclic Redundancy Checks with Dallas Semiconductor iButton Products''. One can use the following algorithms to calculate the checksum with a polynom <code>x^8 + x^5 + x^4 + 1</code> (C language):		The checksum is calculated using Dallas APPLICATION NOTE 27 table method: ''Understanding and Using Cyclic Redundancy Checks with Dallas Semiconductor iButton Products''. One can use the following algorithms to calculate the checksum with a polynom <code>x^8 + x^5 + x^4 + 1</code> (C language):

	<pre ~~style="background:#f6f8fa;border:1px solid #d0d7de;border-radius:6px;padding:12px 16px;font-family:Consolas,'SF Mono','Menlo','Courier New',monospace;font-size:12px;line-height:1.5;overflow-x:auto;"~~>		<pre>
	U8 CRC8(U8 data, U8 crc)		U8 CRC8(U8 data, U8 crc)
	{		{

Admin: /* Checksum Calculation Algorithm */

2026-06-10T04:20:25Z

Checksum Calculation Algorithm

← Older revision		Revision as of 04:20, 10 June 2026
Line 257:		Line 257:
	The checksum is calculated using Dallas APPLICATION NOTE 27 table method: ''Understanding and Using Cyclic Redundancy Checks with Dallas Semiconductor iButton Products''. One can use the following algorithms to calculate the checksum with a polynom <code>x^8 + x^5 + x^4 + 1</code> (C language):		The checksum is calculated using Dallas APPLICATION NOTE 27 table method: ''Understanding and Using Cyclic Redundancy Checks with Dallas Semiconductor iButton Products''. One can use the following algorithms to calculate the checksum with a polynom <code>x^8 + x^5 + x^4 + 1</code> (C language):

	<pre>		<pre style="background:#f6f8fa;border:1px solid #d0d7de;border-radius:6px;padding:12px 16px;font-family:Consolas,'SF Mono','Menlo','Courier New',monospace;font-size:12px;line-height:1.5;overflow-x:auto;">
	U8 CRC8(U8 data, U8 crc)		U8 CRC8(U8 data, U8 crc)
	{		{
Line 275:		Line 275:

	<div class="noprint">		<div class="noprint">

	== Related Documents ==		== Related Documents ==
	''Cross-references to other documents.''		''Cross-references to other documents.''

Admin: Update

2026-06-10T04:19:53Z

Update

← Older revision		Revision as of 04:19, 10 June 2026
Line 275:		Line 275:

	<div class="noprint">		<div class="noprint">

	== Related Documents ==		== Related Documents ==
	''Cross-references to other documents.''		''Cross-references to other documents.''

Admin: /* Checksum Calculation Algorithm */

2026-06-10T04:19:24Z

Checksum Calculation Algorithm

← Older revision		Revision as of 04:19, 10 June 2026
Line 257:		Line 257:
	The checksum is calculated using Dallas APPLICATION NOTE 27 table method: ''Understanding and Using Cyclic Redundancy Checks with Dallas Semiconductor iButton Products''. One can use the following algorithms to calculate the checksum with a polynom <code>x^8 + x^5 + x^4 + 1</code> (C language):		The checksum is calculated using Dallas APPLICATION NOTE 27 table method: ''Understanding and Using Cyclic Redundancy Checks with Dallas Semiconductor iButton Products''. One can use the following algorithms to calculate the checksum with a polynom <code>x^8 + x^5 + x^4 + 1</code> (C language):

	<~~syntaxhighlight lang="c" line~~>		<pre>
	U8 CRC8(U8 data, U8 crc)		U8 CRC8(U8 data, U8 crc)
	{		{
Line 272:		Line 272:
	return crc;		return crc;
	}		}
	</~~syntaxhighlight~~>		</pre>

	<div class="noprint">		<div class="noprint">

	== Related Documents ==		== Related Documents ==
	''Cross-references to other documents.''		''Cross-references to other documents.''

Admin: Update

2026-06-10T04:16:09Z

Update

Show changes

Admin: Update

2026-06-10T04:05:53Z

Update

← Older revision		Revision as of 04:05, 10 June 2026
Line 1:		Line 1:
	== General Introduction ==		== General Introduction ==
	~~<div class="dim">~~

	~~''Brief introduction to the protocol per IEC/IEEE standards for wireless data protocols.''~~

	~~'''What to fill in:'''~~
	* '''Protocol name and version''' — full name + version number (vd: SOJI Protocol v2.1)
	* '''Purpose''' — what data the protocol transmits and to whom
	* '''Transport layer''' — Bluetooth 5.4 BLE / WiFi / LoRa / proprietary RF
	* '''Frequency & modulation''' — 2.4 GHz GFSK / LoRa CSS / ...
	* '''Operating mode''' — Advertising-only (one-way broadcast) / Connection-based / Mesh
	* '''Compatible devices''' — list of sensors / receivers supporting this protocol
	* '''Reference standards''' — IEEE 802.15.4, Bluetooth Core 5.4, etc.

	~~'''Example structure:'''~~
	* Paragraph 1: "The [Protocol Name] is a [type] protocol defined by SOJI Electronics for [purpose]..."
	* Paragraph 2: "It operates over [transport] at [frequency] and is supported by [device list]..."

	~~'''Optional sub-sections:'''~~
	* === Protocol Stack === — layered diagram of protocol stack
	* === Roles === — Broadcaster / Observer / Central / Peripheral
	* === Security === — encryption, authentication, password protection

	~~</div>~~

	== Advertising Message Format ==		== Advertising Message Format ==
	~~<div class="dim">~~

	~~''Byte-by-byte breakdown of the BLE advertising packet payload.''~~

	~~'''What to fill in:'''~~
	* '''Packet overview''' — total packet length, manufacturer ID, structure summary
	* '''Field table''' — every field with offset, length, value, description

	~~'''Example field breakdown table:'''~~

	~~{\| class="wikitable" style="width:100%;"~~
	\|-
	~~! Offset !! Length (bytes) !! Field Name !! Value / Format !! Description~~
	\|-
	~~\| 0x00 \|\| 1 \|\| AD Length \|\| 0xXX \|\| Length of the advertising data structure~~
	\|-
	~~\| 0x01 \|\| 1 \|\| AD Type \|\| 0xFF \|\| Manufacturer Specific Data (per Bluetooth Core spec)~~
	\|-
	~~\| 0x02 \|\| 2 \|\| Company ID \|\| 0xXXXX (LE) \|\| SOJI Electronics SIG-assigned Company ID~~
	\|-
	~~\| 0x04 \|\| 1 \|\| Protocol ID \|\| 0xXX \|\| SOJI Protocol identifier~~
	\|-
	~~\| 0x05 \|\| 1 \|\| Frame Type \|\| 0xXX \|\| Frame type (data frame, status frame, ...)~~
	\|-
	~~\| 0x06 \|\| N \|\| Payload \|\| ... \|\| Sensor data payload (see Payload Structure below)~~
	\|-
	~~\| 0x06+N \|\| 2 \|\| CRC-16 \|\| 0xXXXX \|\| CRC-16/CCITT checksum over Offset 0x00 to 0x05+N~~
	\|}

	~~'''Sub-sections to consider:'''~~
	* === Packet Overview === — total length, byte order (LE/BE), encoding
	* === Field Definitions === — main field table above
	* === Payload Structure === — detailed payload fields (level, temperature, battery, RSSI, etc.) with units and scaling
	* === Frame Types === — enumeration of frame types if multiple exist
	* === CRC / Checksum === — algorithm (CRC-16/CCITT, polynomial, init value, XOR-out)
	* === Example Raw Frame === — hex dump of a real advertising packet with field annotations
	* === Decoding Pseudocode === — short code snippet (C / Python) showing how to parse a frame

	~~'''Example raw frame block:'''~~
	~~<syntaxhighlight lang="text">~~
	~~Raw bytes (hex):~~
	~~0E FF 5A A5 01 02 03 04 ...~~

	~~Decoded:~~
	~~AD Length = 0x0E (14 bytes)~~
	~~AD Type = 0xFF (Manufacturer Specific)~~
	~~Company ID = 0xA55A (SOJI Electronics)~~
	~~Protocol ID = 0x01 (SOJI Protocol)~~
	~~Frame Type = 0x02 (Data Frame)~~
	~~...~~
	~~</syntaxhighlight>~~

	~~'''Example decoding pseudocode:'''~~
	~~<syntaxhighlight lang="python">~~
	~~def decode_soji_frame(adv_data: bytes) -> dict:~~
	~~if adv_data[1] != 0xFF:~~
	~~return None~~
	~~company_id = int.from_bytes(adv_data[2:4], 'little')~~
	~~protocol_id = adv_data[4]~~
	~~frame_type = adv_data[5]~~
	~~payload = adv_data[6:-2]~~
	~~crc = int.from_bytes(adv_data[-2:], 'little')~~
	~~# ... validate CRC, parse payload~~
	~~return { ... }~~
	~~</syntaxhighlight>~~

	~~</div>~~

Admin: Create page

2026-06-10T04:05:21Z

Create page

New page

== General Introduction ==
<div class="dim">

''Brief introduction to the protocol per IEC/IEEE standards for wireless data protocols.''

'''What to fill in:'''
* '''Protocol name and version''' — full name + version number (vd: SOJI Protocol v2.1)
* '''Purpose''' — what data the protocol transmits and to whom
* '''Transport layer''' — Bluetooth 5.4 BLE / WiFi / LoRa / proprietary RF
* '''Frequency & modulation''' — 2.4 GHz GFSK / LoRa CSS / ...
* '''Operating mode''' — Advertising-only (one-way broadcast) / Connection-based / Mesh
* '''Compatible devices''' — list of sensors / receivers supporting this protocol
* '''Reference standards''' — IEEE 802.15.4, Bluetooth Core 5.4, etc.

'''Example structure:'''
* Paragraph 1: "The [Protocol Name] is a [type] protocol defined by SOJI Electronics for [purpose]..."
* Paragraph 2: "It operates over [transport] at [frequency] and is supported by [device list]..."

'''Optional sub-sections:'''
* === Protocol Stack === — layered diagram of protocol stack
* === Roles === — Broadcaster / Observer / Central / Peripheral
* === Security === — encryption, authentication, password protection

</div>

== Advertising Message Format ==
<div class="dim">

''Byte-by-byte breakdown of the BLE advertising packet payload.''

'''What to fill in:'''
* '''Packet overview''' — total packet length, manufacturer ID, structure summary
* '''Field table''' — every field with offset, length, value, description

'''Example field breakdown table:'''

{| class="wikitable" style="width:100%;"
|-
! Offset !! Length (bytes) !! Field Name !! Value / Format !! Description
|-
| 0x00 || 1 || AD Length || 0xXX || Length of the advertising data structure
|-
| 0x01 || 1 || AD Type || 0xFF || Manufacturer Specific Data (per Bluetooth Core spec)
|-
| 0x02 || 2 || Company ID || 0xXXXX (LE) || SOJI Electronics SIG-assigned Company ID
|-
| 0x04 || 1 || Protocol ID || 0xXX || SOJI Protocol identifier
|-
| 0x05 || 1 || Frame Type || 0xXX || Frame type (data frame, status frame, ...)
|-
| 0x06 || N || Payload || ... || Sensor data payload (see Payload Structure below)
|-
| 0x06+N || 2 || CRC-16 || 0xXXXX || CRC-16/CCITT checksum over Offset 0x00 to 0x05+N
|}

'''Sub-sections to consider:'''
* === Packet Overview === — total length, byte order (LE/BE), encoding
* === Field Definitions === — main field table above
* === Payload Structure === — detailed payload fields (level, temperature, battery, RSSI, etc.) with units and scaling
* === Frame Types === — enumeration of frame types if multiple exist
* === CRC / Checksum === — algorithm (CRC-16/CCITT, polynomial, init value, XOR-out)
* === Example Raw Frame === — hex dump of a real advertising packet with field annotations
* === Decoding Pseudocode === — short code snippet (C / Python) showing how to parse a frame

'''Example raw frame block:'''
<syntaxhighlight lang="text">
Raw bytes (hex):
0E FF 5A A5 01 02 03 04 ...

Decoded:
AD Length = 0x0E (14 bytes)
AD Type = 0xFF (Manufacturer Specific)
Company ID = 0xA55A (SOJI Electronics)
Protocol ID = 0x01 (SOJI Protocol)
Frame Type = 0x02 (Data Frame)
...
</syntaxhighlight>

'''Example decoding pseudocode:'''
<syntaxhighlight lang="python">
def decode_soji_frame(adv_data: bytes) -> dict:
if adv_data[1] != 0xFF:
return None
company_id = int.from_bytes(adv_data[2:4], 'little')
protocol_id = adv_data[4]
frame_type = adv_data[5]
payload = adv_data[6:-2]
crc = int.from_bytes(adv_data[-2:], 'little')
# ... validate CRC, parse payload
return { ... }
</syntaxhighlight>

</div>

<div class="noprint">
== Related Documents ==
''Cross-references to other documents.''
{{RelatedDocuments}}
</div>

== Revision History ==
<div class="revision-history-auto">
<span class="dim">Loading revision history...</span>
</div>

[[Category:LIGO PRO BLE ]]