mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-01-30 07:10:51 -08:00
Merge pull request #325 from apt105/Change-sidebar-order
Change sidebar order
This commit is contained in:
Foster Irwin
GitHub
commit
50509c2328
|
|
@ -2,6 +2,7 @@
|
||||||
id: channels
|
id: channels
|
||||||
title: Channels
|
title: Channels
|
||||||
sidebar_label: Channels
|
sidebar_label: Channels
|
||||||
|
sidebar_position: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: clients
|
id: clients
|
||||||
title: Clients
|
title: Clients
|
||||||
sidebar_label: Clients
|
sidebar_label: Clients
|
||||||
|
sidebar_position: 2
|
||||||
---
|
---
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: external-devices
|
id: external-devices
|
||||||
title: External Devices
|
title: External Devices
|
||||||
sidebar_label: External Devices
|
sidebar_label: External Devices
|
||||||
|
sidebar_position: 5
|
||||||
---
|
---
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,9 @@
|
||||||
---
|
---
|
||||||
id: overview
|
id: overview
|
||||||
title: Meshtastic Concepts
|
title: Meshtastic Concepts
|
||||||
sidebar_label: Concepts Overview
|
sidebar_label: Overview of Concepts
|
||||||
|
sidebar_position: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
|
@ -2,11 +2,12 @@
|
||||||
id: internet
|
id: internet
|
||||||
title: Internet Connectivity
|
title: Internet Connectivity
|
||||||
sidebar_label: Internet Connectivity
|
sidebar_label: Internet Connectivity
|
||||||
|
sidebar_position: 4
|
||||||
---
|
---
|
||||||
|
|
||||||
## Overview
|
## 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/web-app-software) 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.
|
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
|
## Features using Internet Connectivity
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: mesh
|
id: mesh
|
||||||
title: Mesh Routing
|
title: Mesh Routing
|
||||||
sidebar_label: Mesh Routing
|
sidebar_label: Mesh Routing
|
||||||
|
sidebar_position: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
title: About Meshtastic
|
title: About Meshtastic
|
||||||
sidebar_label: About
|
sidebar_label: About
|
||||||
slug: /about
|
slug: /about
|
||||||
|
sidebar_position: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
|
|
|
||||||
|
|
@ -34,11 +34,11 @@ The [Meshtastic-device](https://github.com/meshtastic/Meshtastic-device) is wher
|
||||||
|
|
||||||
## Device Support
|
## Device Support
|
||||||
|
|
||||||
The [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) is typically where the first device interaction takes place, but that is not a requirement. This repo has a command line utility that allows you to interact with most functionality with the devices. This python library can also be consumed for other applications. See [Community applications](/docs/software/community/community-overview) for other Meshtastic applications.
|
The [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) is typically where the first device interaction takes place, but that is not a requirement. This repo has a command line utility that allows you to interact with most functionality with the devices. This python library can also be consumed for other applications. See [Community applications](/docs/software/community) for other Meshtastic applications.
|
||||||
|
|
||||||
## Web Application
|
## Web Application
|
||||||
|
|
||||||
The [Meshtastic-web](https://github.com/meshtastic/meshtastic-web) is where the hosted web server on the ESP32 devices in Typescript is developed. See the [Web interface overview](/docs/software/web/web-app-software) for more details.
|
The [Meshtastic-web](https://github.com/meshtastic/meshtastic-web) is where the hosted web server on the ESP32 devices in Typescript is developed. See the [Web interface overview](/docs/software/web) for more details.
|
||||||
|
|
||||||
The [meshtastic.js](https://github.com/meshtastic/meshtastic.js) is a JavaScript library that provides an interface for Meshtastic devices.
|
The [meshtastic.js](https://github.com/meshtastic/meshtastic.js) is a JavaScript library that provides an interface for Meshtastic devices.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ The now-in-beta iOS app requires iOS v15.
|
||||||
|
|
||||||
### How do I get the Meshtastic iOS App?
|
### How do I get the Meshtastic iOS App?
|
||||||
|
|
||||||
See [iOS App](/docs/software/apple/ios-development)
|
See [iOS App](/docs/software/apple)
|
||||||
|
|
||||||
### After updating firmware, my node is not connecting via Bluetooth. What should I do?
|
### After updating firmware, my node is not connecting via Bluetooth. What should I do?
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -41,4 +41,4 @@ Push the left PWR button for about 1 second.
|
||||||
|
|
||||||
### Why does only one RAK Meshtastic Starter kit show up in my node list?
|
### Why does only one RAK Meshtastic Starter kit show up in my node list?
|
||||||
|
|
||||||
There was a bug where Meshtastic Starter kits were sent out with the same MAC address. With a single MAC address the devices all report as being the same device. Without the battery connected, flash the starter kit device(s) to 1.2.59 and then do a factory reset, disconnect and reconnect the board and run `meshtastic --info`.
|
There was a bug where Meshtastic Starter kits were sent out with the same MAC address. With a single MAC address the devices all report as being the same device. Without the battery connected, flash the starter kit device(s) to 1.2.59 and then do a [factory reset](/docs/settings/misc#factory_reset), disconnect and reconnect the board and run `meshtastic --info`.
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: faq
|
id: faq
|
||||||
title: FAQs
|
title: FAQs
|
||||||
slug: /faq
|
slug: /faq
|
||||||
|
sidebar_position: 6
|
||||||
---
|
---
|
||||||
|
|
||||||
<!---
|
<!---
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,7 @@ id: overview
|
||||||
title: Getting Started
|
title: Getting Started
|
||||||
sidebar_label: Getting Started
|
sidebar_label: Getting Started
|
||||||
slug: /getting-started
|
slug: /getting-started
|
||||||
|
sidebar_position: 2
|
||||||
---
|
---
|
||||||
|
|
||||||
import Link from '@docusaurus/Link';
|
import Link from '@docusaurus/Link';
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,14 @@
|
||||||
title: Hardware
|
title: Hardware
|
||||||
sidebar_label: Hardware
|
sidebar_label: Hardware
|
||||||
slug: /hardware
|
slug: /hardware
|
||||||
|
sidebar_position: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
We currently support devices that use the ESP32 and the nRF52 microcontrollers. Both of these offer low power consumption and long battery life, but each come with their own advantages:
|
We currently support devices that use the ESP32 and the nRF52 microcontrollers. Both of these offer low power consumption and long battery life, but each come with their own advantages:
|
||||||
|
|
||||||
## ESP32
|
## ESP32
|
||||||
|
|
||||||
The ESP32 devices have the advantage of having a Wifi interface. This allows you to connect to an access point, or run the device as an access point, and host the [web interface](/docs/software/web/web-app-software).
|
The ESP32 devices have the advantage of having a Wifi interface. This allows you to connect to an access point, or run the device as an access point, and host the [web interface](/docs/software/web).
|
||||||
|
|
||||||
The following ESP32 devices are supported:
|
The following ESP32 devices are supported:
|
||||||
|
|
||||||
|
|
|
||||||
7
docs/hardware/supported/_category_.yml
Normal file
7
docs/hardware/supported/_category_.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
|
||||||
|
position: 1 # float position is supported
|
||||||
|
label: 'Supported Hardware'
|
||||||
|
collapsible: true # make the category collapsible
|
||||||
|
link:
|
||||||
|
type: generated-index
|
||||||
|
title: Supported Hardware
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
title: Legal
|
title: Legal
|
||||||
sidebar_label: Legal
|
sidebar_label: Legal
|
||||||
slug: /legal
|
slug: /legal
|
||||||
|
sidebar_position: 7
|
||||||
---
|
---
|
||||||
|
|
||||||
## Disclaimers
|
## Disclaimers
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
title: Device Settings
|
title: Device Settings
|
||||||
sidebar_label: Device Settings
|
sidebar_label: Device Settings
|
||||||
slug: /settings
|
slug: /settings
|
||||||
|
sidebar_position: 5
|
||||||
---
|
---
|
||||||
|
|
||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
|
|
@ -27,7 +28,7 @@ For most, GPS is a really cool, desirable feature. Knowing where everyone on you
|
||||||
|
|
||||||
### WiFi Settings
|
### WiFi Settings
|
||||||
|
|
||||||
Whether you're using the upcoming [web interface](software/web/web-app-software) or you're interested in broadcasting messages to/from the internet using [MQTT](settings/mqtt), the [WiFi settings](settings/wifi) are your first stop towards an IoT radio.
|
Whether you're using the upcoming [web interface](software/web) or you're interested in broadcasting messages to/from the internet using [MQTT](settings/mqtt), the [WiFi settings](settings/wifi) are your first stop towards an IoT radio.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,10 @@
|
||||||
---
|
---
|
||||||
id: android-installation
|
id: android-installation
|
||||||
title: Android application installation
|
title: Android application installation
|
||||||
sidebar_label: Installation
|
sidebar_label: Android app
|
||||||
---
|
---
|
||||||
|
|
||||||
Our Android application is available to download on Google Play Store.
|
Our Android application is available to download on Google Play Store. This allows you to connect to your Meshtastic® device from your Android phone.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://play.google.com/store/apps/details?id=com.geeksville.mesh">
|
<a href="https://play.google.com/store/apps/details?id=com.geeksville.mesh">
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
id: ios-development
|
id: ios-development
|
||||||
title: iOS application development
|
title: iOS application development
|
||||||
sidebar_label: App development
|
sidebar_label: iOS & MacOS Apps
|
||||||
---
|
---
|
||||||
|
|
||||||
The Meshtastic iOS app is currently available in TestFlight as a public beta with a projected App Store release in early 2022.
|
The Meshtastic iOS app is currently available in TestFlight as a public beta with a projected App Store release in early 2022.
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: device-firmware
|
id: device-firmware
|
||||||
title: Device firmware
|
title: Device firmware
|
||||||
sidebar_label: Device firmware
|
sidebar_label: Device firmware
|
||||||
|
sidebar_position: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
The device firmware runs on the nodes to build the mesh for communication. Each different make and model of device requires a different build of the Meshtastic firmware in order to run properly. Thankfully, due to the design of Meshtastic, it is possible to port the firmware to new devices as they become available. The firmware currently runs on a range of ESP32 based devices, but there is also increasing support for the nRF52 microprocessor with some more recent devices coming to market.
|
The device firmware runs on the nodes to build the mesh for communication. Each different make and model of device requires a different build of the Meshtastic firmware in order to run properly. Thankfully, due to the design of Meshtastic, it is possible to port the firmware to new devices as they become available. The firmware currently runs on a range of ESP32 based devices, but there is also increasing support for the nRF52 microprocessor with some more recent devices coming to market.
|
||||||
|
|
@ -10,6 +11,10 @@ The current firmware has support for a screen to display received messages, alon
|
||||||
|
|
||||||
The latest firmware can be downloaded from the [Downloads](/downloads) page. If you wish to view the code or contribute to development of the firmware, please visit the device code <a href="https://github.com/meshtastic/Meshtastic-device">GitHub page</a>.
|
The latest firmware can be downloaded from the [Downloads](/downloads) page. If you wish to view the code or contribute to development of the firmware, please visit the device code <a href="https://github.com/meshtastic/Meshtastic-device">GitHub page</a>.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
Please be aware that there are significant changes between version branches 1.2.x and 1.3.x which mean that devices need to be running the same branch of firmware to be able to talk to each other. Python, Android, and other software applications will also need to be running the same branch to be able to talk to the device.
|
||||||
|
:::
|
||||||
|
|
||||||
### Buttons
|
### Buttons
|
||||||
|
|
||||||
A number of devices have buttons that can be used to interact with the firmware. These buttons have a number of different functions:
|
A number of devices have buttons that can be used to interact with the firmware. These buttons have a number of different functions:
|
||||||
|
|
@ -2,16 +2,17 @@
|
||||||
title: Software
|
title: Software
|
||||||
sidebar_label: Software
|
sidebar_label: Software
|
||||||
slug: /software
|
slug: /software
|
||||||
|
sidebar_position: 4
|
||||||
---
|
---
|
||||||
|
|
||||||
The following applications are available to support your Meshtastic network:
|
The following applications are available to support your Meshtastic network:
|
||||||
|
|
||||||
- The [firmware](/docs/software/device/device-firmware) to run on the devices
|
- The [firmware](/docs/software/device) to run on the devices
|
||||||
- Connect to the devices with our [Android app](/docs/software/android/android-installation)
|
- Connect to the devices with our [Android app](/docs/software/android)
|
||||||
- An [iOS application](/docs/software/apple/ios-development) is in the works
|
- An [iOS application](/docs/software/apple) is in the works
|
||||||
- [Meshtastic.js](/docs/software/js/getting-started) provides a JavaScript library to interface with devices
|
- [Meshtastic.js](/docs/software/js/getting-started) provides a JavaScript library to interface with devices
|
||||||
- [Meshtastic-python](/docs/software/python/python-installation) provides access from desktop computers including a command line interface
|
- [Meshtastic-python](/docs/software/python/python-installation) provides access from desktop computers including a command line interface
|
||||||
- A [web interface](/docs/software/web/web-app-software) can be accessed over Wifi on ESP32 devices
|
- A [web interface](/docs/software/web) can be accessed over Wifi on ESP32 devices
|
||||||
- Pre-installed device modules for:
|
- Pre-installed device modules for:
|
||||||
- [Range testing](/docs/software/modules/range-test-module)
|
- [Range testing](/docs/software/modules/range-test-module)
|
||||||
- [External notifications](/docs/software/modules/ext-notif-module)
|
- [External notifications](/docs/software/modules/ext-notif-module)
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: canned-message-module
|
id: canned-message-module
|
||||||
title: Canned messages
|
title: Canned messages
|
||||||
sidebar_label: Canned messages
|
sidebar_label: Canned messages
|
||||||
|
sidebar_position: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: ext-notif-module
|
id: ext-notif-module
|
||||||
title: External notifications
|
title: External notifications
|
||||||
sidebar_label: External notifications
|
sidebar_label: External notifications
|
||||||
|
sidebar_position: 2
|
||||||
---
|
---
|
||||||
|
|
||||||
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
id: modules
|
id: modules
|
||||||
title: Modules overview
|
title: Modules overview
|
||||||
sidebar_label: Overview
|
sidebar_label: Built-in modules
|
||||||
---
|
---
|
||||||
|
|
||||||
There are a number of modules that have been integrated into the device firmware. These can be turned on using the Meshtastic python command line program. Please note that these modules require the device to be rebooted once they have been enabled for them to start running.
|
There are a number of modules that have been integrated into the device firmware. These can be turned on using the Meshtastic python command line program. Please note that these modules require the device to be rebooted once they have been enabled for them to start running.
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: range-test-module
|
id: range-test-module
|
||||||
title: Range Test Module
|
title: Range Test Module
|
||||||
sidebar_label: Range Test
|
sidebar_label: Range Test
|
||||||
|
sidebar_position: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: serial-module
|
id: serial-module
|
||||||
title: Serial communication module
|
title: Serial communication module
|
||||||
sidebar_label: Serial communication
|
sidebar_label: Serial communication
|
||||||
|
sidebar_position: 4
|
||||||
---
|
---
|
||||||
|
|
||||||
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: store-forward-module
|
id: store-forward-module
|
||||||
title: Store and Forward Module
|
title: Store and Forward Module
|
||||||
sidebar_label: Store and Forward
|
sidebar_label: Store and Forward
|
||||||
|
sidebar_position: 5
|
||||||
---
|
---
|
||||||
|
|
||||||
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
id: telemetry-module
|
id: telemetry-module
|
||||||
title: Telemetry
|
title: Telemetry
|
||||||
sidebar_label: Telemetry
|
sidebar_label: Telemetry
|
||||||
|
sidebar_position: 6
|
||||||
---
|
---
|
||||||
|
|
||||||
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
id: web-app-software
|
id: web-app-software
|
||||||
title: Web interface overview
|
title: Web interface overview
|
||||||
sidebar_label: Overview
|
sidebar_label: Web Interface
|
||||||
---
|
---
|
||||||
|
|
||||||
<!--- FIXME add self hosting details link --->
|
<!--- FIXME add self hosting details link --->
|
||||||
Loading…
Reference in a new issue