summaryrefslogtreecommitdiff
path: root/doc/MotionService.md
diff options
context:
space:
mode:
authorKieran Cawthray <kieranc@gmail.com>2022-09-05 22:03:56 +0200
committerKieran Cawthray <kieranc@gmail.com>2022-09-05 22:03:56 +0200
commit293340515812b15030b6497a3eed1b1b8fceadae (patch)
treea46c96953676a756723477a363a5eedafbbd3dd1 /doc/MotionService.md
parent593ca2028d77c013fa4026a7183b7f66f2cca5ba (diff)
parentf53e75063b6ef618d65a1f287df52ba01c3351f5 (diff)
Merge remote-tracking branch 'upstream/develop' into pts-options
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