meshconsole 2.2.0__tar.gz → 2.2.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. {meshconsole-2.2.0 → meshconsole-2.2.2}/PKG-INFO +48 -25
  2. {meshconsole-2.2.0 → meshconsole-2.2.2}/README.md +47 -24
  3. {meshconsole-2.2.0 → meshconsole-2.2.2}/pyproject.toml +1 -1
  4. {meshconsole-2.2.0 → meshconsole-2.2.2}/src/meshconsole/__init__.py +1 -1
  5. {meshconsole-2.2.0 → meshconsole-2.2.2}/src/meshconsole/core.py +1 -1
  6. {meshconsole-2.2.0 → meshconsole-2.2.2}/.gitignore +0 -0
  7. {meshconsole-2.2.0 → meshconsole-2.2.2}/LICENSE +0 -0
  8. {meshconsole-2.2.0 → meshconsole-2.2.2}/src/meshconsole/__main__.py +0 -0
  9. {meshconsole-2.2.0 → meshconsole-2.2.2}/src/meshconsole/templates/index.html +0 -0
{meshconsole-2.2.0 → meshconsole-2.2.2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: meshconsole
3
- Version: 2.2.0
3
+ Version: 2.2.2
4
4
  Summary: A powerful CLI and web interface for Meshtastic mesh networking devices
5
5
  Project-URL: Homepage, https://github.com/m9wav/MeshConsole
6
6
  Project-URL: Repository, https://github.com/m9wav/MeshConsole
@@ -37,7 +37,7 @@ Requires-Dist: twine; extra == 'dev'
37
37
  Description-Content-Type: text/markdown
38
38
 
39
39
  <p align="center">
40
- <img src="logo.png" alt="MeshConsole" width="400"/>
40
+ <img src="https://raw.githubusercontent.com/m9wav/MeshConsole/main/logo.png" alt="MeshConsole" width="400"/>
41
41
  </p>
42
42
 
43
43
  <p align="center">
@@ -45,11 +45,28 @@ Description-Content-Type: text/markdown
45
45
  </p>
46
46
 
47
47
  <p align="center">
48
+ <a href="https://pypi.org/project/meshconsole/"><img src="https://img.shields.io/pypi/v/meshconsole" alt="PyPI"></a>
48
49
  <a href="https://m9wav.uk/">m9wav.uk</a>
49
50
  </p>
50
51
 
51
52
  ---
52
53
 
54
+ ## Installation
55
+
56
+ ```bash
57
+ pip install meshconsole
58
+ ```
59
+
60
+ Or install from source:
61
+
62
+ ```bash
63
+ git clone https://github.com/m9wav/MeshConsole.git
64
+ cd MeshConsole
65
+ pip install -r requirements.txt
66
+ ```
67
+
68
+ ---
69
+
53
70
  So I got really into Meshtastic after picking up a couple of LoRa radios and wanted a way to monitor my mesh network from my computer. The official app is fine but I wanted something I could leave running on a server, log everything to a database, and maybe poke at later.
54
71
 
55
72
  This started as a quick script and... well, it grew. Now it's got a web UI and everything. Figured I'd clean it up and share it.
@@ -88,45 +105,51 @@ ip = 192.168.1.100
88
105
 
89
106
  If you're using TCP, your device needs to have WiFi enabled and you need to know its IP.
90
107
 
91
- ## Running it
108
+ ## Quick Start
109
+
110
+ ### USB Connection (device plugged in)
92
111
 
93
- **Listen for packets (with web interface):**
94
112
  ```bash
95
- python3 meshconsole.py listen --web
96
- ```
113
+ # Start web dashboard with USB-connected device
114
+ meshconsole listen --usb --web
97
115
 
98
- Then open http://localhost:5050 in your browser.
116
+ # Specify serial port explicitly
117
+ meshconsole listen --usb --port /dev/ttyUSB0 --web
99
118
 
100
- **Just listen (no web):**
101
- ```bash
102
- python3 meshconsole.py listen --verbose
119
+ # macOS example
120
+ meshconsole listen --usb --port /dev/cu.usbserial-0001 --web
103
121
  ```
104
122
 
105
- **List nodes your device knows about:**
106
- ```bash
107
- python3 meshconsole.py nodes
108
- ```
123
+ ### TCP/IP Connection (WiFi-enabled device)
109
124
 
110
- **Send a message:**
111
125
  ```bash
112
- python3 meshconsole.py send --dest !12345678 --message "hey there"
126
+ # Start web dashboard with network-connected device
127
+ meshconsole listen --ip 192.168.1.100 --web
113
128
  ```
114
129
 
115
- **Traceroute to a node:**
116
- ```bash
117
- python3 meshconsole.py traceroute --dest !12345678
118
- ```
130
+ Then open **http://localhost:5055** in your browser.
119
131
 
120
- You can also force USB or TCP mode from the command line regardless of what's in your config:
132
+ ### Other Commands
121
133
 
122
134
  ```bash
123
- python3 meshconsole.py listen --usb --web
124
- python3 meshconsole.py nodes --usb --port /dev/cu.usbserial-0001
135
+ # Listen without web interface (CLI output only)
136
+ meshconsole listen --usb --verbose
137
+
138
+ # List nodes your device knows about
139
+ meshconsole nodes --usb
140
+
141
+ # Send a message
142
+ meshconsole send --usb --dest !12345678 --message "hey there"
143
+
144
+ # Traceroute to a node
145
+ meshconsole traceroute --usb --dest !12345678
125
146
  ```
126
147
 
148
+ > **Note:** If installed from source, use `python3 meshconsole.py` instead of `meshconsole`.
149
+
127
150
  ## The web dashboard
128
151
 
129
- When you run with `--web`, you get a dashboard at port 5050. It shows:
152
+ When you run with `--web`, you get a dashboard at port 5055. It shows:
130
153
 
131
154
  - Live packet feed (updates automatically)
132
155
  - Node list with signal info
@@ -165,7 +188,7 @@ Spits out `meshtastic_data.json` or `meshtastic_data.csv`.
165
188
  - The device uses port 4403 by default
166
189
 
167
190
  **Web interface not loading:**
168
- - Check if port 5050 is already in use
191
+ - Check if port 5055 is already in use
169
192
  - Try a different port in `config.ini` under `[Web]`
170
193
 
171
194
  **Seeing your own messages in the log:**
{meshconsole-2.2.0 → meshconsole-2.2.2}/README.md RENAMED
@@ -1,5 +1,5 @@
1
1
  <p align="center">
2
- <img src="logo.png" alt="MeshConsole" width="400"/>
2
+ <img src="https://raw.githubusercontent.com/m9wav/MeshConsole/main/logo.png" alt="MeshConsole" width="400"/>
3
3
  </p>
4
4
 
5
5
  <p align="center">
@@ -7,11 +7,28 @@
7
7
  </p>
8
8
 
9
9
  <p align="center">
10
+ <a href="https://pypi.org/project/meshconsole/"><img src="https://img.shields.io/pypi/v/meshconsole" alt="PyPI"></a>
10
11
  <a href="https://m9wav.uk/">m9wav.uk</a>
11
12
  </p>
12
13
 
13
14
  ---
14
15
 
16
+ ## Installation
17
+
18
+ ```bash
19
+ pip install meshconsole
20
+ ```
21
+
22
+ Or install from source:
23
+
24
+ ```bash
25
+ git clone https://github.com/m9wav/MeshConsole.git
26
+ cd MeshConsole
27
+ pip install -r requirements.txt
28
+ ```
29
+
30
+ ---
31
+
15
32
  So I got really into Meshtastic after picking up a couple of LoRa radios and wanted a way to monitor my mesh network from my computer. The official app is fine but I wanted something I could leave running on a server, log everything to a database, and maybe poke at later.
16
33
 
17
34
  This started as a quick script and... well, it grew. Now it's got a web UI and everything. Figured I'd clean it up and share it.
@@ -50,45 +67,51 @@ ip = 192.168.1.100
50
67
 
51
68
  If you're using TCP, your device needs to have WiFi enabled and you need to know its IP.
52
69
 
53
- ## Running it
70
+ ## Quick Start
71
+
72
+ ### USB Connection (device plugged in)
54
73
 
55
- **Listen for packets (with web interface):**
56
74
  ```bash
57
- python3 meshconsole.py listen --web
58
- ```
75
+ # Start web dashboard with USB-connected device
76
+ meshconsole listen --usb --web
59
77
 
60
- Then open http://localhost:5050 in your browser.
78
+ # Specify serial port explicitly
79
+ meshconsole listen --usb --port /dev/ttyUSB0 --web
61
80
 
62
- **Just listen (no web):**
63
- ```bash
64
- python3 meshconsole.py listen --verbose
81
+ # macOS example
82
+ meshconsole listen --usb --port /dev/cu.usbserial-0001 --web
65
83
  ```
66
84
 
67
- **List nodes your device knows about:**
68
- ```bash
69
- python3 meshconsole.py nodes
70
- ```
85
+ ### TCP/IP Connection (WiFi-enabled device)
71
86
 
72
- **Send a message:**
73
87
  ```bash
74
- python3 meshconsole.py send --dest !12345678 --message "hey there"
88
+ # Start web dashboard with network-connected device
89
+ meshconsole listen --ip 192.168.1.100 --web
75
90
  ```
76
91
 
77
- **Traceroute to a node:**
78
- ```bash
79
- python3 meshconsole.py traceroute --dest !12345678
80
- ```
92
+ Then open **http://localhost:5055** in your browser.
81
93
 
82
- You can also force USB or TCP mode from the command line regardless of what's in your config:
94
+ ### Other Commands
83
95
 
84
96
  ```bash
85
- python3 meshconsole.py listen --usb --web
86
- python3 meshconsole.py nodes --usb --port /dev/cu.usbserial-0001
97
+ # Listen without web interface (CLI output only)
98
+ meshconsole listen --usb --verbose
99
+
100
+ # List nodes your device knows about
101
+ meshconsole nodes --usb
102
+
103
+ # Send a message
104
+ meshconsole send --usb --dest !12345678 --message "hey there"
105
+
106
+ # Traceroute to a node
107
+ meshconsole traceroute --usb --dest !12345678
87
108
  ```
88
109
 
110
+ > **Note:** If installed from source, use `python3 meshconsole.py` instead of `meshconsole`.
111
+
89
112
  ## The web dashboard
90
113
 
91
- When you run with `--web`, you get a dashboard at port 5050. It shows:
114
+ When you run with `--web`, you get a dashboard at port 5055. It shows:
92
115
 
93
116
  - Live packet feed (updates automatically)
94
117
  - Node list with signal info
@@ -127,7 +150,7 @@ Spits out `meshtastic_data.json` or `meshtastic_data.csv`.
127
150
  - The device uses port 4403 by default
128
151
 
129
152
  **Web interface not loading:**
130
- - Check if port 5050 is already in use
153
+ - Check if port 5055 is already in use
131
154
  - Try a different port in `config.ini` under `[Web]`
132
155
 
133
156
  **Seeing your own messages in the log:**
{meshconsole-2.2.0 → meshconsole-2.2.2}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "meshconsole"
7
- version = "2.2.0"
7
+ version = "2.2.2"
8
8
  description = "A powerful CLI and web interface for Meshtastic mesh networking devices"
9
9
  readme = "README.md"
10
10
  license = "MIT"
{meshconsole-2.2.0 → meshconsole-2.2.2}/src/meshconsole/__init__.py RENAMED
@@ -5,7 +5,7 @@ Author: M9WAV
5
5
  License: MIT
6
6
  """
7
7
 
8
- __version__ = "2.2.0"
8
+ __version__ = "2.2.2"
9
9
  __author__ = "M9WAV"
10
10
 
11
11
  from meshconsole.core import MeshtasticTool, MeshtasticToolError, PacketSummary
{meshconsole-2.2.0 → meshconsole-2.2.2}/src/meshconsole/core.py RENAMED
@@ -7,7 +7,7 @@ A tool for interacting with Meshtastic devices over TCP or USB.
7
7
 
8
8
  Author: M9WAV
9
9
  License: MIT
10
- Version: 2.2.0
10
+ Version: 2.2.2
11
11
  """
12
12
 
13
13
  import argparse
{meshconsole-2.2.0 → meshconsole-2.2.2}/.gitignore RENAMED
File without changes
{meshconsole-2.2.0 → meshconsole-2.2.2}/LICENSE RENAMED
File without changes