mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-09 23:24:10 -08:00
Merge branch 'master' into remove-announcement
This commit is contained in:
Sacha Weatherstone
GitHub
commit
308c129db4
134
docs/configuration/module-config/detection-sensor.mdx
Normal file
134
docs/configuration/module-config/detection-sensor.mdx
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
---
|
||||
id: detection-sensor
|
||||
title: Detection Sensor Module Usage
|
||||
slug: /settings/moduleconfig/detection-sensor
|
||||
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">
|
||||
|
||||
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
|
||||
|
||||
</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"
|
||||
meshtastic --set detection_sensor.monitor_pin true
|
||||
```
|
||||
|
||||
```shell title="Enable Notifications when the Monitor Pin goes LOW"
|
||||
meshtastic --set detection_sensor.monitor_pin false
|
||||
```
|
||||
|
||||
```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">
|
||||
|
||||
Not yet implemented.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
|
@ -12,6 +12,7 @@ Modules are included in the firmware and allow users to extend the functionality
|
|||
| :------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| [Audio](/docs/settings/moduleconfig/audio) | Enable Support for Codec2 Voice Comms on certain devices. |
|
||||
| [Canned Message](/docs/settings/moduleconfig/canned-message) | Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder. |
|
||||
| [Detection Sensor](/docs/settings/moduleconfig/detection-sensor) | Configure a GPIO pin to be monitored for specified high/low status and send text alerts. |
|
||||
| [External Notification](/docs/settings/moduleconfig/external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc). |
|
||||
| [MQTT](/docs/settings/moduleconfig/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/settings/moduleconfig/neighbor-info) | Send info on 0-hop neighbors to the mesh. |
|
||||
|
|
|
|||
28
docs/software/integrations/atak-plugin.mdx
Normal file
28
docs/software/integrations/atak-plugin.mdx
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
id: integrations-atak-plugin
|
||||
title: ATAK Plugin
|
||||
sidebar_label: ATAK Plugin
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
## Official Meshtastic ATAK Plugin
|
||||
|
||||
Meshtastic can integrate with ATAK on Android using the [Official ATAK Plugin.](https://github.com/meshtastic/ATAK-Plugin)
|
||||
|
||||
### Introduction
|
||||
|
||||
The ATAK plugin does not permit any Meshtastic configuration. The plugin does three things:
|
||||
|
||||
1. Bind to the IMeshService provided by the Meshtastic Android App in order to send.
|
||||
2. Intercept all outgoing ATAK CoT via the ATAK "PreSendProcessor" Interface and send them to the IMeshService.
|
||||
3. Listen for broadcasts from the Meshtastic Android App regarding ATAK_FORWARDER portnum packets.
|
||||
|
||||
The current iteration works very well for ATAK CoT that fit within the 200ish byte range (after we shrink via libcotshirnk) because they fit into a single DataPacket.
|
||||
|
||||
### Instructions
|
||||
|
||||
1. Use the Meshtastic Android App on all party's devices, and ensure they can talk to their local LoRa radio. Confirm they are able to achieve basic text messaging using the App.
|
||||
|
||||
2. With the Meshtastic Android App running in the background (to ensure the IMeshService is alive), launch ATAK (with the Meshtastic ATAK-Plugin installed or install it once ATAK is running) and you should observe a green Meshtastic icon in the bottom right. If the icon is red, then the plugin was not able to bind to the IMeshService provided by the Meshtastic Android App. If this is the case, check to ensure the Meshtastic Android App is functioning. The plugin will reconnect after a failed bind without restarting ATAK.
|
||||
|
||||
3. ATAK PLI and simple map markers will fit within the "small send" DataPackets. Sending larger CoT such as freestyle map drawings or GeoChats will fragment and take longer to send. Don't try to send a bunch without waiting for the previous one to complete.
|
||||
|
|
@ -11,4 +11,6 @@ Current Meshtastic integrations:
|
|||
|
||||
- [CalTopo / SARTopo](/docs/software/integrations/integrations-caltopo) - Track Meshtastic nodes in CalTopo and SARTopo.
|
||||
|
||||
- [ATAK Plugin](/docs/software/integrations/integrations-atak-plugin) - Official Meshtastic ATAK Plugin for sending CoT to IMeshService in the Meshtastic Android app.
|
||||
|
||||
Support for the integrated products should be sought from their respective authors or vendors.
|
||||
|
|
|
|||
Loading…
Reference in a new issue