diff --git a/docs/configuration/module/index.mdx b/docs/configuration/module/index.mdx index 94ccbab8..3877b2fa 100644 --- a/docs/configuration/module/index.mdx +++ b/docs/configuration/module/index.mdx @@ -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). | | [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. | +| [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. | | [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. | diff --git a/docs/configuration/module/paxcounter.mdx b/docs/configuration/module/paxcounter.mdx new file mode 100644 index 00000000..3208fd95 --- /dev/null +++ b/docs/configuration/module/paxcounter.mdx @@ -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 + + + + +:::info +No Paxcounter Module config options are available for Android. +::: + + + + +:::info +No Paxcounter Module config options are available on the iOS, iPadOS and macOS app. +::: + + + + +:::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 +``` + + + +:::info + +No Paxcounter module config options are available in the Web UI. + +::: + + \ No newline at end of file