DigitalInfinity/ESP32-PaxCounter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add sd syslogging to documentation

Browse Source
This commit is contained in:
cyberman54 2022-11-27 22:45:31 +01:00
parent b8c87f0acf
commit fc0bc9b5ea
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/configuration/index.md
View File

@ -51,8 +51,8 @@ Output of sensor and peripheral data is internally switched by a bitmask registe
\*) GPS data can also be combined with paxcounter payload on port 1, `#define GPSPORT 1` in paxcounter.conf to enable \*) GPS data can also be combined with paxcounter payload on port 1, `#define GPSPORT 1` in paxcounter.conf to enable
```c linenums="101" title="src/paxcounter_orig.conf" ```c linenums="102" title="src/paxcounter_orig.conf"
--8<-- "src/paxcounter_orig.conf:101:101" --8<-- "src/paxcounter_orig.conf:102:102"
``` ```
@ -60,8 +60,8 @@ Output of sensor and peripheral data is internally switched by a bitmask registe
Paxcounter supports a battery friendly power saving mode. In this mode the device enters deep sleep, after all data is polled from all sensors and the dataset is completeley sent through all user configured channels (LORAWAN / SPI / MQTT / SD-Card). Set `#define SLEEPCYCLE` in paxcounter.conf to enable power saving mode and to specify the duration of a sleep cycle. Paxcounter supports a battery friendly power saving mode. In this mode the device enters deep sleep, after all data is polled from all sensors and the dataset is completeley sent through all user configured channels (LORAWAN / SPI / MQTT / SD-Card). Set `#define SLEEPCYCLE` in paxcounter.conf to enable power saving mode and to specify the duration of a sleep cycle.
```c linenums="18" title="src/paxcounter_orig.conf" ```c linenums="20" title="src/paxcounter_orig.conf"
--8<-- "src/paxcounter_orig.conf:18:18" --8<-- "src/paxcounter_orig.conf:20:20"
``` ```
@ -73,8 +73,8 @@ Paxcounter supports a battery friendly power saving mode. In this mode the devic
Paxcounter can keep a time-of-day synced with external or on board time sources. Set `#define TIME_SYNC_INTERVAL` in `paxcounter.conf` to enable time sync. Paxcounter can keep a time-of-day synced with external or on board time sources. Set `#define TIME_SYNC_INTERVAL` in `paxcounter.conf` to enable time sync.
```c linenums="19" title="src/paxcounter_orig.conf" ```c linenums="88" title="src/paxcounter_orig.conf"
--8<-- "src/paxcounter_orig.conf:87:87" --8<-- "src/paxcounter_orig.conf:88:88"
``` ```
Supported external time sources are GPS, LORAWAN network time and LORAWAN application timeserver time. Supported on board time sources are the RTC of ESP32 and a DS3231 RTC chip, both are kept sycned as fallback time sources. Time accuracy depends on board's time base which generates the pulse per second. Supported are GPS PPS, SQW output of RTC, and internal ESP32 hardware timer. Time base is selected by #defines in the board's hal file, see example in [`generic.h`](https://github.com/cyberman54/ESP32-Paxcounter/blob/master/src/hal/generic.h). Supported external time sources are GPS, LORAWAN network time and LORAWAN application timeserver time. Supported on board time sources are the RTC of ESP32 and a DS3231 RTC chip, both are kept sycned as fallback time sources. Time accuracy depends on board's time base which generates the pulse per second. Supported are GPS PPS, SQW output of RTC, and internal ESP32 hardware timer. Time base is selected by #defines in the board's hal file, see example in [`generic.h`](https://github.com/cyberman54/ESP32-Paxcounter/blob/master/src/hal/generic.h).
@ -96,8 +96,8 @@ Paxcounter can be used to sync a wall clock which has a DCF77 or IF482 time tele
This describes how to set up a mobile PaxCounter:<br> Follow all steps so far for preparing the device, selecting the packed payload format. In `paxcounter.conf` set `PAYLOAD_OPENSENSEBOX` to `1`. This describes how to set up a mobile PaxCounter:<br> Follow all steps so far for preparing the device, selecting the packed payload format. In `paxcounter.conf` set `PAYLOAD_OPENSENSEBOX` to `1`.
```c linenums="59" title="src/paxcounter_orig.conf" ```c linenums="60" title="src/paxcounter_orig.conf"
--8<-- "src/paxcounter_orig.conf:59:59" --8<-- "src/paxcounter_orig.conf:60:60"
``` ```
Register a new sensebox on [https://opensensemap.org/](https://opensensemap.org). In the sensor configuration select "TheThingsNetwork" and set decoding profile to "LoRa serialization". Enter your TTN Application and Device ID. Setup decoding option using: Register a new sensebox on [https://opensensemap.org/](https://opensensemap.org). In the sensor configuration select "TheThingsNetwork" and set decoding profile to "LoRa serialization". Enter your TTN Application and Device ID. Setup decoding option using:
@ -140,3 +140,9 @@ File contents example:
2022-01-30T21:17:52Z,11,26[,4076] 2022-01-30T21:17:52Z,11,26[,4076]
``` ```
If you want to change this, modify `src/sdcard.cpp` and `include/sdcard.h`. If you want to change this, modify `src/sdcard.cpp` and `include/sdcard.h`.
Additionally, it's possible to redirect system console output to a plain text file on SD card. This can be useful for debugging headless devices in the field. In `paxcounter.conf` set `SDLOGGING` to `1`.
```c linenums="16" title="src/paxcounter_orig.conf"
--8<-- "src/paxcounter_orig.conf:16:16"
```