Merge pull request #31 from apt105/python

Python lib and CLI explanation pages

website/docs/software/python/cli.md

@@ -0,0 +1,111 @@
+---
+id: python-cli
+title: Command line interface
+sidebar_label: CLI usage
+---
+
+This pip package will also install a "meshtastic" command line executable, which displays packets sent over the network as JSON and lets you see serial debugging information from the meshtastic devices. The source code for this tool is also a good [example](https://github.com/meshtastic/Meshtastic-python/blob/master/meshtastic/__main__.py) of a 'complete' application that uses the meshtastic python API.
+
+:::note
+This command is not run inside of python, you run it from your operating system shell prompt directly.  If when you type "meshtastic" it doesn't find the command and you are using Windows: Check that the python "scripts" directory [is in your path](https://datatofish.com/add-python-to-windows-path/).
+:::
+
+To display a (partial) list of the available commands:
+```bash
+meshtastic -h
+```
+
+## Changing device settings
+
+You can also use this tool to set any of the device parameters which are stored in persistent storage. For instance, here's how to set the device
+to keep the bluetooth link alive for eight hours (any usage of the bluetooth protcol from your phone will reset this timer)
+
+```bash title="Expected Output"
+# You should see a result similar to this:
+mydir$ meshtastic --set wait_bluetooth_secs 28800
+Connected to radio...
+Setting preference wait_bluetooth_secs to 28800
+Writing modified preferences to device...
+```
+
+Or to set a node at a fixed position and never power up the GPS.
+
+```bash
+meshtastic --setlat 25.2 --setlon -16.8 --setalt 120
+```
+
+Or to configure an ESP32 based board to join a wifi network as a station:
+
+```bash
+meshtastic --set wifi_ap_mode false --set wifi_ssid mywifissid --set wifi_password mywifipsw
+```
+
+Or to configure an ESP32 to run as a Wifi access point:
+
+```bash
+meshtastic --set wifi_ap_mode true --set wifi_ssid mywifissid --set wifi_password mywifipsw
+```
+
+:::note
+For a full list of preferences which can be set (and their documentation) can be found in the [protobufs](/docs/developers/protobufs/api#radioconfiguserpreferences)
+:::
+
+### Changing channel settings
+
+The channel settings can be changed similiarly.  Either by using a standard (sharable) meshtastic URL or you can set partiular channel parameters (for advanced users).
+
+The URL is constructed automatically based off of the current channel settings. So if you want to customize a channel you could do something like:
+
+```bash
+meshtastic --setchan name mychan --setchan channel_num 4 --info
+```
+
+This will change some channel params and then show device info (which will include the current channel URL)
+
+You can even set the channel preshared key to a particular AES128 or AES256 sequence.
+
+```bash
+meshtastic --setchan psk 0x1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b --info
+```
+
+Use `--setchan psk none` to turn off encryption.  
+
+Use `--setchan psk random` will assign a new (high quality) random AES256 key to the primary channel (similar to what the Android app does when making new channels).
+
+Use `--setchan psk default` to restore the standard 'default' (minimally secure, because it is in the source code for anyone to read) AES128 key.
+
+### Ham radio support
+
+Meshtastic is designed to be used without a radio operator license.  If you do have a license you can set your operator ID and turn off encryption with:
+
+```bash title="Expected Output"
+# You should see a result similar to this:
+mydir$ meshtastic --port /dev/ttyUSB1 --set-ham KI1345
+Connected to radio
+Setting HAM ID to KI1345 and turning off encryption
+Writing modified channels to device
+```
+
+## FAQ/common problems
+
+This is a collection of common questions and answers from our friendly forum.
+
+### Permission denied: ‘/dev/ttyUSB0’
+
+As previously discussed on the [forum](https://meshtastic.discourse.group/t/question-on-permission-denied-dev-ttyusb0/590/3?u=geeksville)
+
+This indicates an OS permission problem for access by your user to the USB serial port.  Typically this is fixed by the following.
+
+```bash
+sudo usermod -a -G dialout <username>
+```
+
+### Mac OS Big Sur
+
+There is a problem with Big Sur and pyserial. The workaround is to install a newer version of pyserial:
+
+```bash
+pip3 install -U --pre pyserial
+```
+
+Afterwards you can use the meshatstic python client again on MacOS.

website/docs/software/python/installation.md

@@ -0,0 +1,69 @@
+---
+id: python-installation
+title: Meshtastic-python installation
+sidebar_label: Installation
+---
+
+This is a python library for using Meshtastic devices. This small library (and example application) provides an easy API for sending and receiving messages over mesh radios. It also provides access to any of the operations/data available in the device user interface or the Android application. 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.github.io/Meshtastic-python) for the library, including examples, is available.
+
+Installation is easily done through the Python package installer pip (note, you must use pip version 20 or later):
+
+## Linux
+
+- Check that your computer has the required serial drivers installed
+    * Connect your Meshtastic device to your USB port
+    * Use the command
+        ```bash
+        lsusb
+        ```
+    * You should see something like `CP210X USB to UART Bridge Controller`
+    * If not download the drivers from [Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).
+- Check that your computer has Python 3 installed.
+    * Use the command
+        ```bash
+        python3 -V
+        ```
+    * If this does not return a version, install [python](https://www.python.org)
+- Pip is typically installed if you are using python 3 version >= 3.4
+    * Check that pip is installed using this command
+        ```bash
+        pip3 -V
+        ```
+    * If this does not return a version, install [pip](https://pip.pypa.io/en/stable/installing/)
+- Install pytap2
+    ```bash
+    sudo pip3 install --upgrade pytap2
+    ```
+- Install meshtastic:
+    ```bash
+    sudo pip3 install --upgrade meshtastic
+    ```
+## Windows
+
+- Check that your computer has the required serial drivers installed
+    * Connect your Meshtastic device to your USB port
+    * Open Device Manager
+    * Under `Ports (COM & LPT)` you should see something like `Silicon Labs CP210X USB to UART Bridge (COM5)`
+    * If not download the drivers from [Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).
+- Check that your computer has Python 3 installed.
+    * Use the command
+        ```powershell
+        py -V
+        ```
+    * If this does not return a version, install [python](https://www.python.org)
+- Pip is typically installed if you are using python 3 version >= 3.4
+    * Check that pip is installed using this command
+        ```powershell
+        pip3 -V
+        ```
+    * If this does not return a version, install [pip](https://pip.pypa.io/en/stable/installing/)
+- Install pytap2
+    ```powershell
+    pip3 install --upgrade pytap2
+    ```
+- Install meshtastic:
+    ```powershell
+    pip3 install --upgrade meshtastic
+    ```

website/docs/software/python/usage.md

@@ -0,0 +1,25 @@
+---
+id: python-usage
+title: Meshtastic-python usage
+sidebar_label: Python usage
+---
+
+An example using Python 3 code to send a message to the mesh:
+```python
+import meshtastic
+interface = meshtastic.SerialInterface() # By default will try to find a meshtastic device, otherwise provide a device path like /dev/ttyUSB0
+interface.sendText("hello mesh") # or sendData to send binary data, see documentations for other options.
+interface.close()
+```
+
+For the rough notes/implementation plan see [TODO](https://github.com/meshtastic/Meshtastic-python/blob/master/TODO.md). See the API for full details of how to use the library.
+
+## A note to developers of this lib
+
+We use the visual-studio-code default python formatting conventions (autopep8).  So if you use that IDE you should be able to use "Format Document" and not generate unrelated diffs.  If you use some other editor, please don't change formatting on lines you haven't changed.
+
+If you need to build a new release you'll need:
+```bash title="Command"
+apt install pandoc
+sudo pip3 install markdown pandoc webencodings pyparsing twine autopep8
+```

website/sidebars.js

@@ -43,6 +43,9 @@ module.exports = {
       },
       {
         "Meshtastic-python": [
+          "software/python/python-installation",
+          "software/python/python-cli",
+          "software/python/python-usage",
           {
             type: "link",
             label: "API Docs",