summaryrefslogtreecommitdiff
path: root/doc/MotionService.md
diff options
context:
space:
mode:
authorJean-François Milants <jf@codingfield.com>2021-10-17 06:34:24 (GMT)
committerJean-François Milants <jf@codingfield.com>2021-10-17 06:34:24 (GMT)
commit31badd2eb3a46ed75a752f7b30015a1eaa205cc6 (patch)
treea967072db2913fde5c810c7bbcdf8c0b3e4fa6f0 /doc/MotionService.md
parent60a49af886f16b4bbd8012cd711374f3fdb94efc (diff)
Add doc about the new motion service.
Diffstat (limited to 'doc/MotionService.md')
-rw-r--r--doc/MotionService.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/MotionService.md b/doc/MotionService.md
new file mode 100644
index 0000000..0d0a551
--- /dev/null
+++ b/doc/MotionService.md
@@ -0,0 +1,17 @@
+# Motion Service
+## Introduction
+The motion service exposes step count and raw X/Y/Z motion value as READ and NOTIFY characteristics.
+
+## Service
+The service UUID is **00020000-78fc-48fe-8e23-433b3a1942d0**
+
+## Characteristics
+### Step count (UUID 00020001-78fc-48fe-8e23-433b3a1942d0)
+The current number of steps represented as a single `uint32_t` (4 bytes) value.
+
+### Raw motion values (UUID 00020002-78fc-48fe-8e23-433b3a1942d0)
+The current raw motion values. This is a 3 `int16_t` array:
+
+ - [0] : X
+ - [1] : Y
+ - [2] : Z