summaryrefslogtreecommitdiff
path: root/doc/MotionService.md
diff options
context:
space:
mode:
authorJF <JF002@users.noreply.github.com>2021-10-24 20:06:52 +0200
committerGitHub <noreply@github.com>2021-10-24 20:06:52 +0200
commit82ca526ec2db11d9e4aa2d91cd69ed2394e3a843 (patch)
treeaf91df7395abd8bed0d12c276b3703f46cbfadfd /doc/MotionService.md
parent9538eb97166410ebc362addfb76ec54895491cd7 (diff)
parentb3a82288997556b04a64d452ec2067747f1fb706 (diff)
Merge pull request #754 from InfiniTimeOrg/add-motion-service
Add 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 00000000..0d0a5514
--- /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