summaryrefslogtreecommitdiff
path: root/doc/MotionService.md
diff options
context:
space:
mode:
authorRiku Isokoski <riksu9000@gmail.com>2022-08-21 14:50:09 +0300
committerGitHub <noreply@github.com>2022-08-21 14:50:09 +0300
commitc2b6a8de3e15fa66d48a373b3504fcebf12d905b (patch)
tree53e019a0a47d69092dbd02b2a216b66f05a88581 /doc/MotionService.md
parentc495db8a71675fac3f48f8421b3035b318c3dd82 (diff)
Fix markdown format with autoformatter (#1284)
Diffstat (limited to 'doc/MotionService.md')
-rw-r--r--doc/MotionService.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/MotionService.md b/doc/MotionService.md
index 7cec3fba..429794ac 100644
--- a/doc/MotionService.md
+++ b/doc/MotionService.md
@@ -1,17 +1,23 @@
# 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 **00030000-78fc-48fe-8e23-433b3a1942d0**
## Characteristics
+
### Step count (UUID 00030001-78fc-48fe-8e23-433b3a1942d0)
+
The current number of steps represented as a single `uint32_t` (4 bytes) value.
### Raw motion values (UUID 00030002-78fc-48fe-8e23-433b3a1942d0)
+
The current raw motion values. This is a 3 `int16_t` array:
- - [0] : X
- - [1] : Y
- - [2] : Z
+- [0] : X
+- [1] : Y
+- [2] : Z