oasis6212/Meshbot_weather
1
0
Fork 0
mirror of https://github.com/oasis6212/Meshbot_weather.git synced 2025-12-10 09:55:19 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
oasis6212 2025-06-29 11:11:33 -04:00 committed by GitHub
parent 5cdbb24c99
commit 2f802f4aab
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -76,7 +76,7 @@ Commands below are not listed in the help menu:
- advertise : When received the bot will send out a message on the public channel introducing itself along with its menu - advertise : When received the bot will send out a message on the public channel introducing itself along with its menu
command. command.
## Requirements, Set these up first before installing the program ## Requirements
- [Python](https://www.python.org/) 3.11 or above - [Python](https://www.python.org/) 3.11 or above
- Access to a [Meshtastic](https://meshtastic.org) device - Access to a [Meshtastic](https://meshtastic.org) device
@ -85,7 +85,7 @@ command.
## Meshbot Weather Installation ## Meshbot Weather Installation
1. Open your terminal or command prompt, then clone this repository to your local machine: 1. Open your terminal, then clone this repository to your local machine:
``` ```
git clone https://github.com/oasis6212/meshbot_weather.git git clone https://github.com/oasis6212/meshbot_weather.git
@ -117,7 +117,7 @@ pip install -r requirements.txt
## How to run the program on various operating systems: ## How to run the program on various operating systems:
Note: The port your meshtastic radio is using may vary from the examples.
Example on Linux: Example on Linux:
@ -149,6 +149,21 @@ For a list of avaiable ports:
``` ```
python meshbot.py --help python meshbot.py --help
``` ```
## Running the program in the future
After you have closed your terminal, you will need to re-activate the virtual environment the next time you want to run the program.
1. Navigate into the folder
```
cd meshbot_weather
```
2. Activate virtual environment
```
. .venv/bin/activate
```
3. Run the program
See above under "How to run the program on various operating systems."
## Configuration ## Configuration
The ''settings.yaml'' file; it's where you can configure different options. Can be edited in notepad. The ''settings.yaml'' file; it's where you can configure different options. Can be edited in notepad.
@ -228,7 +243,7 @@ a single message when set to false.
are on a high-traffic mesh, you may want to disable these. are on a high-traffic mesh, you may want to disable these.
- FULL_MENU: true # When true, includes all weather commands. When false, shows only forecast options that return a - FULL_MENU: false # When true, includes all weather commands. When false, shows only forecast options that return a
single message. single message.
@ -313,4 +328,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
This project is neither endorsed by nor supported by Meshtastic. This project is neither endorsed by nor supported by Meshtastic.
Meshtastic® is a registered trademark of Meshtastic LLC. Meshtastic software components are released under various Meshtastic® is a registered trademark of Meshtastic LLC. Meshtastic software components are released under various
licenses, see GitHub for details. No warranty is provided - use at your own risk. licenses, see GitHub for details. No warranty is provided - use at your own risk.