From a21c3d3b11524e6104cce36199fe88180762abee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Thu, 9 Feb 2017 21:01:47 +0100 Subject: [PATCH] Fix markdown syntax --- docs/en/modules/rtcfifo.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/en/modules/rtcfifo.md b/docs/en/modules/rtcfifo.md index 489cb57b..8e712cf0 100644 --- a/docs/en/modules/rtcfifo.md +++ b/docs/en/modules/rtcfifo.md @@ -4,6 +4,7 @@ | 2015-06-26 | [DiUS](https://github.com/DiUS), [Johny Mattsson](https://github.com/jmattsson), Bernd Meyer | [Johny Mattsson](https://github.com/jmattsson) | [rtcfifo.c](../../../app/modules/rtcfifo.c)| The rtcfifo module implements a first-in,first-out storage intended for sensor readings. As the name suggests, it is backed by the [RTC](https://en.wikipedia.org/wiki/Real-time_clock) user memory and as such survives deep sleep cycles. Conceptually it can be thought of as a cyclic array of `{ timestamp, name, value }` tuples. Internally it uses a space-optimized storage format to allow the greatest number of samples to be kept. This comes with several trade-offs, and as such is not a one-solution-fits-all. Notably: + - Timestamps are stored with second-precision. - Sample frequency must be at least once every 8.5 minutes. This is a side-effect of delta-compression being used for the time stamps. - Values are limited to 16 bits of precision, but have a separate field for storing an E-n multiplier. This allows for high fidelity even when working with very small values. The effective range is thus 1E-7 to 65535. @@ -110,17 +111,13 @@ This function takes an optional configuration table as an argument. The followin ```lua -- Initialize with default values rtcfifo.prepare() -``` -```lua -- Use RTC slots 19 and up for variable storage rtcfifo.prepare({storage_begin=21, storage_end=128}) ``` ####See also -[`rtcfifo.ready()`](#rtcfifoready) - -####See also -[`rtcfifo.prepare()`](#rtcfifoprepare) +- [`rtcfifo.ready()`](#rtcfifoready) +- [`rtcfifo.prepare()`](#rtcfifoprepare) ## rtcfifo.put()