Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 2.38 KB

protocol.md

File metadata and controls

84 lines (55 loc) · 2.38 KB

WSM ↔ PC communication protocol v1.0

Overview

This protocol allows PC to receive speed from WSM module. Speed is sent every 100 ms. However, this protocol is designed universally to support future full-duplex communication. This protocol is a binary protocol.

Standard WSM ↔ PC message format:

Header byte Data byte 1 Data byte 2 ... Data byte n XOR
0b1TTT LLLL 0b1DDD DDDD 0b1DDD DDDD ... 0b1DDD DDDD XOR

Protocol is 7-bit, because Bluettoth module resists to transfer data like \0 or \3. This is probably due to the fact that module thinks it is in text mode. We have not any way how to switch HC-05 module to raw data mode.

XOR is also 7-bit XOR.

Header byte

  • TTT : type of message
  • LLLL : length of Data byte 1 .. Data byte n

XOR

is XOR of Header byte, Data byte 1 .. Data byte n.

WSM → PC messages

Speed

Header byte Data byte 1 Data 2 Data 3 Data 4 XOR
0x94 0x81 INTHH INTH INTL XOR

Speed measured. interval = ((INTHH & 0x03) << 14) | ((INTH & 0x7F) << 7) | (INTL & 0x7F) This packet is sent each 100 ms.

speed = (PI * wheelDiameter * F_CPU * 3.6 * scale) / HOLE_COUNT * PSK * interval
  • F_CPU = 3686400
  • HOLE_COUNT = 8
  • PSK = 64
  • wheelDiameter is in m
  • scale is 120 for TT, 87 for H0 etc

Distance

Header byte Data byte 1 Data 2 Data 3 ... XOR
0x96 0x82 C1 C2 C3-5 XOR

Packet contains number of elapsed spaces till last boot. This value may overflow. This packet is sent each 500 ms.

elapsed in uint32_t.

elapsed = C5 & 0x7F | (C4 & 0x7F) << 7 | (C3 & 0x7F) << 14 | (C2 & 0x7F) << 21 | (C1 & 0x0F) << 28
real_distance = delta_elapsed * pi * wheelDiameter / HOLE_COUNT

Battery voltage

Header byte Data byte 1 Data 2 XOR
0x92 0b1C000HHH L XOR

Battery voltage info.

  • voltage = (HHH << 7) + L
  • critical bit = C

When critical bit is set, device is going to shutdown in a few microseconds.

Real voltage [V] = (voltage / 1024) * 4.578.

PC → WSM messages

No.