Skip to content

Commit 9880a75

Browse files
committed
Edit examples read me
1 parent 2e3da38 commit 9880a75

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Diff for: examples/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
# LIS3DH Examples #
22

3-
All examples are configured to run on an [impExplorer Kit](https://developer.electricimp.com/hardware/resources/reference-designs/explorerkit). Each example shows simple usage of the accelerometer interrupts. All code runs on the device side only, no agent code is needed.
3+
All examples are configured to run on an [impExplorer Kit](https://store.electricimp.com/collections/getting-started/products/impexplorer-developer-kit?variant=31118866130). Each example shows simple usage of the accelerometer interrupts. All code runs on the device side only, no agent code is needed.
44

55
## Click Interrupt ##
66

7-
This example configures a double click interrupt. The device will create a log each time a double click event is captured.
7+
This example configures a double-click interrupt. The device will create a log each time a double-click event is captured.
88

99
### Device Code ###
1010

11-
Copy and paste the [code](./simpleClickInterrupt.example.device.nut) into the device coding window in impCentral.
11+
Copy and paste the [code](./simpleClickInterrupt.example.device.nut) into the device coding window in impCentral.
1212

13-
## Free Fall Interrupt ##
13+
## Free-fall Interrupt ##
1414

15-
This example shows how to put the imp into deep sleep and configure wakes based on a timer expiring or a free fall event condition detection. When the device wakes on a timer it will take and log a reading. If a free fall event is detected it will log the event. A free fall event can be triggered by throwing the device in the air.
15+
This example shows how to put an imp into deep sleep and configure wakes based on the firing of a timer or a free-fall event condition detection. When the device wakes on a timer it will take and log a reading. If a free-fall event is detected it will log the event. A free-fall event can be triggered by throwing the device up in the air.
1616

1717
### Device Code ###
1818

1919
Copy and paste the [code](./simpleFreefallInterrupt.example.device.nut) into the device coding window in impCentral.
2020

2121
## FIFO Streaming Interrupt ##
2222

23-
This example configures the FIFO buffer in streaming mode and also configures a FIFO watermark interrupt that triggers when the buffer is almost full. When the interrupt is triggered the readings in the buffer will be checked and logged in a quick burst, preventing a buffer overflow. The stream & interrupt are stopped after a set time, since this example creates numerous logs.
23+
This example configures the FIFO buffer in streaming mode and also configures a FIFO watermark interrupt that triggers when the buffer is almost full. When the interrupt is triggered, the readings in the buffer will be checked and logged in a quick burst, preventing a buffer overflow. The stream and interrupt are stopped after a set time, since this example creates many log entries.
2424

2525
### Device Code ###
2626

2727
Copy and paste the [code](./simpleFIFOStream.example.device.nut) into the device coding window in impCentral.
2828

29-
## Motion & Impact Monitoring ##
29+
## Motion And Impact Monitoring ##
3030

31-
This example configures the FIFO buffer, a high pass filter and an inertial interrupt. The high pass filter and inertial interrupt are configured to trigger an interrupt when movement is detected. When the interrupt is triggered the FIFO buffer will fill up, storing readings immediately after the motion event was detected. The interrupt handler then looks for the maximum reading captured in the stored readings from the FIFO buffer before clearing and resetting the buffer.
31+
This example configures the FIFO buffer, a high-pass filter and an inertial interrupt. The high-pass filter and inertial interrupt are configured to trigger an interrupt when movement is detected. When the interrupt is triggered, the FIFO buffer will fill up, storing readings immediately after the motion event was detected. The interrupt handler then looks for the maximum reading captured in the stored readings from the FIFO buffer before clearing and resetting the buffer.
3232

3333
### Device Code ###
3434

0 commit comments

Comments
 (0)