diff --git a/docs/getting-started/first-steps/clients.mdx b/docs/getting-started/first-steps/clients.mdx deleted file mode 100644 index 3f33c9ee..00000000 --- a/docs/getting-started/first-steps/clients.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: clients -title: Connect to Clients -sidebar_label: Connect to Clients -sidebar_position: 1 ---- - -import { DownloadCard } from '/src/pages/downloads/_components/DownloadCard.tsx'; - -## Overview - -There are many ways to connect to your newly flashed device. Below is a quickstart for each client that you can use to connect to your radio. - -### Commandline Interface (CLI) - -The CLI is currently the best way to manage your settings. It is feature rich and well documented. The [settings pages](/docs/settings) have examples for each user preference for the device. The CLI is available as a standalone executable for Windows, Mac OS or linux or as part of the [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) project. If you'd like to use python to interface with a device, see the [API documentation](https://python.meshtastic.org). - -#### Installation - -To install the prebuilt binary refer to: [Meshtastic-python standalone executable](/docs/software/python/python-standalone). - -To install/upgrade Meshtastic-python manually, see below: - -```shell title="Install Meshtastic-python (includes CLI)" -pip install meshtastic -``` - -```shell title="Upgrade Meshtastic-python (includes CLI)" -pip install --upgrade meshtastic -``` - -:::note -Some installations of python may require you to substitute 'pip3' for the 'pip' command. -::: - -#### Verify Connection - -After installing, run one of the following commands to see if the device is communicating correctly. - -```shell title="View connected node info" -meshtastic --info -``` - -```shell title="View nodes detected on mesh" -meshtastic --nodes -``` - -For more details about CLI usage, see the [settings](/docs/settings) pages or [CLI guide](/docs/software/python/python-cli). - -### Mobile Client Downloads - - - -### Serial - -Using your preferred program (PuTTy, Serial, etc) connect to your device with the following settings to see the logs in real time. - -| Baudrate | Data Bits | Parity | Stop Bits | -| :------: | :-------: | :----: | :-------: | -| `921600` | `8` | `None` | `1` | - -### Web - - - -The web interface is available for all browsers, but [bluetooth and serial capabilities are limited](https://github.com/meshtastic/meshtastic.js#compatibility). You can connect to your node using: - -- [client.meshtastic.org](https://client.meshtastic.org) - - BLE - - HTTP - - Serial -- [ESP32 WiFi SoftAP](/docs/settings/wifi#software-access-point) -- [ESP32 as Client](/docs/settings/wifi#wifi-client) - -The Meshtastic firmware incorporates an embedded web server using the [ESP32 HTTPS Server](https://github.com/fhessel/esp32_https_server) project. This allows the WiFi supporting ESP32 devices to run our web interface to access Meshtastic directly from your browser. This imports the [Meshtastic.js library](/docs/software/js/getting-started) to provide a web page capable of interacting with the device. - -There is active development ongoing to fix some issues with updating the web interface from the web interface directly. Please be patient with us as we work on this. Use [Meshtastic-flasher](/docs/getting-started/flashing-firmware/meshtastic-flasher) to update your device to the current stable build which includes the web interface. diff --git a/docs/getting-started/first-steps/configuration.mdx b/docs/getting-started/first-steps/configuration.mdx deleted file mode 100644 index 05ddb408..00000000 --- a/docs/getting-started/first-steps/configuration.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: configuration -title: Configure Device -sidebar_label: Configure Device -sidebar_position: 2 ---- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -The following are important steps you should take before transmitting any messages. Make sure that you have flashed your device with Meshtastic and connected with a client before proceeding. - -### Set Region - -:::important -Make sure to set your `region` to the correct region so you don't transmit on an incorrect frequency. -::: - -The `region` variable sets which region your radio is configured to work in. It is important to ensure that you've set it to the correct region. If left `Unset`, it will default to `US` settings. - -| Name | Center Frequency | Spacing | Number of Channels | Power Limit | -| :---: | :--------------: | :-----: | :----------------: | :---------: | -| US | 903.08 | 2.16 | 13 | 0 | -| EU433 | 433.175 | 0.2 | 8 | 0 | -| EU868 | 865.2 | 0.3 | 10 | 0 | -| CN | 470.0 | 2.0 | 20 | 0 | -| JP | 920.0 | 0.5 | 10 | 13 | -| ANZ | 916.0 | 0.5 | 20 | 0 | -| KR | 921.9 | 0.2 | 8 | 0 | -| TW | 923.0 | 0.2 | 10 | 0 | -| RU | 868.9 | 0.2 | 2 | 20 | -| Unset | 903.08 | 2.16 | 13 | 0 | - -:::note -For more details about `region` settings, you can see the source code [here](https://github.com/meshtastic/Meshtastic-device/blob/master/src/mesh/RadioInterface.cpp) -::: -| Setting | Acceptable Values | Default | -| :--: | :---: | :------: | -| region | `Unset`, `US`, `EU433`, `EU865`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` | `Unset` | - - - - -```shell title="Unset Region" -meshtastic --set region Unset -``` - -```shell title="Set Region" -meshtastic --set region US -``` - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - diff --git a/docs/getting-started/first-steps/index.mdx b/docs/getting-started/first-steps/index.mdx deleted file mode 100644 index 37525f95..00000000 --- a/docs/getting-started/first-steps/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: first-steps -title: First Steps -sidebar_label: First Steps -sidebar_position: 2 ---- -Congratulations! Your device should now be running Meshtastic! The next few pages should help you connect to your device and do some important initial configuration. After that, you'll be able to begin testing out your device on the mesh. Welcome to Meshtastic! - -## Troubleshooting - -Hopefully your firmware flashing experience has been straight forward and headache free. If you've had issues, please consider updating our documentation to improve future user experiences. If you're still having issues. Reach out on the [forum](https://meshtastic.discourse.group) or [Discord](https://discord.gg/ktMAKGBnBs). Our support is 100% volunteer based. We are passionate about the project hope to help newcomers become Meshtastic experts. diff --git a/docs/getting-started/first-steps/mesh-testing.mdx b/docs/getting-started/first-steps/mesh-testing.mdx deleted file mode 100644 index 556f9dc1..00000000 --- a/docs/getting-started/first-steps/mesh-testing.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: tests -title: Mesh Testing -sidebar_label: Mesh Testing -sidebar_position: 3 ---- -### Connect via USB and CLI - -If you have at least two radios with the Meshtastic firmware, you may consider connecting one via USB and the other battery powered. Communicate with the USB radio using a CLI like [Meshtastic-python](/docs/software/python/python-installation). - -- Ensure you can run `meshtastic --info`. -- Ensure the region is set appropriately. If the radios are 915 MHz and you are in the US, then no region changes/settings are necessary. If you are in another region, you may need to run something like: `meshtastic --set region EU865`. -- Send a message `meshtastic --sendtext hello1` -- Note: The radio connected via USB will not show messages sent. -- After a few seconds the other radios will show the message. You may need to press one of the buttons on the other radio to see if the message arrived. -- Run `meshtastic --nodes` to see if other nodes show in the display. -- Messages sent from the USB radio should be sent to the other radio(s) via LoRa. The default settings should allow this to work. - -### Connect via Bluetooth - -The Android app is currently more robust than the iOS app. But, they both should be able to interact with the radios. - -- Install Android or iOS Meshtastic app -- Start Meshtastic app -- Connect to radio(s) from inside the app -- Pair with radio(s). A paring code should show on the radio. Enter that value when prompted to pair a Bluetooth device. -- In the event you don't have a screen. double press the io button and the value will be set to 123456. (on the tbeam this is the center button) -- Send message(s) from inside the app. -- Note: The radio connected via Bluetooth will not show messages sent. -- Verify that all other radios are receiving the message(s). Might have to click on the button on the radio to see most recent message. - -### Connect via WiFi/HTTP - -- Configure the _wifi_ssid_ and _wifi_password_. `meshtastic --set wifi_ssid 'xxx' --set wifi_password 'yyy'` (where xxx and yyy are the appropriate values for your network) -- Reboot radio by either removing power or pressing the power button. -- Click on the button to cycle through to the screen with IP address and verify that there was a connection to the Wifi access point. -- Send message(s). `meshtastic --host 192.168.1.200 --sendtext hello` -- Note: The radio connected via Wifi will not show messages sent. -- Verify that all radios are receiving the message(s). Might have to click on the button on the radio(s) to see most recent message. -- Open up a browser to http://meshtastic.local to view the web UI (currently under development). You may need to open http://meshtastic.local/static ) -- If you want to switch back to Bluetooth, you will need to set the _wifi_ssid_ and _wifi_password_ values to blank values (ex: `meshtastic --set wifi_ssid '' --set wifi_password ''`). diff --git a/docs/getting-started/flashing-firmware/flashing-esp32.mdx b/docs/getting-started/flashing-firmware/flashing-esp32.mdx index 417f8a94..7d0cab8a 100644 --- a/docs/getting-started/flashing-firmware/flashing-esp32.mdx +++ b/docs/getting-started/flashing-firmware/flashing-esp32.mdx @@ -1,9 +1,8 @@ --- id: flashing-esp32 -title: Flashing ESP32 devices firmware -sidebar_label: CLI Script - ESP32 devices +title: Flashing ESP32 device firmware +sidebar_label: CLI Script - ESP32 pagination_prev: getting-started/flashing-firmware/flashing-firmware -pagination_next: getting-started/first-steps/first-steps sidebar_position: 3 --- @@ -14,15 +13,11 @@ import TabItem from '@theme/TabItem'; Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip! ::: -## Prerequisites -### Device connectivity +For ESP32 devices if the device already has a version of Meshtastic installed using the OTA firmware upgrade tool in the Android app is the friendliest path for users. OTA firmware updates are not yet available on Apple platforms. -Ensure your computer is communicating with the device correctly by following [these instructions](/docs/getting-started/flashing-firmware/). - -### Download Latest Firmware - -Firmware can be downloaded from the [Downloads](/downloads) page. Your initial installation has to happen over USB from your Mac, Windows, or Linux computer. Over the air updates are currently only available using the Android application after this initial installation. +If your ESP32 device does not have Meshtastic pre-installed flashing +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. :::note The [T-Beam 0.7](/docs/hardware/supported/tbeam#t-beam---v07) board is an earlier version of the T-Beam board, and due to changes in the design in subsequent iterations this board uses a specific firmware file different from the other T-Beam boards. 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 b6f9af5b..ceddce06 100644 --- a/docs/getting-started/flashing-firmware/flashing-external-serial-adapter.mdx +++ b/docs/getting-started/flashing-firmware/flashing-external-serial-adapter.mdx @@ -3,8 +3,7 @@ id: flashing-external-serial-adapter title: Flashing Firmware with an External Serial Adapter - ESP32 sidebar_label: Serial Adapter - ESP32 pagination_prev: getting-started/flashing-firmware/flashing-firmware -pagination_next: ge -tting-started/flashing-firmware/meshtastic-flasher +pagination_next: getting-started/flashing-firmware/meshtastic-flasher sidebar_position: 5 --- diff --git a/docs/getting-started/flashing-firmware/flashing-nrf52.mdx b/docs/getting-started/flashing-firmware/flashing-nrf52.mdx index 37f6c3ed..b22b7e42 100644 --- a/docs/getting-started/flashing-firmware/flashing-nrf52.mdx +++ b/docs/getting-started/flashing-firmware/flashing-nrf52.mdx @@ -1,54 +1,21 @@ --- id: flashing-nrf52 -title: Flashing nRF52 devices firmware -sidebar_label: Drag & Drop - NRF52 devices +title: Drag & Drop NRF52 Firmware Updates +sidebar_label: Drag & Drop - NRF52 pagination_prev: getting-started/flashing-firmware/flashing-firmware -pagination_next: getting-started/first-steps/first-steps +pagination_next: getting-started/flashing-firmware/flashing-esp32 sidebar_position: 2 --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -The NRF52 based devices (LilyGO T-Echo, RAK Wisblock 4631) have the easiest firmware upgrade process. (No driver install is required on any platform) -You click the reset button on your device twice quickly and a drive will appear on Windows, Mac and Linux. +The NRF52 based devices (LilyGO T-Echo, RAK Wisblock 4631) have the easiest firmware upgrade process. (No driver or software install is required on any platform) -Drop the [appropriate .uf2 file from the release you want to install](https://github.com/meshtastic/Meshtastic-device/releases) onto this drive and the meshtastic firmware will be installed on the device. +Connect your device to your computer with a data USB cable. Double click the reset button on your device, this will put it into bootloader mode and and a drive will appear on Windows, Mac and Linux. +A new drive will be mounted on your computer. Open this drive and you should see three files: `CURRENT.UF2`, `INDEX.HTM`, and `INFO_UF2.TXT` -### Device connectivity +Drop the appropriate appropriate `firmware-xxxxx-1.3.x.uf2` file from the release you want to install onto this drive and the meshtastic firmware will be installed on the device. Once the file has finished copying onto the drive the device will reboot and load Meshtastic. -Ensure your computer is communicating with the device correctly by following [these instructions](/docs/getting-started/flashing-firmware/). - -### Download Latest Firmware - -Firmware can be downloaded from the [Downloads](/downloads) page. Your initial installation has to happen over USB from your Mac, Windows, or Linux computer. Over the air updates are currently only available using the Android application after this initial installation. - -### WisBlock RAK4631 Bootloader - -Please ensure that you have updated the bootloader to the latest version using the information on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#how-to-check-if-you-have-the-updated-rak4631-bootloader) website. - -:::tip -[Meshtastic Flasher](/docs/getting-started/flashing-firmware/meshtastic-flasher) can assist you in updating the bootloader to the latest version. -::: - -## Install/Update Firmware - -:::caution -Be careful to install the correct load for your board. While it is unlikely that you will cause damage to your device, the wrong firmware will cause it to not work. -::: - -- Connect your device to your computer with a USB cable. If your computer complains about needing to format a new drive, cancel the format command. -- Double click the `Reset` button on your device, this will put it into bootloader mode. - -[LILYGO T-Echo](/img/hardware/t-echo-lilygo.jpg) - -- A new drive will then be mounted on your computer. Open this drive and you should see three files: `CURRENT.UF2`, `INDEX.HTM`, and `INFO_UF2.TXT` -- Copy the appropriate `firmware-xxxxx-1.2.x.uf2` file from the firmware zip file onto the new drive. - -:::note -You are going to copy/drop "as is" 'firmware-xxxxx-1.2.x.uf2' (_NOT_ over the "CURRENT.UF2" file) in the volume, and the device reboot will copy it/load it correctly. -::: - -- Once the file has finished copying over, the device will reboot, loading the new firmware as it does. diff --git a/docs/getting-started/flashing-firmware/index.mdx b/docs/getting-started/flashing-firmware/index.mdx index 7a4df084..d8e6eab8 100644 --- a/docs/getting-started/flashing-firmware/index.mdx +++ b/docs/getting-started/flashing-firmware/index.mdx @@ -13,25 +13,17 @@ import TabItem from '@theme/TabItem'; Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip! ::: +## Meshtastic Flasher GUI Application + For most users we recommend using the [Meshtastic Flasher application](/docs/getting-started/flashing-firmware/meshtastic-flasher). It does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device. -If you choose to flash the firmware using the manual method, [ESP32 based devices](/docs/getting-started/flashing-firmware/flashing-esp32) and [NRF52 based devices](/docs/getting-started/flashing-firmware/flashing-nrf52) have different methods. Select the appropriate one. If you don't know what chipset your device is, take a look at our supported hardware section. - - -## Download Latest Firmware +## Manual Firmware Installation Firmware can be downloaded from the [Downloads](/downloads) page. Your initial installation has to happen over USB from your Mac, Windows, or Linux computer. -### Flashing NRF52 Based Devices +If you choose to flash the firmware using the manual method, [ESP32 based devices](/docs/getting-started/flashing-firmware/flashing-esp32) and [NRF52 based devices](/docs/getting-started/flashing-firmware/flashing-nrf52) have different methods. Select the appropriate one. If you don't know what chipset your device is, take a look at our supported hardware section. -### Flashing ESP32 Based Devices - -For ESP32 devices if the device already has a version of Meshtastic installed using the OTA firmware upgrade tool in the Android app is the friendliest path for users. OTA firmware updates are not yet available on Apple platforms. - -If your ESP32 device does not have Meshtastic pre-installed flashing -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 +## Verify data cable Verify you have a data cable (not a charging only cable) before proceeding. There's no definitive way to determine the difference in cables if you aren't willing to pull it apart. Trying out a few cables will be the best way to verify. @@ -41,48 +33,7 @@ Once you've located a data cable, check the following to see if you need to inst If you know you have installed the correct driver, the following step can be used to check if your cable is a data cable. ::: -### Test for driver installation - -You can verify that you have a proper data cable (rather than a charge-only type cable) and that the appropriate drivers for your system are installed by performing the following test. Select your operating system below. - -If you can see your device, you are ready to flash the firmware. Skip to the [Choose Firmware Flashing Method section](#choose-firmware-flashing-method). - -If you don't see your device in the following test, you either: - -1. Need to [install a driver](#install-appropriate-drivers). -2. Are currently using a charging only cable. - - - -Connect your Meshtastic device to your USB port, open a `Terminal` and enter the following command: - -```shell -lsusb -``` - -You should see something like: `ID xxxx:xxxx Silicon Labs CP210x UART Bridge`, `ID xxxx:xxxx QinHeng Electronics USB Single Serial`, or `FIXME (WISBLOCK OUTPUT)`. - - - - -Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB`. You should see something like `CP210X USB to UART Bridge Controller`, `CH9102 USB to UART Bridge Controller`, or `WisCore RAK4631 Board`. If not download the appropriate drivers below. - - - - -Navigate to `Device Manager > Ports (COM & LPT)`. You should see something like `Silicon Labs CP210X USB to UART Bridge (COM5)`, `Silicon Labs CH9102 USB to UART Bridge (COM5)`, or `FIXME (WISBLOCK OUTPUT)`. If not download the appropriate drivers below. - - - - -## Install Appropriate Drivers +## Install USB to Serial Drivers ### ESP32 Drivers @@ -181,4 +132,45 @@ With the latest versions of MacOS, the USB Serial driver is built-in. Do _NOT_ d :::important Reboot your computer after you have installed the driver to complete the installation. -::: \ No newline at end of file +::: + +### Test for driver installation + +You can verify that you have a proper data cable (rather than a charge-only type cable) and that the appropriate drivers for your system are installed by performing the following test. Select your operating system below. + +If you can see your device, you are ready to flash the firmware. Skip to the [Choose Firmware Flashing Method section](#choose-firmware-flashing-method). + +If you don't see your device in the following test, you either: + +1. Need to [install a driver](#install-appropriate-drivers). +2. Are currently using a charging only cable. + + + +Connect your Meshtastic device to your USB port, open a `Terminal` and enter the following command: + +```shell +lsusb +``` + +You should see something like: `ID xxxx:xxxx Silicon Labs CP210x UART Bridge`, `ID xxxx:xxxx QinHeng Electronics USB Single Serial`, or `FIXME (WISBLOCK OUTPUT)`. + + + + +Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB`. You should see something like `CP210X USB to UART Bridge Controller`, `CH9102 USB to UART Bridge Controller`, or `WisCore RAK4631 Board`. If not download the appropriate drivers below. + + + + +Navigate to `Device Manager > Ports (COM & LPT)`. You should see something like `Silicon Labs CP210X USB to UART Bridge (COM5)`, `Silicon Labs CH9102 USB to UART Bridge (COM5)`, or `FIXME (WISBLOCK OUTPUT)`. If not download the appropriate drivers below. + + + diff --git a/docs/getting-started/flashing-firmware/meshtastic-flasher.mdx b/docs/getting-started/flashing-firmware/meshtastic-flasher.mdx index 889a5965..6c91f0de 100644 --- a/docs/getting-started/flashing-firmware/meshtastic-flasher.mdx +++ b/docs/getting-started/flashing-firmware/meshtastic-flasher.mdx @@ -2,8 +2,9 @@ id: meshtastic-flasher title: Using Meshtastic Flasher sidebar_label: Meshtastic Flasher -pagination_next: getting-started/first-steps/first-steps pagination_prev: getting-started/flashing-firmware/flashing-firmware +pagination_next: getting-started/flashing-firmware/flashing-nrf52 + sidebar_position: 1 --- diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 2ad56995..7a3e3645 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -47,32 +47,6 @@ Meshtastic uses LoRa for the long range communications and depending on settings -## Connect to your Device - -There are many ways to connect to your new radio! - -
- - Connect to Node - -
- -## Use Meshtastic - -This is the best part of Meshtastic. Deploying, testing, and optimizing your personal mesh network. Click below for first steps, configurations, and tests. - -
- - First Steps - -
- ## Troubleshooting Hopefully your "getting started" experience has been straight forward and headache free. If you've had issues, please consider updating our documentation to improve future user experiences. If you're still having issues. Reach out on the [forum](https://meshtastic.discourse.group) or [Discord](https://discord.gg/ktMAKGBnBs). Our support is 100% volunteer based. We are passionate about the project hope to help newcomers become Meshtastic experts.