mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-28 23:19:47 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #898 from meshtastic/paxcounter-docs

Browse source 
Documentation for Paxcounter
This commit is contained in:
rcarteraz 2023-12-17 11:10:45 -07:00 committed by GitHub
parent 45a1e4e5f2 79f4538a56
commit fd6dad575f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 81 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/configuration/module/index.mdx
View file

@ -17,6 +17,7 @@ Modules are included in the firmware and allow users to extend the functionality
| [External Notification](/docs/configuration/module/external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc). | | [External Notification](/docs/configuration/module/external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc). |
| [MQTT](/docs/configuration/module/mqtt) | Forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on another mesh over the internet. | | [MQTT](/docs/configuration/module/mqtt) | Forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on another mesh over the internet. |
| [Neighbor Info](/docs/configuration/module/neighbor-info) | Send info on 0-hop neighbors to the mesh. | | [Neighbor Info](/docs/configuration/module/neighbor-info) | Send info on 0-hop neighbors to the mesh. |
| [Paxcounter](/docs/configuration/module/paxcounter) | Count the number of BLE and Wifi devices passing by a node. |
| [Range Test](/docs/configuration/module/range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. | | [Range Test](/docs/configuration/module/range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. |
| [Remote Hardware](/docs/configuration/module/remote-hardware) | Set and read a GPIO status remotely over the mesh. | | [Remote Hardware](/docs/configuration/module/remote-hardware) | Set and read a GPIO status remotely over the mesh. |
| [Serial Module](/docs/configuration/module/serial) | Send messages across the mesh by sending strings over a serial port. | | [Serial Module](/docs/configuration/module/serial) | Send messages across the mesh by sending strings over a serial port. |

80
docs/configuration/module/paxcounter.mdx Normal file
View file

@ -0,0 +1,80 @@
---
id: paxcounter
title: Paxcounter Module Usage
sidebar_label: Paxcounter
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
The Paxcounter module counts the number of people passing by a specific area. It is commonly used in retail stores, museums, and other public spaces to monitor foot traffic and gather valuable data for analysis.
In order to use this module, make sure your devices have firmware version 2.2.17 or higher.
## Paxcounter Module Config Values
### Enabled
Whether the Module is enabled.
### Update Interval
The interval in seconds of how often we can send a message to the mesh when a state change is detected.
## Paxcounter Module Client Availability
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
:::info
No Paxcounter Module config options are available for Android.
:::
</TabItem>
<TabItem value="apple">
:::info
No Paxcounter Module config options are available on the iOS, iPadOS and macOS app.
:::
</TabItem>
<TabItem value="cli">
:::info
All Paxcounter Module config options are available in the python CLI version 2.2.16 and higher.
:::
Example commands are below:
```shell title="Enable/Disable the Paxcounter Module"
meshtastic --set paxcounter.enabled true
meshtastic --set paxcounter.enabled false
```
```shell title="Set the Minimum Broadcast Interval to 90 seconds"
meshtastic --set paxcounter.paxcounter_update_interval 900
```
```shell title="Get the Paxcounter Module Configuration"
meshtastic --get paxcounter
```
</TabItem>
<TabItem value="web">
:::info
No Paxcounter module config options are available in the Web UI.
:::
</TabItem>
</Tabs>