mirror of
				https://gitea.farpn.net/w1cdn/mwtchahrd.git
				synced 2025-11-03 21:46:35 -06:00 
			
		
		
		
	Update readme.
This commit is contained in:
		
							
								
								
									
										30
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										30
									
								
								README.md
									
									
									
									
									
								
							@@ -57,6 +57,30 @@ mwtchahrd -i <IP> -p <PORT> [-c <CHANNEL>] [-d] [-u]
 | 
				
			|||||||
- `-u, --ui_only`  
 | 
					- `-u, --ui_only`  
 | 
				
			||||||
  Only display frames with a UI payload. When this flag is set, frames that are not UI are skipped.
 | 
					  Only display frames with a UI payload. When this flag is set, frames that are not UI are skipped.
 | 
				
			||||||
  
 | 
					  
 | 
				
			||||||
 | 
					- `-b, --uip <UIP>`
 | 
				
			||||||
 | 
					  Send UDP to what IP address (e.g. 127.0.0.1) [default: 127.0.0.1].
 | 
				
			||||||
 | 
					  
 | 
				
			||||||
 | 
					- `-k, --uport <UPORT>`
 | 
				
			||||||
 | 
					  Send UDP to what port (e.g. 8000; 55555 disables UDP) [default: 55555].
 | 
				
			||||||
 | 
					  
 | 
				
			||||||
 | 
					- `-s, --spotter <SPOTTER>`            
 | 
				
			||||||
 | 
					  Spotter callsign (e.g. W1CDN).
 | 
				
			||||||
 | 
					  
 | 
				
			||||||
 | 
					- `-o, --spothole`                     
 | 
				
			||||||
 | 
					  Spot UI frames to a Spothole server.
 | 
				
			||||||
 | 
					  
 | 
				
			||||||
 | 
					- `-O, --spothole-alt <SPOTHOLE_ALT>` 
 | 
				
			||||||
 | 
					  Provide a different URL than https://spothole.app/api/v1/spot.
 | 
				
			||||||
 | 
					  
 | 
				
			||||||
 | 
					- `-f, --freq <FREQ>`                 
 | 
				
			||||||
 | 
					  Spotting frequency [default: 14105000].
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- `-h, --help`                         
 | 
				
			||||||
 | 
					  Print help.
 | 
				
			||||||
 | 
					  
 | 
				
			||||||
 | 
					- `-V, --version`                      
 | 
				
			||||||
 | 
					  Print version.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Examples
 | 
					## Examples
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Monitoring All Frames
 | 
					### Monitoring All Frames
 | 
				
			||||||
@@ -83,6 +107,12 @@ Monitor only UI frames:
 | 
				
			|||||||
mwtchahrd -i 127.0.0.1 -p 8000 -u
 | 
					mwtchahrd -i 127.0.0.1 -p 8000 -u
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Spotting to [Spothole.app](https://spothole.app) API
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
 | 
					cargo run -- --ip 192.168.0.6 --port 8000 --spotter W1CDN --spothole --freq 14105000
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Code Overview
 | 
					## Code Overview
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- **Validation Functions:**  
 | 
					- **Validation Functions:**  
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user