meshtastic/docs/getting-started/first-steps/clients.mdx

109 lines
4 KiB
Plaintext
Raw Normal View History

---
id: clients
2022-04-29 14:39:06 -07:00
title: Connect to Clients
sidebar_label: Connect to Clients
sidebar_position: 1
---
2022-03-08 23:51:46 -08:00
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)
2022-03-03 20:43:52 -08:00
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).
2022-03-14 19:34:50 -07:00
#### Installation
2022-02-28 16:14:51 -08:00
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
```
2022-03-08 23:51:46 -08:00
```shell title="Upgrade Meshtastic-python (includes CLI)"
pip install --upgrade meshtastic
```
2022-03-08 23:51:46 -08:00
2022-02-28 16:14:51 -08:00
:::note
2022-03-03 20:43:52 -08:00
Some installations of python may require you to substitute 'pip3' for the 'pip' command.
2022-02-28 16:14:51 -08:00
:::
2022-03-14 19:34:50 -07:00
#### Verify Connection
2022-03-13 12:00:10 -07:00
2022-03-14 19:34:50 -07:00
After installing, run one of the following commands to see if the device is communicating correctly.
```shell title="View connected node info"
2022-03-13 12:00:10 -07:00
meshtastic --info
```
```shell title="View nodes detected on mesh"
2022-03-14 19:34:50 -07:00
meshtastic --nodes
```
For more details about CLI usage, see the [settings](/docs/settings) pages or [CLI guide](/docs/software/python/python-cli).
2022-03-13 12:00:10 -07:00
### Mobile Client Downloads
2022-03-08 23:51:46 -08:00
<ul
style={{
position: 'relative',
display: 'grid',
gap: '1.5rem',
gridTemplateColumns: 'repeat(auto-fill, minmax(280px, 1fr))',
paddingLeft: '0',
}}
>
<DownloadCard
client="Android"
imgUrl="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
url="https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source=downloads-page"
notes={[
'To sideload, ',
<a
href="https://github.com/meshtastic/Meshtastic-Android/releases/latest"
rel="noreferrer"
target="_blank"
>
download the latest .apk
</a>,
' from Github',
]}
/>
<DownloadCard
client="iOS"
url="https://testflight.apple.com/join/c8nNl8q1"
buttonText="Download on TestFlight"
notes="Currently only available in TestFlight"
/>
</ul>
### 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 |
| :------: | :-------: | :----: | :-------: |
2022-03-08 23:51:46 -08:00
| `921600` | `8` | `None` | `1` |
### Web
2022-03-03 20:36:12 -08:00
<!--- FIXME add self hosting details link --->
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:
2022-03-03 20:43:52 -08:00
- [client.meshtastic.org](https://client.meshtastic.org)
2022-03-03 20:36:12 -08:00
- 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.
2022-04-29 14:39:06 -07:00
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.