meshtastic/docs/configuration/module/detection-sensor.mdx

139 lines
4 KiB
Plaintext
Raw Normal View History

2023-09-01 16:25:17 -07:00
---
id: detection-sensor
title: Detection Sensor Module Usage
sidebar_label: Detection Sensor
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
The Detection Sensor module allows you to configure a GPIO pin to be monitored for a specified high/low status and send text alerts over the Detection Sensor portnum when an event is detected. This is particularly useful for motion detection sensors, reed switches, and other open / closed state systems in which notifications over the mesh are desired. Config options are: Enabled, Minimum Broadcast Interval, State Broadcast Interval, Send Bell, Name, Monitor Pin, Detection Triggered High, and Use Pull-up.
In order to use this module, make sure your devices have firmware version 2.2.2 or higher.
## Detection Sensor Module Config Values
### Enabled
Whether the Module is enabled.
### Minimum Broadcast Interval
The interval in seconds of how often we can send a message to the mesh when a state change is detected.
### State Broadcast Interval
The interval in seconds of how often we should send a message to the mesh with the current state regardless of changes, When set to 0, only state changes will be broadcasted, Works as a sort of status heartbeat for peace of mind.
### Send Bell
Send ASCII bell with alert message. Useful for triggering ext. notification on bell
name.
### Friendly Name
Used to format the message sent to mesh. Example: A name "Motion" would result in a message "Motion detected". Maximum length of 20 characters.
### Monitor Pin
The GPIO pin to monitor for state changes.
### Detection Triggered High
Whether or not the GPIO pin state detection is triggered on HIGH (1), otherwise LOW (0).
### Use Pull-up
Whether or not use INPUT_PULLUP mode for GPIO pin. Only applicable if the board uses pull-up resistors on the pin.
## Detection Sensor 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
All Detection Sensor Module config options are available for Android in app version 2.2.2 and higher.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Detection Sensor**
:::
</TabItem>
<TabItem value="apple">
2023-09-10 21:38:07 -07:00
:::info
2023-09-01 16:32:35 -07:00
All Detection Sensor Module config options are available on iOS, iPadOS and macOS app versions 2.2.2 and higher at Settings > Modules > Detection Sensor
2023-09-10 21:38:07 -07:00
:::
2023-09-01 16:25:17 -07:00
</TabItem>
<TabItem value="cli">
:::info
All Detection Sensor Module config options are available in the python CLI version 2.2.2 and higher.
:::
Example commands are below:
```shell title="Enable/Disable the Detection Sensor Module"
meshtastic --set detection_sensor.enabled true
meshtastic --set detection_sensor.enabled false
```
```shell title="Set the Minimum Broadcast Interval to 90 seconds"
meshtastic --set detection_sensor.minimum_broadcast_secs 90
```
```shell title="Set the State Broadcast Interval to 5 minutes"
meshtastic --set detection_sensor.state_broadcast_secs 300
```
```shell title="Enable/Disable Send Bell"
meshtastic --set detection_sensor.send_bell true
meshtastic --set detection_sensor.send_bell false
```
```shell title="Set the friendly name to 'motion'"
meshtastic --set detection_sensor.name "motion"
```
```shell title="Set the Monitor Pin to 7"
meshtastic --set detection_sensor.monitor_pin 7
```
```shell title="Enable Notifications when the Monitor Pin goes HIGH"
2023-10-03 07:50:09 -07:00
meshtastic --set detection_sensor.detection_triggered_high true
2023-09-01 16:25:17 -07:00
```
```shell title="Enable Notifications when the Monitor Pin goes LOW"
2023-10-03 07:50:09 -07:00
meshtastic --set detection_sensor.detection_triggered_high false
2023-09-01 16:25:17 -07:00
```
```shell title="Enable the use INPUT_PULLUP mode"
meshtastic --set detection_sensor.use_pullup true
```
```shell title="Get the Detection Sensor Module Configuration"
meshtastic --get detection_sensor
```
</TabItem>
<TabItem value="web">
2023-11-08 09:13:24 -08:00
:::info
All Detection Sensor module config options are available in the Web UI.
2023-09-01 16:25:17 -07:00
2023-11-08 09:13:24 -08:00
:::
2023-09-01 16:25:17 -07:00
</TabItem>
2023-10-03 07:50:09 -07:00
</Tabs>