Skip to content
This repository has been archived by the owner on Jul 26, 2021. It is now read-only.

Latest commit

 

History

History
162 lines (126 loc) · 7.35 KB

protocol-design.md

File metadata and controls

162 lines (126 loc) · 7.35 KB
Raw

Atorch protocol design

Initial connection information

Bluetootch Profile

Device broadcast name: UD18-SPP, AT24-SPP, etc *-SPP

Profile
Serial Port Profile

Bluetootch LE

Device broadcast name: UD18-BLE, AT24-BLE, etc *-BLE

Type UUID
Service 0000FFE0-0000-1000-8000-00805F9B34FB
Characteristic 0000FFE1-0000-1000-8000-00805F9B34FB

Packet layout

Offset Field Block size Note
00 Magic Header 2 byte FF 55
02 Message Type 1 byte Message Type
03 Payload
Last byte Checksum 1 byte Checksum Algorithm

Type indicator

Type Value Payload size Note
Message Type 01 32 byte Report
Message Type 02 4 byte Reply
Message Type 11 6 byte Command
- - - -
Device Type 01 AC Meter Report
Device Type 02 DC Meter Report
Device Type 03 USB Meter Report

AC Meter Report

Sample Packet: packet-meter-ac.spec.ts

Offset Field Block size Note
03 Device Type 1 byte 01 Device Type
04 Voltage 3 byte 24 bit BE (divide by 10)
07 Amp 3 byte 24 bit BE (divide by 1000)
0A Watt 3 byte 24 bit BE (divide by 10)
0D W·h 4 byte 32 bit BE (divide by 100)
11 Price (per kW·h) 3 byte 24 bit BE (divide by 100)
14 Frequency 2 byte 16 bit BE (divide by 10)
16 Power factor 2 byte 16 bit BE (divide by 1000)
18 Temperature 2 byte 16 bit BE
1A Hour 2 byte 16 bit BE
1C Minute 1 byte
1D Second 1 byte
1E Backlight 1 byte

DC Meter Report

There are currently no unpurchased product tests

Offset Field Block size Note
03 Device Type 1 byte 02 Device Type
04 Voltage 3 byte 24 bit BE (divide by 10)
07 Amp 3 byte 24 bit BE (divide by 1000)
0A Watt 3 byte 24 bit BE (divide by 10)
0D W·h 4 byte 32 bit BE (divide by 100)
11 Price (per kW·h) 3 byte 24 bit BE (divide by 100)
14 4 byte unknown value
18 Temperature 2 byte 16 bit BE
1A Hour 2 byte 16 bit BE
1C Minute 1 byte
1D Second 1 byte
1E Backlight 1 byte

USB Meter Report

Sample Packet: packet-meter-usb.spec.ts

Offset Field Block size Note
03 Device Type 1 byte 03 Device Type
04 Voltage 3 byte 24 bit BE (divide by 100)
07 Amp 3 byte 24 bit BE (divide by 100)
0A A·h 3 byte 24 bit BE (divide by 1000)
0D W·h 4 byte 32 bit BE (divide by 100)
11 USB D- 2 byte 16 bit BE (divide by 100)
13 USB D+ 2 byte 16 bit BE (divide by 100)
15 Temperature 3 byte 24 bit BE
17 Hour 2 byte 16 bit BE
19 Minute 1 byte
1A Second 1 byte
1B Backlight 1 byte

Command

Sample Packet: packet-command.spec.ts

Offset Field Block size Note
03 Device Type 1 byte Device Type
04 Command 1 byte
05 Value 4 byte 32 bit BE
Command Value Action
01 Reset W·h
02 Reset A·h
03 Reset Duration
05 Reset All
11 [+] Command
12 [-] Command
21 0 to 60 Set Backlight Time
22 1 to 999999 Set Price
31 Setup
32 Enter
33 [+] Command (USB meter)
34 [-] Command (USB meter)

Reply

Sample Packet: packet-reply.spec.ts

Offset Field Block size
03 State 2 byte
Known State Action
02 01 OK
02 03 Unsupported

Checksum Algorithm

Without Magic Header

const packet = Buffer.from('FF551103310000000001', 'hex');

const payload = packet.slice(2, -1);
// "11033100000000" (hex string)

const checksum = payload.reduce((acc, item) => (acc + item) & 0xff, 0) ^ 0x44;
// checksum: 0x01

packet[packet.length - 1] == checksum;
// returns true

Thanks