Merge branch 'master' of https://github.com/GUVWAF/Meshtastic

docs/configuration/device-config/lora.mdx

@@ -103,6 +103,10 @@ Defaults to true
 
 This is controlling the actual hardware frequency the radio is transmitting on. A channel number between 1 and NUM_CHANNELS (whatever the max is in the current region). If this is ZERO/UNSET then the rule is "use the old channel name hash based algorithm to derive the channel number".
 
+:::info
+LoRa Channel Configuration should not to be confused with messaging [Channel Configuration](/docs/settings/config/channels). See [Chat Channels VS Lora Modem Channels](/docs/configuration/tips#chat-channels-vs-lora-modem-channels) for further clarification.
+:::
+
 ### Ignore Incoming Array
 
 For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in the ignore_incoming array will have packets they send dropped on receive (by router.cpp)

docs/configuration/module-config/index.mdx

@@ -18,6 +18,7 @@ Modules are included in the firmware and allow users to extend the functionality
 |                  [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.                                                                                                 |
 |            [Range Test](/docs/settings/moduleconfig/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/settings/moduleconfig/remote-hardware)       |                                                                                        Set and read a GPIO status remotely over the mesh.                                                                                           |
 |            [Serial Module](/docs/settings/moduleconfig/serial)             |                                                                                Send messages across the mesh by sending strings over a serial port.                                                                                 |
 |  [Store & Forward](/docs/settings/moduleconfig/store-and-forward-module)   |                                                                         Stores messages on a device for delivery after disconnected clients rejoin the mesh.                                                                        |
 |             [Telemetry](/docs/settings/moduleconfig/telemetry)             |                                                                        Attach sensors to the device and transmit readings on a regular interval to the mesh.                                                                        |

docs/configuration/module-config/remote-hardware.mdx

@@ -1,12 +1,85 @@
 ---
-id: gpio-peripherals
-title: Configuring GPIO Peripherals
-sidebar_label: Setup GPIO Peripherals
-slug: /hardware/peripheral/
-sidebar_position: 4
+id: remote-hardware
+title: Remote Hardware Module Usage
+slug: /settings/moduleconfig/remote-hardware
+sidebar_label: Remote Hardware
 ---
 
-## Remote Hardware
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+The Remote Hardware Module allows control of a GPIO pin on a remote node. Config options are: Enabled, Allow Undefined Pin Access, Available Pins
+
+:::info
+
+While configuring this module may be available in clients, setting and reading GPIO's is currently only possible using the [Meshtastic Python CLI](/docs/software/python/cli)
+
+:::
+
+## Remote Hardware Config Values
+
+### Enabled
+
+Whether the module is enabled
+
+### Allow Undefined Pin Access
+
+Whether the module allows consumers to read/write to pins not that are not defined in available_pins
+
+### Available Pins
+
+Exposes the available pins to the mesh for reading and writing
+
+
+## Remote Hardware 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 Remote Hardware Module config options are available for Android in app.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Remote Hardware**
+:::
+
+</TabItem>
+<TabItem value="apple">
+
+:::info
+All Remote Hardware Module config options are available on iOS, iPadOS and macOS app.and higher at Settings > Modules > Remote Hardware
+:::
+
+</TabItem>
+<TabItem value="cli">
+
+:::info
+
+All Remote Hardware Module config options are available in the python CLI.
+
+:::
+
+</TabItem>
+<TabItem value="web">
+
+Not implemented.
+
+</TabItem>
+</Tabs>
+
+
+
+
+## Remote Hardware Module Usage
 
 :::warning
 GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk.

docs/configuration/tips.mdx

@@ -0,0 +1,53 @@
+---
+id: tips
+title: Configuration Tips
+sidebar_label: Tips
+sidebar_position: 4
+---
+
+
+## (Not) Sharing Your Location
+
+Telemetry is shared over your [PRIMARY channel](/docs/settings/config/channels#role).  This means that if your node has acquired GPS coordinates from an integrated GPS chip, or from your mobile device, your coordinates will be sent to the mesh over this channel, using it's defined encryption (if any).
+
+By default the PRIMARY channel's name is LongFast with the encryption key "AQ==" (Base64 equivalent of Hex 0x01).  If this is left unchanged, your location will be shared with all nodes in range that are also using the default channel.
+
+### Creating a Private Primary with Default Secondary
+
+If you'd like to connect with other Meshtastic users but only share your location with trusted parties, you may create a private PRIMARY channel and use the defaults for a SECONDARY channel.
+
+1. Ensure you have not changed the LoRa [Modem Preset](/docs/settings/config/lora#modem-preset) from the default `unset` / `LONG_FAST`.
+2. On your PRIMARY channel, set anything you'd like for the channel's name and choose a random PSK.
+3. Enable a SECONDARY channel with a blank name (will default to LongFast) with PSK "AQ==".
+4. Since the radio's frequency is automatically changed based on your PRIMARY channel's name, you will have to manually set it back to Channel 20 (in LoRa settings) in order to interface with users on the default channel.
+
+To quickly test this configuration, scan your region's QR from [this folder](https://github.com/meshtastic/meshtastic/tree/master/static/img/configuration/qr-private-primary-example/). Remember to generate a new PSK for your private channel before sharing with your trusted nodes.
+
+## Rebroadcast "Public" Traffic
+
+Meshtastic nodes will rebroadcast all packets if they share [LoRa modem settings](/docs/settings/config/lora#lora-config-values), regardless of encryption (unless [Rebroadcast mode](/docs/settings/config/device#rebroadcast-mode) is set to `LOCAL_ONLY`).
+
+:::info
+ If you would like your nodes to include/expand the "public" mesh, you must use the default [modem preset](/docs/settings/config/lora#modem-preset) `LONG_FAST`.  If you change your PRIMARY channel name, you must manually set the LoRa channel to 20.
+:::
+
+## Chat Channels VS LoRa Modem Channels
+
+Meshtastic uses the word "channels" to define two different configuration properties: [Messaging Channels](/docs/settings/config/channels) & [LoRa Modem Channels](/docs/settings/config/lora#channel-number)
+
+### Device Config: Channels
+
+These configure "message groups" and include your PRIMARY and SECONDARY channels.  All SECONDARY channels use the same LoRa modem config as your PRIMARY channel (including LoRa channel number).
+
+There are 8 total chat channels.  Channel 0 is your PRIMARY channel, with channels 1-7 available for private group messaging and/or special channels such as [`admin`](/docs/configuration/remote-admin).
+
+### Device Config: LoRa: Channel Number
+
+This configures the frequency the radio is set to.  Check out the [frequency calculator](/docs/overview/radio-settings#channel-frequency-calculator) to view the relationship between "channel number" and radio frequency.
+
+## Best Practices
+- If you are part of a large mesh and don't know what a setting does, don't change it (unless you're super curious).
+- Leave your [MAX HOPS](/docs/settings/config/lora#max-hops) set to 3 unless you're sure you need more (or less) to reach your destination node.
+- Leave your [ROLE](/docs/settings/config/device#role) set to `CLIENT` unless you're sure another role would suit the node's purpose.  For example, MQTT nodes do not need to be set to `ROUTER`.
+- TEST your settings and hardware before you install in hard-to-reach locations.
+- Connecting a node to the [public MQTT server](http://localhost:3000/docs/settings/moduleconfig/mqtt#connect-to-the-default-public-server) may publish the locations of all nodes in your mesh to the internet.  This will also add every globally connected node to your node database and potentially flood your mesh with all types of packets.

docs/development/device/module-api.mdx

@@ -57,7 +57,7 @@ A number of [key services](http://github.com/meshtastic/firmware/tree/master/src
 
 - [NodeInfoModule](http://github.com/meshtastic/firmware/tree/master/src/modules/NodeInfoModule.h) - Receives/sends User information to other nodes so that usernames are available in the databases.
 
-- [RemoteHardwareModule](http://github.com/meshtastic/firmware/tree/master/src/modules/RemoteHardwareModule.h) - A module that provides easy remote access to device hardware (for things like turning GPIOs on or off). Intended to be a more extensive example and provide a useful feature of its own. See [remote-hardware](/docs/hardware/peripheral/#remote-hardware) for details.
+- [RemoteHardwareModule](http://github.com/meshtastic/firmware/tree/master/src/modules/RemoteHardwareModule.h) - A module that provides easy remote access to device hardware (for things like turning GPIOs on or off). Intended to be a more extensive example and provide a useful feature of its own. See [remote-hardware](/docs/settings/moduleconfig/remote-hardware) for details.
 
 - [ReplyModule](http://github.com/meshtastic/firmware/tree/master/src/modules/ReplyModule.h) - A simple module that just replies to any packet it receives (provides a 'ping' service).
 

docs/getting-started/flashing-firmware/nrf52/convert-rak4631r.mdx

@@ -9,6 +9,26 @@ The only difference between the _RAK4631-R_ (RUI3) and the _RAK4631_ (Arduino) i
 
 Meshtastic requires the Arduino bootloader on RAK WisBlock nRF52-based boards. The process of converting the bootloader only needs to be performed once.
 
+Here are two ways to flash the bootloader:
+
+## USB Device Firmware Upgrade (DFU)
+
+1. Install [Python](https://www.python.org/downloads/)
+2. Install [adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil)
+   ```shell
+   pip3 install adafruit-nrfutil
+   ```
+3. Download the required bootloader: [WisCore_RAK4631_Board_Bootloader.zip](https://github.com/RAKWireless/WisBlock/releases/download/0.4.2/WisCore_RAK4631_Board_Bootloader.zip)
+4. Connect your RAK device by USB.
+5. Flash the bootloader
+   ```shell
+   adafruit-nrfutil --verbose dfu serial --package ./WisCore_RAK4631_Board_Bootloader.zip  -p /dev/ttyACM0 -b 115200 --singlebank --touch 1200
+   ```
+   Note: The serial port name (`/dev/ttyACM0`) may differ depending on your operating system. Make sure to identify the correct port name for your setup.
+6. Continue with the normal [flashing instructions](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop)
+
+## Debugger
+
 This conversion requires the use of either a [DAPLink](https://daplink.io/) or [J-Link](https://www.segger.com/products/debug-probes/j-link/). The most reasonably priced and available is the [RAKDAP1](https://store.rakwireless.com/products/daplink-tool).
 
 1. Install [Python](https://www.python.org/downloads/)

docs/getting-started/flashing-firmware/nrf52/drag-n-drop.mdx

@@ -17,7 +17,7 @@ Download and unzip the latest firmware from [Meshtastic Downloads](https://mesht
 2. Double click the reset button on your device (this will put it into bootloader mode)
 3. Notice a new drive will be mounted on your computer (Windows, Mac, or Linux)
 4. Open this drive and you should see three files: `CURRENT.UF2`, `INDEX.HTM`, and `INFO_UF2.TXT`
-5. Drop the appropriate firmware file (`firmware-DEVICE_NAME-vx.x.x-xxxxxxx.uf2`) from the release onto this drive.
+5. Drop the appropriate firmware file (`firmware-DEVICE_NAME-x.x.x-xxxxxxx.uf2`) from the release onto this drive.
 
 Once the file has finished copying onto the drive, the device will reboot and install the Meshtastic firmware.
 

docs/getting-started/initial-config.mdx

@@ -34,7 +34,7 @@ values={[
 
 - [Android App](/docs/category/android-app)
 - [Web Client](https://client.meshtastic.org)
-- [iOS App](/docs/category/apple-apps)
+- [iOS/iPadOS/macOS App](/docs/category/apple-apps)
 
 </TabItem>
 <TabItem value="network">

docs/software/android/usage.mdx

@@ -82,23 +82,11 @@ The app will generate a new QR code on the screen.  This encodes the channel det
 
 2. If the channel is shared from a file or link using the `Share` button, you can click on the file or link and you need to choose "Open with Meshtastic".
 
-<details>
-  <summary>Troubleshooting shared links: Can't "open with Meshtastic".</summary>
-  <div>
-    <div>
-      If you don't see "Meshtastic" as an option to open the file or link with:
-      <br />
-      1. Go to Android Settings > Apps > Default apps > Meshtastic > Opening
-      links
-      <br />
-      2. Make sure you have in "links/web address": www.meshtastic.org
-      <br />
-      3. If you see the option "Open the supported links", make sure it is
-      enabled.
-      <br />
-    </div>
-  </div>
-</details>
+:::info If a QR or URL opens a webpage instead of the APP or "Open with Meshtastic" is not an option:
+1. Go to Android Settings > Apps > Default apps > Meshtastic > Opening links
+2. Make sure you have in "links/web address": www.meshtastic.org
+3. If you see the option "Open the supported links", make sure it is enabled.
+:::
 
 [![Accept new channel](/img/android/android-accept-channel-c.png)](/img/android/android-accept-channel.png)
 

docs/software/mqtt/home-assistant.mdx

@@ -206,13 +206,13 @@ Always Check Configuration before reloading YAML or restarting Home Assistant to
 
 Create a new Entities Card and select the entities you have created.
 
-[<img src="/img/software/mqtt/ha_entities_card.png" style={{zoom: '40%'}} />](/img/software/mqtt/ha_entities_card.png)
+![HA Entities Card](/img/software/mqtt/ha_entities_card.png)
 
 ### Logbook Card for Messaging
 
 The logbook card is useful to keep a record of incoming messages from the mesh. Below is an example of how the logbook card would be set up.
 
-[<img src="/img/software/mqtt/ha_logbook_card.png" style={{zoom: '40%'}} />](/img/software/mqtt/ha_logbook_card.png)
+![HA Logbook Card](/img/software/mqtt/ha_logbook_card.png)
 
 
 ## Trigger HA Automations
@@ -223,7 +223,7 @@ It is possible to have Home Assistant trigger automations based on messages or e
 
 This example waits for a message containing @Tropho and then sends a pop-up notification to his flip phone with the message.  Optionally you can have ALL messages from the mesh sent as HA notifications to your phone.
 
-[<img src="/img/software/mqtt/ha_at_tropho.png" style={{zoom: '50%'}} />](/img/software/mqtt/ha_at_tropho.png)
+![HA At Tropho Message](/img/software/mqtt/ha_at_tropho.png)
 
 Add the following code to your automations.yaml file.  Be sure to modify the `topic`, `regex_search`, and `service` for your configuration.
 ```yaml
@@ -253,4 +253,61 @@ Add the following code to your automations.yaml file.  Be sure to modify the `to
   mode: single
 ```
 
-This same type of automation is very useful to trigger other actions in Home Assistant.  For example, you could turn on a fan when the temperature reaches a certain value, or a play a sound on a speaker when a new message is received. 
+This same type of automation is very useful to trigger other actions in Home Assistant.  For example, you could turn on a fan when the temperature reaches a certain value, or a play a sound on a speaker when a new message is received. 
+
+
+## Create a Send Message Entity
+
+It is possible to create an input text box to send messages to your mesh from within Home Assistant.
+
+### Input Text Helper Entity
+
+First, create an input text helper entity. The preferred way to configure an input text is via the HA interface at Settings > Devices & Services > Helpers. Click the add button and then choose the Text option. Make a text input helper with a max length of 190 to be on the safe side. See example below:
+
+![HA Input Text Helper](/img/software/mqtt/ha_input_text_helper.png)
+
+### Create a Send Message Automation
+
+This automation will check the send box for changes.  After typing a message, either hit enter or click off the box and the automation will send a text string in JSON to the mqtt broker. Make sure to update the channel name and device ID in the example below. 
+
+```yaml
+- alias: Meshtastic - Send Automation
+  description: ""
+  trigger:
+    - platform: state
+      entity_id:
+        - input_text.meshtastic_send_box
+  condition: []
+  action:
+    - delay:
+        hours: 0
+        minutes: 0
+        seconds: 1
+        milliseconds: 0
+    - service: mqtt.publish
+      data:
+        qos: 0
+        retain: false
+        topic: msh/2/json/LongFast/!67ea9400
+        payload: >-
+          {"channel":"0","sender":"broker","type":"sendtext","payload":"{{    
+          states('input_text.meshtastic_send_box') }}"}
+    - delay:
+        hours: 0
+        minutes: 0
+        seconds: 1
+        milliseconds: 0
+    - service: input_text.set_value
+      data:
+        value: " "
+      target:
+        entity_id: input_text.meshtastic_send_box
+    - delay:
+        hours: 0
+        minutes: 0
+        seconds: 2
+        milliseconds: 0
+  mode: single
+  ```
+
+  Add this card to your dashboard by going to Edit Dashboard -> + ADD CARD.  Then search BY ENTITY for Meshtastic Send Box and check the box next to the entry.  Click CONTINUE, then ADD TO DASHBOARD.