From aed8b713c8d6ff177d95afa32a4b5773306589fb Mon Sep 17 00:00:00 2001 From: Sacha Weatherstone Date: Sun, 6 Aug 2023 18:35:55 +1000 Subject: [PATCH] Escape `<`, `>` and `-` characters for MDX 2.0 upgrade --- docs/about/overview/radio-settings.mdx | 2 +- docs/configuration/device-config/lora.mdx | 4 ++-- docs/development/device/http-api.mdx | 6 +++--- docs/hardware/antennas/testing.mdx | 4 ++-- docs/hardware/devices/nano-g1/index.mdx | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/about/overview/radio-settings.mdx b/docs/about/overview/radio-settings.mdx index fbb64302..62478b5d 100644 --- a/docs/about/overview/radio-settings.mdx +++ b/docs/about/overview/radio-settings.mdx @@ -109,7 +109,7 @@ Some example settings: The link budget used by these calculations assumes a transmit power of 17dBm and an antenna with 0dB gain. Adjust your link budget assumptions based on your actual devices. -These channel settings may not have been tested. Use at your own discretion. Share on with your successes or failure. +These channel settings may not have been tested. Use at your own discretion. Share on https://meshtastic.discourse.group with your successes or failure. ## Cryptography diff --git a/docs/configuration/device-config/lora.mdx b/docs/configuration/device-config/lora.mdx index 43581c84..821e7a7c 100644 --- a/docs/configuration/device-config/lora.mdx +++ b/docs/configuration/device-config/lora.mdx @@ -36,7 +36,7 @@ The presets are designed to provide further options for optimizing either speed 1. A high number of devices exist in the mesh, or messages are sent very frequently. Faster speeds (and therefore lower radio time per device) can help with mesh network congestion. 2. Maximum range is desired, for long range scenarios where a several second delay in message receipt is acceptable (for instance, attempting to send messages from a town to a distant mountain top). -The Presets available are as follows, and follow a linear pattern of Fastest <--> Slowest, and Shortest <--> Longest range: +The Presets available are as follows, and follow a linear pattern of Fastest \<\-\-\> Slowest, and Shortest \<\-\-\> Longest range: 1. `SHORT_FAST` (Fastest, highest bandwidth, lowest airtime, shortest range) @@ -81,7 +81,7 @@ Please be aware that values < 62.5kHz may require a TCXO on some hardware device ### Spread Factor -A number from 7 to 12. Indicates the number of chirps per symbol as 1< +See: https://github.com/meshtastic/meshtastic.js A reference client written in JavaScript will provide a JavaScript API for using this transport. That client will do HTTP connections, use the generated protobuf JavaScript code and provide an API that hides all of this REST plumbing. The two key methods will be `sendToRadio(packet)` and `onFromRadio(callback)`. ### Protoman -See: +See: [https://github.com/spluxx/Protoman] Protoman is able to interface with the Meshtastic REST API out of the box. This is useful for manual testing of the endpoints. @@ -100,4 +100,4 @@ HTTP and HTTPS are both supported on the ESP32 using self signed certificates on ## Related documents -- Interesting slide pack on the concept: +- Interesting slide pack on the concept: [https://www.slideshare.net/mokeefe/javaone-2009-ts5276-restful-protocol-buffers] diff --git a/docs/hardware/antennas/testing.mdx b/docs/hardware/antennas/testing.mdx index 43819741..f69e16fa 100644 --- a/docs/hardware/antennas/testing.mdx +++ b/docs/hardware/antennas/testing.mdx @@ -9,8 +9,8 @@ Testing of antennas can be both simple and complex. At its simplest, testing inv If you have sufficient range with your existing aerial, skip this section. If you don't, consider either getting more nodes and / or replace the stock aerial with one tuned (to your region transmitter's frequency): -- A quarter wave _tuned_ stubby aerial (<10cm for fit-in-pocket) should have a real-world range of a couple of km without significant obstacles (buildings / hills). -- Aerial criteria: 50 Ohm, appropriate connector (usually SMA male or U.FL), low VSWR (<2) (at tuning frequency - see its datasheet), gain > 0 dBi . +- A quarter wave _tuned_ stubby aerial (\<10cm for fit-in-pocket) should have a real-world range of a couple of km without significant obstacles (buildings / hills). +- Aerial criteria: 50 Ohm, appropriate connector (usually SMA male or U.FL), low VSWR (\<2) (at tuning frequency - see its datasheet), gain > 0 dBi . - Caution, avoid suppliers who: - don't state the aerial's tuned frequency and its specific purpose (LoRa network) - claim huge gain figures on omni-directional aerials diff --git a/docs/hardware/devices/nano-g1/index.mdx b/docs/hardware/devices/nano-g1/index.mdx index 0dd39fe6..9e990c2d 100644 --- a/docs/hardware/devices/nano-g1/index.mdx +++ b/docs/hardware/devices/nano-g1/index.mdx @@ -20,7 +20,7 @@ The Nano G1 is the first dedicated hardware device to be designed from scratch p - **Navigation Module** - ATGM336H-5N-71 (Supports GPS, BDS and GLONASS) - **Antenna** - - Built in 915Mhz Lora PCB Antenna (VSWR <=1.5 @ 915 MHz) + - Built in 915Mhz Lora PCB Antenna (VSWR \<=1.5 @ 915 MHz) - **Connectors** - USB-C