mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-26 22:19:46 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #285 from jfirwin/fix-faq-urls

Browse source 
Fix hardcoded urls to relational urls
This commit is contained in:
Foster Irwin 2022-03-17 21:10:04 -06:00 committed by GitHub
parent c2cb504722 8d5ec8390e
commit fb46c41ad7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 52 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/faq/channel.md
View file

@ -24,4 +24,4 @@ This is the first channel that's created for you when you initially setup your M
### What is a Secondary Channel? ### What is a Secondary Channel?
As this is a new feature, secondary channels work on the device and the Python Script. Support for secondary channels by other clients is pending. For more information: https://meshtastic.org/docs/software/device/device-channels#how-to-use-secondary-channels As this is a new feature, secondary channels work on the device and the Python Script. Support for secondary channels by other clients is pending. [See further details here](/docs/software/device/device-channels#how-to-use-secondary-channels).

4
docs/faq/client-python-cli.md
View file

@ -8,8 +8,8 @@ sidebar_label: CLI
### How do I find out more about installing (and using) Meshtastic via command line? ### How do I find out more about installing (and using) Meshtastic via command line?
See https://meshtastic.org/docs/software/python/python-installation [See our guide here](/docs/software/python/python-installation).
### How do I find out more about using python to interact? ### How do I find out more about using python to interact?
See https://meshtastic.org/docs/software/python/python-uses [See our guide here](/docs/software/python/python-uses).

2
docs/faq/device.md
View file

@ -12,7 +12,7 @@ Each [supported device](/docs/hardware/supported/tbeam) has a "Purchase Link".
### I have my hardware. How do I install the firmware and any required drivers? ### I have my hardware. How do I install the firmware and any required drivers?
See: https://meshtastic.org/docs/getting-started/flashing-esp32 [See our guide here](/docs/getting-started/flashing-firmware).
### How do I update the firmware to the latest version? ### How do I update the firmware to the latest version?

2
docs/faq/wifi.md
View file

@ -8,7 +8,7 @@ sidebar_label: WiFi
### How do I turn on the WiFI radio? ### How do I turn on the WiFI radio?
See: https://meshtastic.org/docs/software/device/device-wifi [See our guide here](/docs/settings/wifi).
### When I turn on WiFi, Bluetooth turns off. Why is this? ### When I turn on WiFi, Bluetooth turns off. Why is this?

95
docs/software/modules/store-forward.md
View file

