Skip to content

Commit 9ce9f87

Browse files
committed
cross link accelerometer pages
1 parent 50af631 commit 9ce9f87

File tree

4 files changed

+23
-19
lines changed

4 files changed

+23
-19
lines changed

docs/code/api_reference/devices/accelerometers.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# accelerometers API Reference
22

3-
Config Reference:
4-
5-
* [accelerometers:](../../../config/accelerometers.md)
6-
73
`self.machine.accelerometers.*`
84

95
``` python
@@ -53,3 +49,8 @@ Subscribe to an attribute.
5349
`update_acceleration(x: float, y: float, z: float) → None`
5450

5551
Calculate acceleration based on readings from hardware.
52+
53+
## Related Pages:
54+
55+
* [Accelerometers](../../../mechs/accelerometers.md)
56+
* [accelerometers: Config Reference](../../../config/accelerometers.md)

docs/config/accelerometers.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,9 @@ Name of this device in service mode.
157157
List of one (or more) values, each is a type: `string`. Defaults to
158158
empty.
159159

160-
--8<-- "todo.md"
161-
162-
## Related How To guides
160+
## Related Pages:
163161

164162
* [Accelerometers](../mechs/accelerometers.md)
163+
* [accelerometers API Reference](../code/api_reference/devices/accelerometers.md)
164+
* [How to configure the accelerometer (P3-ROC)](../hardware/multimorphic/accelerometer.md)
165+
* [MMA8451-based I2C accelerometers](../hardware/mma8451.md)

docs/hardware/multimorphic/accelerometer.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@ title: How to configure the accelerometer (P3-ROC)
44

55
# How to configure the accelerometer (P3-ROC)
66

7-
8-
Related Config File Sections:
9-
10-
* [accelerometers:](../../config/accelerometers.md)
11-
127
THe P3-ROC includes an accelerometer which you can use with MPF to
138
detect g-force changes (to use as a tilt) as well as 3-axis leveling (to
149
use to determine whether the machine is level).
@@ -32,5 +27,10 @@ the documentation.
3227
3328
## What if it did not work?
3429
35-
Have a look at our
36-
[troubleshooting guide for the P/P3-Roc](../../troubleshooting/index.md).
30+
Have a look at our [troubleshooting guide for the P/P3-Roc](../../troubleshooting/index.md).
31+
32+
## Related Pages:
33+
34+
* [accelerometers: Config Reference](../../config/accelerometers.md)
35+
* [accelerometers API Reference](../../code/api_reference/devices/accelerometers.md)
36+
* [Accelerometers](../../mechs/accelerometers.md)

docs/mechs/accelerometers.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@ title: Accelerometers
44

55
# Accelerometers
66

7-
8-
Related Config File Sections:
9-
10-
* [accelerometers:](../config/accelerometers.md)
11-
127
An accelerometer is a device that measures proper acceleration; proper
138
acceleration is not the same as coordinate acceleration (rate of change
149
of velocity). For example, an accelerometer at rest on the surface of
@@ -46,3 +41,10 @@ A three-item tuple (x, y, z) of the current accelerometer values.
4641

4742
Varies based on the configured (you can configure events to be
4843
emitted when certain G-force thresholds are exceeded).
44+
45+
## Related Pages:
46+
47+
* [accelerometers: Config Reference](../config/accelerometers.md)
48+
* [accelerometers API Reference](../code/api_reference/devices/accelerometers.md)
49+
* [How to configure the accelerometer (P3-ROC)](../hardware/multimorphic/accelerometer.md)
50+
* [MMA8451-based I2C accelerometers](../hardware/mma8451.md)

0 commit comments

Comments
 (0)