summaryrefslogtreecommitdiff
path: root/doc/MotionService.md
diff options
context:
space:
mode:
authorKieran Cawthray <kieranc@gmail.com>2021-11-07 17:49:54 +0100
committerKieran Cawthray <kieranc@gmail.com>2021-11-07 17:49:54 +0100
commit18e3cc7038d0f6c0cebc5d042e0740f968f890db (patch)
tree4fd50ddece4d92c06ea0e16cc06902703a2b6202 /doc/MotionService.md
parent85d494a987e8edfd51fbb0eb6dfa04ea108cbb48 (diff)
parent4a5b5f954f12de1574af8e3efec094bb4bdbb542 (diff)
Merge remote-tracking branch 'upstream/develop' into pts-settings
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