mirror of
https://github.com/TheCommsChannel/TC2-BBS-mesh.git
synced 2025-12-15 07:52:53 -05:00
Update weather plugin and enhance command handling
- Added weather plugin with functionality to fetch and display weather information using the OpenWeather API. - Integrated weather command into the main menu and updated command handlers to manage user interactions for weather queries. - Updated .gitignore to include database and configuration files. - Created a test client for interactive testing of the BBS system. - Added example configuration for the weather plugin.
This commit is contained in:
parent
4ac47e84bf
commit
3e3bc7f1f6
2 changed files with 16 additions and 8 deletions
|
|
@ -1,7 +1,7 @@
|
||||||
# Weather Plugin Documentation
|
# Weather Plugin Documentation
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The Weather Plugin provides weather information for the EDC LV BBS system using the OpenWeather API. It allows users to query current weather conditions by ZIP code.
|
The Weather Plugin provides weather information for the TC² BBS system using the OpenWeather API. It allows users to query current weather conditions by ZIP code. The plugin is accessible through the Plugins Menu in the BBS system.
|
||||||
|
|
||||||
## Structure
|
## Structure
|
||||||
```
|
```
|
||||||
|
|
@ -49,18 +49,26 @@ Settings:
|
||||||
- Max calls per day
|
- Max calls per day
|
||||||
- Plugin enabled/disabled flag
|
- Plugin enabled/disabled flag
|
||||||
|
|
||||||
|
## Menu Integration
|
||||||
|
The Weather Plugin is integrated into the TC² BBS system through the Plugins Menu:
|
||||||
|
- Located in the main menu under [P]lugins
|
||||||
|
- Identified by "WE" in the plugins menu
|
||||||
|
- Configurable through the plugin_menu_items setting in config.ini
|
||||||
|
|
||||||
## Usage Flow
|
## Usage Flow
|
||||||
1. User selects "[WE]ather" from main menu
|
1. User selects [P]lugins from main menu
|
||||||
2. System prompts for ZIP code
|
2. User selects "[WE]ather" from plugins menu
|
||||||
3. User enters 5-digit ZIP code
|
3. System prompts for ZIP code
|
||||||
4. System checks rate limits
|
4. User enters 5-digit ZIP code
|
||||||
5. Makes API request if within limits
|
5. System checks rate limits
|
||||||
6. Returns formatted weather data:
|
6. Makes API request if within limits
|
||||||
|
7. Returns formatted weather data:
|
||||||
- Temperature
|
- Temperature
|
||||||
- Feels like temperature
|
- Feels like temperature
|
||||||
- Humidity
|
- Humidity
|
||||||
- Weather conditions
|
- Weather conditions
|
||||||
- City name
|
- City name
|
||||||
|
8. Returns to plugins menu after displaying weather
|
||||||
|
|
||||||
## Error Handling
|
## Error Handling
|
||||||
- Invalid ZIP codes
|
- Invalid ZIP codes
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
"""
|
"""
|
||||||
Weather Module for EDC LV BBS
|
Weather Module for TC² BBS
|
||||||
|
|
||||||
This module provides weather information using the OpenWeather API.
|
This module provides weather information using the OpenWeather API.
|
||||||
"""
|
"""
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue