small docs updates
This commit is contained in:
Tim Huyeng
parent
e17bd59f58
commit
ccfc20a140
@ -9,13 +9,21 @@ Compile time configuration is spread across several files. Before compiling the
|
||||
## platformio.ini
|
||||
Edit `platformio_orig.ini` (for ESP32 CPU based boards) *or* `platformio_orig_s3.ini` (for ESP32-S3 CPU based boards) and select desired board in section **board**. To add a new board, create an appropriate hardware abstraction layer file in hal subdirectory, and add a pointer to this file in section **board**. Copy or rename to `platformio.ini` in the root directory of the project. Now start Platformio.
|
||||
|
||||
``` bash title="Copy with terminal"
|
||||
cp platformio_orig.ini platformio.ini
|
||||
```
|
||||
|
||||
!!! info
|
||||
|
||||
Note: Platformio is looking for `platformio.ini` in the root directory and won't start if it does not find this file!
|
||||
Platformio is looking for `platformio.ini` in the root directory and won't start if it does not find this file!
|
||||
|
||||
## paxcounter.conf
|
||||
Edit `src/paxcounter_orig.conf` and tailor settings in this file according to your needs and use case. Please take care of the duty cycle regulations of the LoRaWAN network you're going to use. Copy or rename to `src/paxcounter.conf`.
|
||||
|
||||
``` bash title="Copy with terminal"
|
||||
cp src/paxcounter_orig.conf src/paxcounter.conf
|
||||
```
|
||||
|
||||
If your device has a **real time clock** it can be updated by either LoRaWAN network or GPS time, according to settings *TIME_SYNC_INTERVAL* and *TIME_SYNC_LORAWAN* in `paxcounter.conf`.
|
||||
|
||||
## src/lmic_config.h
|
||||
@ -24,12 +32,19 @@ Edit `src/lmic_config.h` and tailor settings in this file according to your coun
|
||||
## src/loraconf.h
|
||||
Create file `src/loraconf.h` using the template [src/loraconf_sample.h](https://github.com/cyberman54/ESP32-Paxcounter/blob/master/src/loraconf_sample.h) and adjust settings to use your personal values. To join the network and activate your paxcounter, you must configure either OTAA or ABP join method. You should use OTAA, whenever possible. To understand the differences of the two methods, [this article](https://www.thethingsnetwork.org/docs/devices/registration.html) may be useful.
|
||||
|
||||
``` bash title="Copy with terminal"
|
||||
cp src/loraconf_sample.h src/loraconf.h
|
||||
```
|
||||
|
||||
To configure OTAA, leave `#define LORA_ABP` deactivated (commented). To use ABP, activate (uncomment) `#define LORA_ABP` in the file `src/loraconf.h`.
|
||||
The file `src/loraconf_sample.h` contains more information about the values to provide.
|
||||
|
||||
## src/ota.conf
|
||||
Create file `src/ota.conf` using the template [src/ota_sample.conf](https://github.com/cyberman54/ESP32-Paxcounter/blob/master/src/ota_sample.conf) and enter your WIFI network&key. These settings are used for downloading updates via WiFi, either from a remote https server, or locally via WebUI. If you want to use a remote server, you need a <A HREF="https://github.com/paxexpress/docs">PAX.express repository</A>. Enter your PAX.express credentials in ota.conf. If you don't need wireless firmware updates just rename ota.sample.conf to ota.conf.
|
||||
|
||||
``` bash title="Copy with terminal"
|
||||
cp src/ota_sample.conf src/ota.conf
|
||||
```
|
||||
# Building
|
||||
|
||||
Use <A HREF="https://platformio.org/">PlatformIO</A> with your preferred IDE for development and building this code. Make sure you have latest PlatformIO version.
|
||||
|
||||
@ -27,11 +27,12 @@ LoLin32lite + [LoraNode32-Lite shield](https://github.com/hallard/LoLin32-Lite-L
|
||||
*) supports microSD/TF-card for local logging of paxcounter data
|
||||
|
||||
Depending on board hardware following features are supported:
|
||||
|
||||
- LoRaWAN communication, supporting various payload formats (see enclosed .js converters)
|
||||
- MQTT communication via TCP/IP and Ethernet interface (note: payload transmitted over MQTT will be base64 encoded)
|
||||
- SPI serial communication to a local host
|
||||
- LED (shows power & status)
|
||||
- OLED Display (shows detailed status)
|
||||
- [LED](display-led.md) (shows power & status)
|
||||
- [OLED Display](display-led.md) (shows detailed status)
|
||||
- RGB LED (shows colorized status)
|
||||
- Button (short press: flip display page / long press: send alarm message)
|
||||
- Battery voltage monitoring (analog read / AXP192 / IP5306)
|
||||
@ -46,14 +47,18 @@ Depending on board hardware following features are supported:
|
||||
Target platform must be selected in `platformio.ini`.<br>
|
||||
Hardware dependent settings (pinout etc.) are stored in board files in [/hal](https://github.com/cyberman54/ESP32-Paxcounter/tree/master/src/hal) directory. If you want to use a ESP32 board which is not yet supported, use hal file generic.h and tailor pin mappings to your needs. Pull requests for new boards welcome.<br>
|
||||
|
||||
Some <b>3D printable cases</b> can be found (and, if wanted so, ordered) on Thingiverse, see
|
||||
<A HREF="https://www.thingiverse.com/thing:2670713">Heltec</A>,
|
||||
<A HREF="https://www.thingiverse.com/thing:2811127">TTGOv2</A>,
|
||||
<A HREF="https://www.thingiverse.com/thing:3005574">TTGOv2.1</A>,
|
||||
<A HREF="https://www.thingiverse.com/thing:3385109">TTGO</A>,
|
||||
<A HREF="https://www.thingiverse.com/thing:3041339">T-BEAM</A>,
|
||||
<A HREF="https://www.thingiverse.com/thing:3203177">T-BEAM parts</A>,
|
||||
for example.<br>
|
||||
### 3D printed cases
|
||||
Some 3D printable cases can be found (and, if wanted so, ordered) on Thingiverse, see
|
||||
|
||||
<b>Power consumption</b> was metered at around 450 - 1000mW, depending on board and user settings in paxcounter.conf.
|
||||
By default bluetooth sniffing not installed (#define *BLECOUNTER* 0 in paxcounter.conf). If you enable bluetooth be aware that this goes on expense of wifi sniffing results, because then wifi and bt stack must share the 2,4 GHz RF ressources of ESP32. If you need to sniff wifi and bt in parallel and need best possible results, use two boards - one for wifi only and one for bt only - and add counted results.
|
||||
- <A HREF="https://www.thingiverse.com/thing:2670713">Heltec</A>
|
||||
- <A HREF="https://www.thingiverse.com/thing:2811127">TTGOv2</A>
|
||||
- <A HREF="https://www.thingiverse.com/thing:3005574">TTGOv2.1</A>
|
||||
- <A HREF="https://www.thingiverse.com/thing:3385109">TTGO</A>
|
||||
- <A HREF="https://www.thingiverse.com/thing:3041339">T-BEAM</A>
|
||||
- <A HREF="https://www.thingiverse.com/thing:3203177">T-BEAM parts</A>
|
||||
|
||||
|
||||
### Power consumption
|
||||
|
||||
<b>Power consumption</b> was metered at around 450 - 1000mW, depending on board and user settings in `paxcounter.conf`.
|
||||
By default, bluetooth sniffing not installed (`#define *BLECOUNTER* 0` in `paxcounter.conf`). If you enable bluetooth be aware that this goes on expense of wifi sniffing results, because then wifi and bt stack must share the 2,4 GHz RF ressources of ESP32. If you need to sniff wifi and bt in parallel and need best possible results, use two boards - one for wifi only and one for bt only - and add counted results.
|
||||
|
||||
@ -21,7 +21,8 @@
|
||||
|
||||
Paxcounter is an [ESP32](https://www.espressif.com/en/products/socs/esp32) MCU based device for metering passenger flows in realtime. It counts how many mobile devices are around. This gives an estimation how many people are around. Paxcounter detects Wifi and Bluetooth signals in the air, focusing on mobile devices by evaluating their MAC adresses.
|
||||
|
||||
Intention of this project is to do this without intrusion in privacy: You don't need to track people owned devices, if you just want to count them. Therefore, Paxcounter does not persistenly store MAC adresses and does no kind of fingerprinting the scanned devices.
|
||||
!!! info
|
||||
Intention of this project is to do this without intrusion in privacy: You don't need to track people owned devices, if you just want to count them. Therefore, Paxcounter does not persistenly store MAC adresses and *does no kind of fingerprinting the scanned devices.
|
||||
|
||||
Data can either be be stored on a local SD-card, transferred to cloud using LoRaWAN network (e.g. TheThingsNetwork or Helium) or MQTT over TCP/IP, or transmitted to a local host using serial (SPI) interface.
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
|
||||
!!! info
|
||||
|
||||
Note: If you use this software you do this at your own risk. That means that you alone - not the authors of this software - are responsible for the legal compliance of an application using this or build from this software and/or usage of a device created using this software. You should take special care and get prior legal advice if you plan metering passengers in public areas and/or publish data drawn from doing so.
|
||||
If you use this software you do this at your own risk. That means that you alone - not the authors of this software - are responsible for the legal compliance of an application using this or build from this software and/or usage of a device created using this software. You should take special care and get prior legal advice if you plan metering passengers in public areas and/or publish data drawn from doing so.
|
||||
|
||||
# Privacy disclosure
|
||||
|
||||
|
||||
@ -2,7 +2,8 @@
|
||||
|
||||
The device listenes for remote control commands on LoRaWAN Port 2. Multiple commands per downlink are possible by concatenating them, but must not exceed a maximum of 10 bytes per downlink.
|
||||
|
||||
Note: settings can be stored in NVRAM to make them persistant (reloaded during device startup / restart). To store settings, use command `0x21`.
|
||||
!!! info
|
||||
Settings can be stored in NVRAM to make them persistant (reloaded during device startup / restart). To store settings, use command `0x21`.
|
||||
|
||||
Send for example `83` `86` as Downlink on Port 2 to get battery status and time/date from the device.
|
||||
|
||||
@ -35,17 +36,17 @@ Send for example `83` `86` as Downlink on Port 2 to get battery status and time/
|
||||
|
||||
Example for EU868:
|
||||
|
||||
DataRate Configuration Bit/s
|
||||
0 LoRa: SF12 / 125 kHz 250
|
||||
1 LoRa: SF11 / 125 kHz 440
|
||||
2 LoRa: SF10 / 125 kHz 980
|
||||
3 LoRa: SF9 / 125 kHz 1760
|
||||
4 LoRa: SF8 / 125 kHz 3125
|
||||
5 LoRa: SF7 / 125 kHz 5470
|
||||
6* LoRa: SF7 / 250 kHz 11000
|
||||
7* FSK: 50 kbps 50000
|
||||
DataRate Configuration Bit/s
|
||||
0 LoRa: SF12 / 125 kHz 250
|
||||
1 LoRa: SF11 / 125 kHz 440
|
||||
2 LoRa: SF10 / 125 kHz 980
|
||||
3 LoRa: SF9 / 125 kHz 1760
|
||||
4 LoRa: SF8 / 125 kHz 3125
|
||||
5 LoRa: SF7 / 125 kHz 5470
|
||||
6* LoRa: SF7 / 250 kHz 11000
|
||||
7* FSK: 50 kbps 50000
|
||||
8 .. 14 reserved for future use (RFU)
|
||||
15 ignored (device keeps current setting)
|
||||
15 ignored (device keeps current setting)
|
||||
|
||||
*) not supported by TheThingsNetwork
|
||||
|
||||
|
||||
@ -23,12 +23,12 @@ nav:
|
||||
- Hardware: hardware.md
|
||||
- Getting Started: getting-started.md
|
||||
- Display & LED: display-led.md
|
||||
- Legalnote: legalnote.md
|
||||
- Legal note: legalnote.md
|
||||
- Additions: additions.md
|
||||
- Integrations: integrations.md
|
||||
- Payload Format: payloadformat.md
|
||||
- Remote control: remotecontrol.md
|
||||
- Licence and Credits: license-credits.md
|
||||
- Licence & Credits: license-credits.md
|
||||
- Releases: releases.md
|
||||
|
||||
markdown_extensions:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user