meshtastic/docs/getting-started/clients.md

63 lines
2.3 KiB
Markdown
Raw Normal View History

---
id: clients
title: Clients Overview
sidebar_label: Clients Overview
---
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-02-28 16:14:51 -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-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:
```bash title="Install Meshtastic-python (includes CLI)"
pip install meshtastic
```
```bash title="Upgrade Meshtastic-python (includes CLI)"
pip install --upgrade meshtastic
```
2022-02-28 16:14:51 -08:00
:::note
Some installations of python may require you to substitute 'pip3' for the 'pip' command.
:::
### Mobile Client Downloads
<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 |
| :------: | :-------: | :----: | :-------: |
| `921600` | `8` | `None` | `1` |
### Web