OSX documentation update

This commit is contained in:
Harry Lincoln 2022-01-24 10:25:53 +00:00
parent b51f2ce1ed
commit 41de82f7f4
2 changed files with 79 additions and 49 deletions

View file

@ -4,7 +4,7 @@ title: OSX Install
sidebar_label: OSX
---
(Here's some quick tips on installing the device code from OS-X, thanks to @android606)
(Here's some quick tips and [troubleshooting](#troubleshooting) on installing the device code from OS-X, thanks to @android606)
First time using LoRa for anything, just checking it out.
@ -31,3 +31,31 @@ I got it working fairly smoothly, but there were two hang-ups I thought I'd ment
[driver for the CP210X USB to UART bridge from Silicon Labs](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
After I installed that, esptool.py was completely happy and the firmware loaded right up.
### Troubleshooting
**1. Running into trouble when installing `esptool` via brew**
- Make sure that `openssl` is installed first:
```
brew install openssl
```
- Set some flags in your bash/zsh/whichever profile for `esptool` to install [cryptography](https://cryptography.io/en/latest/installation/) as a dependency correctly:
```
export LDFLAGS="-L/usr/local/opt/openssl/lib"
export CPPFLAGS="-I/usr/local/opt/openssl/include"
export PKG_CONFIG_PATH="/usr/local/opt/openssl/lib/pkgconfig"
```
- attempt a reinstall of esptool
```
pip3 install --upgrade esptool
```
**2. I can't see the usb device as `/dev/tty[something]`:**
- Driver config successfully tested on Big Sur v11.6.2: https://github.com/WCHSoftGroup/ch34xser_macos

View file

@ -22,7 +22,7 @@ meshtastic -h
### --port PORT
The port the Meshtastic device is connected to, i.e. /dev/ttyUSB0 or COM4. if unspecified, meshtastic will try to find it. Important to use when multiple devices are connected to ensure you call the command for the correct device.
The port the Meshtastic device is connected to, i.e. `/dev/ttyUSB0`, `/dev/cu.wchusbserial`, `COM4` etc. if unspecified, meshtastic will try to find it. Important to use when multiple devices are connected to ensure you call the command for the correct device.
**Usage**
@ -130,6 +130,7 @@ Add a secondary channel, you must specify a channel name.
```shell
meshtastic --ch-add testing-channel
```
### --ch-del
Delete the ch-index channel.
@ -197,7 +198,7 @@ Set device owner name.
**Usage**
```shell
meshtastic --dest \!28979058 --set-owner "MeshyJohn"
meshtastic --dest '!28979058' --set-owner "MeshyJohn"
```
### --set-ham SET_HAM
@ -217,7 +218,7 @@ The destination node id for any sent commands
**Usage**
```shell
meshtastic --dest \!28979058 --set-owner "MeshyJohn"
meshtastic --dest '!28979058' --set-owner "MeshyJohn"
```
### --sendtext SENDTEXT
@ -247,7 +248,7 @@ Tell the destination node to reboot.
**Usage**
```shell
meshtastic --dest \!28979058 --reboot
meshtastic --dest '!28979058' --reboot
```
### --reply
@ -267,7 +268,7 @@ Set a particular GPIO # to 1 or 0.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --gpio-wrb 4 1 --dest \!28979058
meshtastic --port /dev/ttyUSB0 --gpio-wrb 4 1 --dest '!28979058'
```
### --gpio-rd GPIO_RD
@ -277,7 +278,7 @@ Read from a GPIO mask.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --gpio-rd 0x10 --dest \!28979058
meshtastic --port /dev/ttyUSB0 --gpio-rd 0x10 --dest '!28979058'
```
### --gpio-watch GPIO_WATCH
@ -287,7 +288,7 @@ Start watching a GPIO mask for changes.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --gpio-watch 0x10 --dest \!28979058
meshtastic --port /dev/ttyUSB0 --gpio-watch 0x10 --dest '!28979058'
```
### --no-time
@ -401,6 +402,7 @@ To create to a file with the connected device's configuration, this command's ou
```shell
meshtastic --export-config > example_config.yaml
```
**Usage**
```shell