mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-28 06:59:45 -08:00
Merge branch 'master' into nodered-update-1
This commit is contained in:
Pablo Vitasso
GitHub
commit
3506759cb7
|
|
@ -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
80
docs/configuration/module/paxcounter.mdx
Normal 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>
|
||||||
|
|
@ -17,25 +17,29 @@ Sets the role of the node.
|
||||||
|
|
||||||
Acceptable values:
|
Acceptable values:
|
||||||
|
|
||||||
| Value | Description |
|
| Value | Description |
|
||||||
| :-------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|:----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||||
| `CLIENT` | Client (default) - This role will follow the standard routing rules while also allowing the device to interact with client applications via BLE/Wi-Fi (Android/Apple/Web). |
|
| `CLIENT` | Client (default) - This role will follow the standard routing rules while also allowing the device to interact with client applications via BLE/Wi-Fi (Android/Apple/Web). |
|
||||||
| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. |
|
| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. |
|
||||||
| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The BLE/Wi-Fi radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. |
|
| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The BLE/Wi-Fi radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. |
|
||||||
| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. BLE/Wi-Fi and OLED screen will not be put to sleep. |
|
| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. BLE/Wi-Fi and OLED screen will not be put to sleep. |
|
||||||
| `REPEATER` | Repeater - Mesh packets will prefer to be routed over this node. This role eliminates unnecessary overhead such as NodeInfo, DeviceTelemetry, and any other mesh packet, resulting in the device not appearing as part of the network. As such, direct messaging this node is not available, as it will not appear in your nodes list which results in a cleaner mesh network. Channel and modem settings of the mesh packets being repeated must be identical to the repeater's configuration. Please see Rebroadcast Mode for additional settings specific to this role. |
|
| `REPEATER` | Repeater - Mesh packets will prefer to be routed over this node. This role eliminates unnecessary overhead such as NodeInfo, DeviceTelemetry, and any other mesh packet, resulting in the device not appearing as part of the network. As such, direct messaging this node is not available, as it will not appear in your nodes list which results in a cleaner mesh network. Channel and modem settings of the mesh packets being repeated must be identical to the repeater's configuration. Please see Rebroadcast Mode for additional settings specific to this role. |
|
||||||
| `TRACKER` | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority. Smart Position Broadcast will default to the currently configured settings. When used in conjunction with power.is_power_saving = true, nodes will wake up, send position, and then sleep for position.position_broadcast_secs seconds. |
|
| `TRACKER` | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority. Smart Position Broadcast will default to the currently configured settings. When used in conjunction with power.is_power_saving = true, nodes will wake up, send position, and then sleep for position.position_broadcast_secs seconds. |
|
||||||
| `SENSOR` | Sensor - For use with devices intended to primarily collect sensor readings. Telemetry packets sent from this device will be higher priority, broadcasting every five minutes. When used in conjunction with power.is_power_saving = true, nodes will wake up, send environment telemetry, and then sleep for telemetry.environment_update_interval seconds. |
|
| `SENSOR` | Sensor - For use with devices intended to primarily collect sensor readings. Telemetry packets sent from this device will be higher priority, broadcasting every five minutes. When used in conjunction with power.is_power_saving = true, nodes will wake up, send environment telemetry, and then sleep for telemetry.environment_update_interval seconds. |
|
||||||
|
| `TAK` | TAK - Used for nodes dedicated for connection to an ATAK EUD. Turns off many of the routine broadcasts to favor CoT packet stream from the Meshtastic ATAK plugin -> IMeshService -> Node. |
|
||||||
|
| `CLIENT_HIDDEN` | Client Hidden - Used for nodes that "only speak when spoken to." Turns off all of the routine broadcasts but allows for ad-hoc communication. Still rebroadcasts, but with local only rebroadcast mode (known meshes only). Can be used for clandestine operation or to dramatically reduce airtime / power consumption |
|
||||||
|
| `LOST_AND_FOUND` | Lost and Found - Used to automatically send a text message to the mesh with the current position of the device on a frequent interval: "I'm lost! Position: lat / long" |
|
||||||
|
|
||||||
### Rebroadcast Mode
|
### Rebroadcast Mode
|
||||||
|
|
||||||
This setting defines the device's behavior for how messages are rebroadcasted.
|
This setting defines the device's behavior for how messages are rebroadcasted.
|
||||||
|
|
||||||
| Value | Description |
|
| Value | Description |
|
||||||
| :-----------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|:-------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||||
| `ALL` | ALL (Default) - This setting will rebroadcast ALL messages from its primary mesh as well as other meshes with the same modem settings, including when encryption settings differ. |
|
| `ALL` | ALL (Default) - This setting will rebroadcast ALL messages from its primary mesh as well as other meshes with the same modem settings, including when encryption settings differ. |
|
||||||
| `ALL_SKIP_DECODING` | ALL_SKIP_DECODING - Same as behavior as ALL, but skips packet decoding and simply rebroadcasts them. **Only available with Repeater role.** |
|
| `ALL_SKIP_DECODING` | ALL_SKIP_DECODING - Same as behavior as ALL, but skips packet decoding and simply rebroadcasts them. **Only available with Repeater role.** |
|
||||||
| `LOCAL_ONLY` | LOCAL_ONLY - Ignores observed messages from foreign meshes that are open or those which it cannot decrypt. Only rebroadcasts message on the nodes local primary / secondary channels. |
|
| `LOCAL_ONLY` | LOCAL_ONLY - Ignores observed messages from foreign meshes that are open or those which it cannot decrypt. Only rebroadcasts message on the nodes local primary / secondary channels. |
|
||||||
|
| `KNOWN_ONLY` | KNOWN_ONLY - Ignores observed messages from foreign meshes like LOCAL_ONLY, but takes it a step further by also ignoring messages from nodenums not in the node's known list (NodeDB). |
|
||||||
|
|
||||||
### Serial Console
|
### Serial Console
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue