From 47d162c30d3dde6c1f6cab558c69f59a23e6f8dc Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Wed, 29 Jun 2022 15:31:20 -0700 Subject: [PATCH] Remove duplicate and unfinished concepts section --- docs/about/concepts/channels.mdx | 32 ----------------- docs/about/concepts/clients.mdx | 20 ----------- docs/about/concepts/external-devices.mdx | 36 ------------------- docs/about/concepts/index.mdx | 9 ----- docs/about/concepts/internet.mdx | 16 --------- docs/about/concepts/mesh.mdx | 16 --------- .../flashing-firmware/flashing-esp32.mdx | 4 +-- .../flashing-external-serial-adapter.mdx | 6 ++-- .../flashing-firmware/flashing-nrf52.mdx | 4 +-- .../flashing-firmware/index.mdx | 8 ++--- .../flashing-firmware/meshtastic-flasher.mdx | 2 +- docs/getting-started/index.mdx | 28 --------------- docs/software/community/go.mdx | 2 +- docs/software/community/pygui.mdx | 2 +- 14 files changed, 12 insertions(+), 173 deletions(-) delete mode 100644 docs/about/concepts/channels.mdx delete mode 100644 docs/about/concepts/clients.mdx delete mode 100644 docs/about/concepts/external-devices.mdx delete mode 100644 docs/about/concepts/index.mdx delete mode 100644 docs/about/concepts/internet.mdx delete mode 100644 docs/about/concepts/mesh.mdx diff --git a/docs/about/concepts/channels.mdx b/docs/about/concepts/channels.mdx deleted file mode 100644 index 37174b4d..00000000 --- a/docs/about/concepts/channels.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: channels -title: Channels -sidebar_label: Channels -sidebar_position: 3 ---- - -## Overview - -Meshtastic Channels: Can create a _somewhat_ secure method of communication on the same mesh network. The channel can be encrypted to prevent normal people from listening in on the traffic. But, it could probably be easily [cracked](https://crypto.stackexchange.com/questions/46559/what-are-the-chances-that-aes-256-encryption-is-cracked) by determined individuals. See [Channel Config](/docs/settings/channel) for more info. It is also possible that your location could be triangulated by determined individuals. - -## Channels - -### Primary Channel - -### Secondary Channel - -### Admin Channel - -## Data - -### Telemetry Data - -### MQTT Bridges - -## Encryption - -## Messages - -### Broadcast Messages - -### Direct Messages (DMs) diff --git a/docs/about/concepts/clients.mdx b/docs/about/concepts/clients.mdx deleted file mode 100644 index 6f73d5c9..00000000 --- a/docs/about/concepts/clients.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: clients -title: Clients -sidebar_label: Clients -sidebar_position: 2 ---- - -## Overview - -## Available Clients - -### Android - -### Commandline Interface (CLI) - -### iOS - -### MacOS - -### Web Interface diff --git a/docs/about/concepts/external-devices.mdx b/docs/about/concepts/external-devices.mdx deleted file mode 100644 index 9c438e00..00000000 --- a/docs/about/concepts/external-devices.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: external-devices -title: External Devices -sidebar_label: External Devices -sidebar_position: 5 ---- - -## Overview - -External hardware can be connected to your device using a GPIO (General Purpose Input/Output) interface. Using GPIO, you are able to connect external buttons, circuits, rotary encoders, sensors and more. Many of our modules offer solutions to implement additional functionality. - -Soldering is likely required when attaching items to your device, so practice your skills elsewhere before trying on your radio. If you're not careful or don't know what your doing, you can damage your hardware. - -## Features using External Devices - -Many of our modules require external hardware to be attached to the device. - -### Canned Message Module - -Requires use of the [rotary encoder module](#rotary-encoder-module). The rotary encoder acts as an input to select one of up to 50 customizable messages. This way you can send canned messages without needing to pair your device to a phone. - -### Telemetry Module - -Broadcast telemetry to your mesh! Temperature, Humidity, Pressure, & VOC Gas are all options that are currently available with the supported sensors. - -### External Notifications Module - -Use lights, buzzers, or speakers to alert you of incoming messages. - -### Rotary Encoder Module - -Currently used only for the [canned message module](#canned-message-module), this module allows you to connect a rotary encoder to be used as an additional input to the device. - -### Serial Module - -Available for ESP32 based devices, the serial moduleallows you to send messages over the mesh by sending strings over a serial port. diff --git a/docs/about/concepts/index.mdx b/docs/about/concepts/index.mdx deleted file mode 100644 index 4cc2ec98..00000000 --- a/docs/about/concepts/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: overview -title: Meshtastic Concepts -sidebar_label: Overview of Concepts -sidebar_position: 1 ---- - -## Overview - diff --git a/docs/about/concepts/internet.mdx b/docs/about/concepts/internet.mdx deleted file mode 100644 index 1d7afed5..00000000 --- a/docs/about/concepts/internet.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: internet -title: Internet Connectivity -sidebar_label: Internet Connectivity -sidebar_position: 4 ---- - -## Overview - -Captive Portal: Using Meshtastic, you can create a separate Wifi network for you join your phone or computer on a mesh network. See [Web Interface](/docs/software/web) for more info. This is ideal in a situation where you are remote, such as in the forest, on a mountain, or if there is a major power/internet outage such as in a storm or other disaster. - -## Features using Internet Connectivity - -### MQTT - -### Web Interface diff --git a/docs/about/concepts/mesh.mdx b/docs/about/concepts/mesh.mdx deleted file mode 100644 index 45f3a2b4..00000000 --- a/docs/about/concepts/mesh.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: mesh -title: Mesh Routing -sidebar_label: Mesh Routing -sidebar_position: 1 ---- - -## Overview - -Mesh Networking: An interconnected network by using [low-power radios](/docs/hardware) to connect other low-power radios using LoRa to be able to send and receive messages and data. This can be completely separate from any other networks such as the internet. You can start small and get two devices to start experimenting. Do not expect to stream music or videos as LoRa is intended for smaller, lower bandwidth type uses such as text communication. - -As of 1.2 you can connect up to 32 devices to the network. In 1.3 we are working on having 64-80 devices connected to the network. - -## Devices - -## Routers diff --git a/docs/getting-started/flashing-firmware/flashing-esp32.mdx b/docs/getting-started/flashing-firmware/flashing-esp32.mdx index 69d9c092..417f8a94 100644 --- a/docs/getting-started/flashing-firmware/flashing-esp32.mdx +++ b/docs/getting-started/flashing-firmware/flashing-esp32.mdx @@ -1,10 +1,10 @@ --- id: flashing-esp32 title: Flashing ESP32 devices firmware -sidebar_label: Manual Method - ESP32 devices +sidebar_label: CLI Script - ESP32 devices pagination_prev: getting-started/flashing-firmware/flashing-firmware pagination_next: getting-started/first-steps/first-steps -sidebar_position: 2 +sidebar_position: 3 --- import Tabs from '@theme/Tabs'; diff --git a/docs/getting-started/flashing-firmware/flashing-external-serial-adapter.mdx b/docs/getting-started/flashing-firmware/flashing-external-serial-adapter.mdx index 997f6a8e..d2b79385 100644 --- a/docs/getting-started/flashing-firmware/flashing-external-serial-adapter.mdx +++ b/docs/getting-started/flashing-firmware/flashing-external-serial-adapter.mdx @@ -1,10 +1,10 @@ --- id: flashing-external-serial-adapter -title: Flashing ESP32 Devices with an External Serial Adapter -sidebar_label: Flashing with External Serial Adapter - ESP32 Devices +title: External Serial Adapter - ESP32 Devices +sidebar_label: Serial Adapter - ESP32 Devices pagination_prev: getting-started/flashing-firmware/flashing-firmware pagination_next: getting-started/flashing-firmware/meshtastic-flasher -sidebar_position: 1 +sidebar_position: 5 --- import Tabs from '@theme/Tabs'; diff --git a/docs/getting-started/flashing-firmware/flashing-nrf52.mdx b/docs/getting-started/flashing-firmware/flashing-nrf52.mdx index 9b7cb874..8e2c6e41 100644 --- a/docs/getting-started/flashing-firmware/flashing-nrf52.mdx +++ b/docs/getting-started/flashing-firmware/flashing-nrf52.mdx @@ -1,10 +1,10 @@ --- id: flashing-nrf52 title: Flashing nRF52 devices firmware -sidebar_label: Manual Method - NRF52 devices +sidebar_label: Drag & Drop - NRF52 devices pagination_prev: getting-started/flashing-firmware/flashing-firmware pagination_next: getting-started/first-steps/first-steps -sidebar_position: 3 +sidebar_position: 2 --- import Tabs from '@theme/Tabs'; diff --git a/docs/getting-started/flashing-firmware/index.mdx b/docs/getting-started/flashing-firmware/index.mdx index 85179bc6..2fc1c23d 100644 --- a/docs/getting-started/flashing-firmware/index.mdx +++ b/docs/getting-started/flashing-firmware/index.mdx @@ -1,6 +1,6 @@ --- id: flashing-firmware -title: Firmware Flashing Prerequisites +title: Flashing Firmware sidebar_label: Flashing Firmware pagination_next: getting-started/flashing-firmware/meshtastic-flasher sidebar_position: 1 @@ -13,11 +13,7 @@ import TabItem from '@theme/TabItem'; Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip! ::: -## Overview - -Before you flash your device it is prudent to verify that we have proper connectivity with the device being flashed. Outlined below are steps that can be taken to verify connectivity and, if necessary, to install the appropriate drivers. If you end up needing to install drivers be sure to reboot your computer afterwards to verify the installation is complete. - -## Prerequisites +Before you flash your device start by verifiying connectivity with the device being flashed. Outlined below are steps that can be taken to verify connectivity and, if necessary, to install the appropriate drivers. If you end up needing to install drivers be sure to reboot your computer afterwards to verify the installation is complete. ### Verify data cable diff --git a/docs/getting-started/flashing-firmware/meshtastic-flasher.mdx b/docs/getting-started/flashing-firmware/meshtastic-flasher.mdx index fbc6f82b..889a5965 100644 --- a/docs/getting-started/flashing-firmware/meshtastic-flasher.mdx +++ b/docs/getting-started/flashing-firmware/meshtastic-flasher.mdx @@ -1,7 +1,7 @@ --- id: meshtastic-flasher title: Using Meshtastic Flasher -sidebar_label: Meshtastic Flasher Method +sidebar_label: Meshtastic Flasher pagination_next: getting-started/first-steps/first-steps pagination_prev: getting-started/flashing-firmware/flashing-firmware sidebar_position: 1 diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index caf07f3f..2ad56995 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -36,30 +36,8 @@ Meshtastic uses LoRa for the long range communications and depending on settings -### Initial Setup - -#### Setup the Radio - -When it arrives, install your antenna and make sure you install the battery correctly. Reversing the battery can damage your device. Make sure the antenna is on when you power up the board. - -:::caution -Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip! -::: - ## Flashing Firmware -If your device already has Meshtastic flashed to it, you can update it over the air (OTA). Otherwise, you'll need a computer and a **data** USB cable. Flashing firmware can be done in the following ways: - -- Install using Meshtastic Flasher: - - This all in one application will download the appropriate firmware, detect your device, flash the device, and allow you to configure your settings. - -- Install using manual method: - - Manual firmware files can be downloaded from the [Downloads](/downloads) page. - -The manual firmware installation method will also depend on whether you have an ESP32 based device or a nRF52 based device. See our [hardware section](/docs/hardware) to determine which microcontroller your device is based on. -