@ -23,15 +23,15 @@ Because of the increased network traffic for this overhead, it's not advised to
Initial Requirements: Initial Requirements:
- Must be installed on a router node. - Must be installed on a router node.
- - This is an artificial limitation, but is in place to enforce best practices. - This is an artificial limitation, but is in place to enforce best practices.
- - Router nodes are intended to be always online. If this module misses any messages, the reliability of the stored messages will be reduced. - Router nodes are intended to be always online. If this module misses any messages, the reliability of the stored messages will be reduced.
- Esp32 Processor based device with external PSRAM. (tbeam v1.0 and tbeamv1.1, and maybe others) - Esp32 Processor based device with external PSRAM. (tbeam v1.0 and tbeamv1.1, and maybe others)
## Usage Overview ## Usage Overview
- To use / test this you will want at least 3 devices To use / test this you will want at least 3 devices
- - One device will (currently) need be a tbeam v1.0 and tbeamv1.1 configured as a Meshtastic router. Other devices with built in PSRAM will be supported at some point. - One device will (currently) need be a tbeam v1.0 and tbeamv1.1 configured as a Meshtastic router. Other devices with built in PSRAM will be supported at some point.
- - Two others will be regular clients. Nothing special required. - Two others will be regular clients. Nothing special required.
### Meshtastic channel configuration ### Meshtastic channel configuration
@ -49,13 +49,12 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly
### Router setup ### Router setup
- Configure your device as a meshtastic router. - Configure your device as a [Meshtastic router](/docs/settings/router).
- - https://meshtastic.org/docs/software/settings/router
- Configure the Store and Forward Module - Configure the Store and Forward Module
- - Required configuration - Required configuration
- - - store_forward_module_enabled - Set this to true to enable the module. False to disable the module. - `store_forward_module_enabled` - Set this to true to enable the module. False to disable the module.
- - Optional configuration - Optional configuration
- - - store_forward_module_records - Set this to the maximum number of records to save. Best to leave this at the default (0) where the module will use 2/3 of your device's available PSRAM. This is about 11,000 records. - `store_forward_module_records` - Set this to the maximum number of records to save. Best to leave this at the default (0) where the module will use 2/3 of your device's available PSRAM. This is about 11,000 records.
- Name your router node something that makes it easily identifiable, aka "Router". - Name your router node something that makes it easily identifiable, aka "Router".
Don't enable the Store and Forward module on multiple routers! Don't enable the Store and Forward module on multiple routers!
@ -89,45 +88,45 @@ The Store and Forward module will only service one client at a time. If a second
Story: Carol has been away from the mesh with device turned off. She would like to get a replay of what she has missed. The router will return the messages. Story: Carol has been away from the mesh with device turned off. She would like to get a replay of what she has missed. The router will return the messages.
- Carol - Carol
- - Packet (Port: STORE_FORWARD_APP) - Packet (Port: STORE_FORWARD_APP)
- - - To: Broadcast (Optionally, direct to router) - To: Broadcast (Optionally, direct to router)
- - - StoreAndForward.rr.CLIENT_HISTORY - StoreAndForward.rr.CLIENT_HISTORY
- Router - Router
- - Packet (Port: STORE_FORWARD_APP) - Packet (Port: STORE_FORWARD_APP)
- - - To: Carol - To: Carol
- - - StoreAndForward.rr.ROUTER_HISTORY - StoreAndForward.rr.ROUTER_HISTORY
- - - StoreAndForward.history.HistoryMessages = 42 // Router has 42 messages that will be sent to Carol. - StoreAndForward.history.HistoryMessages = 42 // Router has 42 messages that will be sent to Carol.
- - - StoreAndForward.history.Window = 120 // Router searched for messages over the last two hours. - StoreAndForward.history.Window = 120 // Router searched for messages over the last two hours.
- - - StoreAndForward.history.LastRequest = 0 // Carol has never asked for the history. - StoreAndForward.history.LastRequest = 0 // Carol has never asked for the history.
- - Packet (Port: TEXT_MESSAGE_APP) - Packet (Port: TEXT_MESSAGE_APP)
- - - ... a series of 42 text messages - ... a series of 42 text messages
### Request History (No history available) ### Request History (No history available)
Story: Carol has been away from the mesh with device turned off. She would like to get a replay of what she has missed but the router indicates there are no messages available. Story: Carol has been away from the mesh with device turned off. She would like to get a replay of what she has missed but the router indicates there are no messages available.
- Carol - Carol
- - Packet (Port: STORE_FORWARD_APP) - Packet (Port: STORE_FORWARD_APP)
- - - To: Broadcast (Optionally, direct to router) - To: Broadcast (Optionally, direct to router)
- - - StoreAndForward.rr.CLIENT_HISTORY - StoreAndForward.rr.CLIENT_HISTORY
- Router - Router
- - Packet (Port: STORE_FORWARD_APP) - Packet (Port: STORE_FORWARD_APP)
- - - To: Carol - To: Carol
- - - StoreAndForward.rr.ROUTER_HISTORY - StoreAndForward.rr.ROUTER_HISTORY
- - - StoreAndForward.history.HistoryMessages = 0 // Router has no messages to be sent to Carol. - StoreAndForward.history.HistoryMessages = 0 // Router has no messages to be sent to Carol.
- - - StoreAndForward.history.Window = 120 // Router searched for messages over the last two hours. - StoreAndForward.history.Window = 120 // Router searched for messages over the last two hours.
- - - StoreAndForward.history.LastRequest = (timestamp) // Last time carol requested the history. - StoreAndForward.history.LastRequest = (timestamp) // Last time carol requested the history.
### Store & Forward Router Heartbeat ### Store & Forward Router Heartbeat
Story: The Store & Forward Router sends a periodic message onto the network. This allows connected devices to know that a router is in range and listening to received messages. Client will not respond to network but (optionally) indicate to the user that a S&F router is available or not available. Story: The Store & Forward Router sends a periodic message onto the network. This allows connected devices to know that a router is in range and listening to received messages. Client will not respond to network but (optionally) indicate to the user that a S&F router is available or not available.
- Router - Router
- - Packet (Port: STORE_FORWARD_APP) - Packet (Port: STORE_FORWARD_APP)
- - - To: Broadcast - To: Broadcast
- - - StoreAndForward.rr.ROUTER_HEARTBEAT - StoreAndForward.rr.ROUTER_HEARTBEAT
- - - StoreAndForward.heartbeat.Period = 120 // Expect a heartbeat every 2 minutes. - StoreAndForward.heartbeat.Period = 120 // Expect a heartbeat every 2 minutes.
- - - StoreAndForward.heartbeat.Secondary = false // If true, this is a secondary "backup" S&F node. Will be (eventually) used for router election in the event there are multiple S&F Routers. - StoreAndForward.heartbeat.Secondary = false // If true, this is a secondary "backup" S&F node. Will be (eventually) used for router election in the event there are multiple S&F Routers.
## Meshpacket ## Meshpacket
@ -150,21 +149,21 @@ As a reminder, broadcast messages are messages where the "to" of a payload is di
Example Cases: Example Cases:
- Real time :: BROADCAST - Real time :: BROADCAST
- - Delayed = MeshPacket_Delayed_NO_DELAY - Delayed = MeshPacket_Delayed_NO_DELAY
- - From: Ann - From: Ann
- - To: BROADCAST - To: BROADCAST
- Real time :: Direct - Real time :: Direct
- - Delayed = MeshPacket_Delayed_NO_DELAY - Delayed = MeshPacket_Delayed_NO_DELAY
- - From: Ann - From: Ann
- - To: Bob - To: Bob
- Delayed :: BROADCAST - Delayed :: BROADCAST
- - Delayed = MeshPacket_Delayed_DELAYED_BROADCAST - Delayed = MeshPacket_Delayed_DELAYED_BROADCAST
- - From: Ann - From: Ann
- - To: Bob - To: Bob
- Delayed :: Direct - Delayed :: Direct
- - Delayed = MeshPacket_Delayed_DELAYED_DIRECT - Delayed = MeshPacket_Delayed_DELAYED_DIRECT
- - From: Ann - From: Ann
- - To: Bob - To: Bob
When a message is 'real time', time a message is sent is the same as the time the message was received. In the case the message is delayed, there is no timestamp available for the message. When a message is 'real time', time a message is sent is the same as the time the message was received. In the case the message is delayed, there is no timestamp available for the message.