meshtastic/docs/software/web-client.mdx

57 lines
2.4 KiB
Plaintext
Raw Normal View History

2021-04-15 03:19:53 -07:00
---
2022-11-03 19:54:37 -07:00
id: web-client
title: Web Client Overview
sidebar_label: Web Client
sidebar_position: 3
2021-04-15 03:19:53 -07:00
---
2022-12-10 23:12:02 -08:00
Meshtastic Web is a Meshtastic client that runs directly in your browser.
2022-03-07 21:24:01 -08:00
There are three ways of accessing the app:
2022-03-03 20:36:12 -08:00
2022-03-07 21:24:01 -08:00
1. Served directly from an ESP32 based node via [meshtastic.local](http://meshtastic.local) or the device's IP Address.
2. A hosted version located at [client.meshtastic.org](https://client.meshtastic.org).
2022-12-10 23:12:02 -08:00
3. Hosting it yourself.
![WebUI](/img/webUI.png)
2022-03-03 20:36:12 -08:00
2022-03-07 21:24:01 -08:00
## Compatibility
2021-04-15 03:19:53 -07:00
The application will work in all major browsers, but specific functionality is limited in some cases. For the best experience we recommend using a Chromium based browser such as [Google Chrome](https://www.google.com/chrome) or [Microsoft Edge](https://www.microsoft.com/en-us/edge).
2022-03-07 21:24:01 -08:00
### HTTP
2022-12-10 23:12:02 -08:00
This method of connecting is limited to esp32 devices.
2022-02-25 09:19:19 -08:00
:::caution
When using the [hosted](https://client.meshtastic.org) version of the application, all traffic must be served over HTTPS.
Meshtastic nodes generate self-signed certificates, and you must inform your browser that you wish to trust the aforementioned certificate.
2022-03-07 21:24:01 -08:00
This can be done by first accessing your node directly via your browser: `https://NODE_IP_ADDRESS/` replacing `NODE_IP_ADDRESS` with the IP address of your node.
This can be found on the screen of the device, via your router's DHCP lease page or serial console.
2022-02-25 09:19:19 -08:00
:::
2022-12-10 23:12:02 -08:00
You can accessing your device over HTTP after you set up your [Network Connection](/docs/settings/config/network)
2022-03-07 21:24:01 -08:00
### Bluetooth
Bluetooth support is governed by the availability of the [Web Bluetooth API](https://web.dev/bluetooth) as illustrated below. Support is primarily available in Chromium based browsers.
2022-03-07 21:24:01 -08:00
2022-11-02 11:46:54 -07:00
![Web Bluetooth compatibility matrix](https://caniuse.bitsofco.de/image/web-bluetooth.png)
2022-03-07 21:24:01 -08:00
### Serial (USB)
The method with the least platform support, which uses the [Web Serial API](https://web.dev/serial), allows us to connect directly to a Meshtastic node over USB and access it from directly within your browser.
2022-03-07 21:24:01 -08:00
2022-11-02 11:46:54 -07:00
![Web Serial compatibility matrix](https://caniuse.bitsofco.de/image/web-serial.png)
2022-03-07 21:24:01 -08:00
## Updating
2022-02-25 09:19:19 -08:00
2022-12-10 23:12:02 -08:00
The web interface is included in firmware releases. When a new firmware version is released, the latest WebUI will be automatically bundled.
2022-02-25 09:19:19 -08:00
2022-12-10 23:12:02 -08:00
## Self Hosting
2022-02-25 09:19:19 -08:00
2022-12-10 23:12:02 -08:00
The source code for the WebUI can be found on out [GitHub](https://github.com/meshtastic/web)
2022-02-25 09:19:19 -08:00
2022-12-10 23:12:02 -08:00
Instructions for building and running the project can be found in the repo's readme.