mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-28 23:19:47 -08:00
Merge pull request #179 from mkinney/add_standalone
add standalone python info
This commit is contained in:
commit
2fc1b524c2
|
@ -6,13 +6,15 @@ sidebar_label: Installation
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
This library provides a command line interface for Meshtastic nodes and provides an easy API for sending and receiving messages over mesh radios, in addition to changing user settings. Using the command line is currently the most powerful. Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in.
|
||||
This library provides a command line interface (CLI) for Meshtastic nodes and provides an easy API for sending and receiving messages over mesh radios, in addition to changing user settings. Using the command line is currently the most powerful. Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in.
|
||||
|
||||
[Full documentation](https://meshtastic.org/docs/software/python/python-installation) for the library, including examples, is available.
|
||||
|
||||
If you wish to view the code or contribute to development of the python library or the command line interface, please visit the Meshtastic python <a href="https://meshtastic.org/docs/software/python/python-installation">GitHub page</a>.
|
||||
|
||||
Installation is easily done through the [Python package installer pip](https://pypi.org/project/meshtastic/):
|
||||
There are standalone executables for Mac, Windows and Ubuntu if you do not want to install python and/or the python libraries required to run the mestastic CLI tool. See [Standalone](https://meshtastic.org/docs/software/python/python-standalone) for more information.
|
||||
|
||||
Installation can also be easily done through the [Python package installer pip](https://pypi.org/project/meshtastic/):
|
||||
:::note
|
||||
You must use pip version 20 or later. To upgrade to the latest pip, do: `pip install --upgrade pip`
|
||||
:::
|
||||
|
|
64
docs/software/python/standalone.md
Normal file
64
docs/software/python/standalone.md
Normal file
|
@ -0,0 +1,64 @@
|
|||
---
|
||||
id: python-standalone
|
||||
title: Meshtastic-python standalone executable
|
||||
sidebar_label: Standalone
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
There are standalone executable files for Mac, Windows and Ubuntu. A single file is all you need to run the command line interface (CLI) Meshtastic tool. There is a zip file per operating system. To use, see the operating system specific notes below:
|
||||
|
||||
|
||||
<Tabs
|
||||
groupId="operating-system"
|
||||
defaultValue="windows"
|
||||
values={[
|
||||
{label: 'Ubutnu', value: 'ubuntu'},
|
||||
{label: 'macOS', value: 'macos'},
|
||||
{label: 'Windows', value: 'windows'},
|
||||
]}>
|
||||
<TabItem value="ubuntu">
|
||||
|
||||
* Download meshtastic_ubuntu.zip
|
||||
|
||||
* Unzip.
|
||||
|
||||
* Run: "chmod +x meshtastic"
|
||||
|
||||
* To run: "./meshtastic"
|
||||
|
||||
* Tip: Copy (or move) this binary somewhere in your path.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
* Download meshtastic_mac.zip
|
||||
|
||||
* Unzip.
|
||||
|
||||
* Run: "chmod +x meshtastic"
|
||||
|
||||
* Try to run it: "./meshtastic". You may get a dialog that says:
|
||||
"meshtastic" can't be opened because Apple cannot check it for malicious software.
|
||||
|
||||
* To fix, go into "System Preferences", "Security & Privacy", "General" tab, and click on the "Allow Anyway" button.
|
||||
|
||||
* Try to run it again: "./meshtastic". You may get a dialog that says:
|
||||
"meshtastic" can't be opened because Apple cannot check it for malicious software.
|
||||
Click "Open".
|
||||
|
||||
* Now when you want to run it, you can simply run "./meshtastic".
|
||||
|
||||
* Tip: Copy (or move) this binary somewhere in your path.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
* Download meshtastic_windows.zip
|
||||
|
||||
* Unzip.
|
||||
|
||||
* To run, double click on "meshtastic.exe" or from a command prompt run "./meshtastic.exe"
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
|
@ -50,6 +50,7 @@ module.exports = {
|
|||
{
|
||||
"Meshtastic-python": [
|
||||
"software/python/python-installation",
|
||||
"software/python/python-standalone",
|
||||
"software/python/python-cli",
|
||||
"software/python/python-uses",
|
||||
"software/python/python-commands",
|
||||
|
|
Loading…
Reference in a new issue