0020fd7330
All other docs simply use "meshtastic" as the command to execute when we give example commands. I've added commands to these instructions (for windows, mac & linux) which will rename the meshtastic_ubuntu, meshtastic_mac or meshtastic_windows to simply 'meshtastic' so that user attempts to follow other documentation provided have a better chance at success. |
||
|---|---|---|
| .github | ||
| assets | ||
| docs | ||
| protobufs@d185455837 | ||
| src | ||
| static | ||
| .env.example | ||
| .gitignore | ||
| .gitmodules | ||
| 1.1 1.5 feature list ideas.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| How to configure a device as a relay.md | ||
| package.json | ||
| protobuf.tmpl | ||
| README.md | ||
| sidebars.js | ||
| tsconfig.json | ||
| yarn.lock | ||
Website
Forum
Discord
App
What is Meshtastic?
Meshtastic® is a project that lets you use inexpensive LoRa radios as a long range off-grid communicator for areas without reliable cellular service. These radios are great for hiking, skiing, paragliding - essentially any hobby where you don't have reliable internet access. Each member of the mesh can send and view text messages and enable optional GPS based location features.
The radios automatically create a mesh to forward packets as needed, so everyone in the group can receive messages from even the furthest member. The radios will optionally work with your phone, but no phone is required.
Meshtastic uses LoRa for the long range communications and depending on settings used, the maximum theoretical group size ranges from 30-200 device nodes. Currently each device can only support a connection from a single user at a time.
Please see our website for more information about Meshtastic.
Installation
nodejs is required in your dev. environment. The method for installing nodejs depends on your operating system. This software is built using Docusaurus.
Fork then clone the repository:
git clone https://github.com/meshtastic/meshtastic
Go to the root directory of your repository and install dependencies:
yarn install
Build the project with the following command
yarn build
Start a local dev. instance with the following command
yarn start