From 0e21d1849ec68b2a3c375aff9aa24899bd8c2cdb Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 10 Mar 2022 15:37:01 -0700 Subject: [PATCH 1/3] relational links --- docs/faq/channel.md | 2 +- docs/faq/client-python-cli.md | 4 ++-- docs/faq/device.md | 2 +- docs/faq/wifi.md | 2 +- docs/software/modules/store-forward.md | 3 +-- 5 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/faq/channel.md b/docs/faq/channel.md index 9bdcfb12..0405feea 100644 --- a/docs/faq/channel.md +++ b/docs/faq/channel.md @@ -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? -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). diff --git a/docs/faq/client-python-cli.md b/docs/faq/client-python-cli.md index f9beb149..9f726e38 100644 --- a/docs/faq/client-python-cli.md +++ b/docs/faq/client-python-cli.md @@ -8,8 +8,8 @@ sidebar_label: CLI ### 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? -See https://meshtastic.org/docs/software/python/python-uses +[See our guide here](/docs/software/python/python-uses). diff --git a/docs/faq/device.md b/docs/faq/device.md index 455495a5..331d6279 100644 --- a/docs/faq/device.md +++ b/docs/faq/device.md @@ -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? -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? diff --git a/docs/faq/wifi.md b/docs/faq/wifi.md index 2becf7dd..a22221eb 100644 --- a/docs/faq/wifi.md +++ b/docs/faq/wifi.md @@ -8,7 +8,7 @@ sidebar_label: WiFi ### 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? diff --git a/docs/software/modules/store-forward.md b/docs/software/modules/store-forward.md index b0d7c383..4bbd719e 100644 --- a/docs/software/modules/store-forward.md +++ b/docs/software/modules/store-forward.md @@ -49,8 +49,7 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly ### Router setup -- Configure your device as a meshtastic router. -- - https://meshtastic.org/docs/software/settings/router +- Configure your device as a [Meshtastic router](/docs/software/settings/router). - Configure the Store and Forward Module - - Required configuration - - - store_forward_module_enabled - Set this to true to enable the module. False to disable the module. From f84a502e13e3f102acf7efeca67ebdb66bb00f6a Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 10 Mar 2022 15:39:48 -0700 Subject: [PATCH 2/3] relational link --- docs/software/modules/store-forward.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/software/modules/store-forward.md b/docs/software/modules/store-forward.md index 4bbd719e..6ab842d8 100644 --- a/docs/software/modules/store-forward.md +++ b/docs/software/modules/store-forward.md @@ -49,7 +49,7 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly ### Router setup -- Configure your device as a [Meshtastic router](/docs/software/settings/router). +- Configure your device as a [Meshtastic router](/docs/settings/router). - Configure the Store and Forward Module - - Required configuration - - - store_forward_module_enabled - Set this to true to enable the module. False to disable the module. From 8d5ec8390eb5c8e977b2254d6bde3f05df0787be Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 10 Mar 2022 15:39:56 -0700 Subject: [PATCH 3/3] fixed bulletpoints --- docs/software/modules/store-forward.md | 92 +++++++++++++------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/software/modules/store-forward.md b/docs/software/modules/store-forward.md index 6ab842d8..52494309 100644 --- a/docs/software/modules/store-forward.md +++ b/docs/software/modules/store-forward.md @@ -23,15 +23,15 @@ Because of the increased network traffic for this overhead, it's not advised to Initial Requirements: - Must be installed on a router node. -- - 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. + - 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. - Esp32 Processor based device with external PSRAM. (tbeam v1.0 and tbeamv1.1, and maybe others) ## Usage Overview -- 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. -- - Two others will be regular clients. Nothing special required. +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. +- Two others will be regular clients. Nothing special required. ### Meshtastic channel configuration @@ -51,10 +51,10 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly - Configure your device as a [Meshtastic router](/docs/settings/router). - Configure the Store and Forward Module -- - Required configuration -- - - store_forward_module_enabled - Set this to true to enable the module. False to disable the module. -- - 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. + - Required configuration + - `store_forward_module_enabled` - Set this to true to enable the module. False to disable the module. + - 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. - Name your router node something that makes it easily identifiable, aka "Router". Don't enable the Store and Forward module on multiple routers! @@ -88,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. - Carol -- - Packet (Port: STORE_FORWARD_APP) -- - - To: Broadcast (Optionally, direct to router) -- - - StoreAndForward.rr.CLIENT_HISTORY + - Packet (Port: STORE_FORWARD_APP) + - To: Broadcast (Optionally, direct to router) + - StoreAndForward.rr.CLIENT_HISTORY - Router -- - Packet (Port: STORE_FORWARD_APP) -- - - To: Carol -- - - StoreAndForward.rr.ROUTER_HISTORY -- - - 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.LastRequest = 0 // Carol has never asked for the history. -- - Packet (Port: TEXT_MESSAGE_APP) -- - - ... a series of 42 text messages + - Packet (Port: STORE_FORWARD_APP) + - To: Carol + - StoreAndForward.rr.ROUTER_HISTORY + - 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.LastRequest = 0 // Carol has never asked for the history. + - Packet (Port: TEXT_MESSAGE_APP) + - ... a series of 42 text messages ### 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. - Carol -- - Packet (Port: STORE_FORWARD_APP) -- - - To: Broadcast (Optionally, direct to router) -- - - StoreAndForward.rr.CLIENT_HISTORY + - Packet (Port: STORE_FORWARD_APP) + - To: Broadcast (Optionally, direct to router) + - StoreAndForward.rr.CLIENT_HISTORY - Router -- - Packet (Port: STORE_FORWARD_APP) -- - - To: Carol -- - - StoreAndForward.rr.ROUTER_HISTORY -- - - 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.LastRequest = (timestamp) // Last time carol requested the history. + - Packet (Port: STORE_FORWARD_APP) + - To: Carol + - StoreAndForward.rr.ROUTER_HISTORY + - 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.LastRequest = (timestamp) // Last time carol requested the history. ### 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. - Router -- - Packet (Port: STORE_FORWARD_APP) -- - - To: Broadcast -- - - StoreAndForward.rr.ROUTER_HEARTBEAT -- - - 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. + - Packet (Port: STORE_FORWARD_APP) + - To: Broadcast + - StoreAndForward.rr.ROUTER_HEARTBEAT + - 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. ## Meshpacket @@ -149,21 +149,21 @@ As a reminder, broadcast messages are messages where the "to" of a payload is di Example Cases: - Real time :: BROADCAST -- - Delayed = MeshPacket_Delayed_NO_DELAY -- - From: Ann -- - To: BROADCAST + - Delayed = MeshPacket_Delayed_NO_DELAY + - From: Ann + - To: BROADCAST - Real time :: Direct -- - Delayed = MeshPacket_Delayed_NO_DELAY -- - From: Ann -- - To: Bob + - Delayed = MeshPacket_Delayed_NO_DELAY + - From: Ann + - To: Bob - Delayed :: BROADCAST -- - Delayed = MeshPacket_Delayed_DELAYED_BROADCAST -- - From: Ann -- - To: Bob + - Delayed = MeshPacket_Delayed_DELAYED_BROADCAST + - From: Ann + - To: Bob - Delayed :: Direct -- - Delayed = MeshPacket_Delayed_DELAYED_DIRECT -- - From: Ann -- - To: Bob + - Delayed = MeshPacket_Delayed_DELAYED_DIRECT + - From: Ann + - 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.