Skip to content

swarup-developer/weatherChecker-addon

Repository files navigation

Weather Checker NVDA Add-on

Weather Checker is a highly accessible NVDA add-on that provides up-to-date weather conditions, forecasts, astronomy data, and weather alerts. It integrates both the OpenWeather and Pirate Weather APIs to deliver accurate, reliable forecasts with seamless automatic failover.


Key Features

  1. Dual Provider & All Providers Selection: Choose between OpenWeather, Pirate Weather, or select All Providers to query both simultaneously and receive average weather statistics with combined weather descriptions.
  2. Programmatic Failover: If you select a single provider but that provider goes down, the add-on automatically falls back to your secondary provider to ensure you always get the weather details, announcing: "OpenWeather is currently unavailable. Using Pirate Weather."
  3. Advanced Location Search: Search for locations easily with a dedicated Location Search Dialog, which returns focus directly back to NVDA Settings once a location is chosen.
  4. Auto-Location Detection: Detect your current location automatically using IP-based geolocation with a single click.
  5. Weather History & Comparison: Log weather conditions over time and easily compare current weather details against your past records.
  6. Automatic Updates: Features an accessible automatic update notification dialog displaying release notes inside a read-only multiline text field, focusing the "Yes" button by default.

Keyboard Shortcuts

By default, only one keyboard shortcut is assigned to prevent conflicts with NVDA's built-in keys and other add-ons:

  • NVDA + Shift + W: Speaks the current weather conditions.
    • Double Press: Copies the detailed current weather text to the clipboard.

Customizing Gestures (All Other Functions)

All other features do not have a default keyboard shortcut assigned. You can freely assign your preferred shortcuts by going to: NVDA Menu -> Preferences -> Input Gestures -> Weather Checker category.

From there, you can bind shortcuts for:

  • Speaking the weather forecast (Double press to copy)
  • Speaking active weather alerts/warnings (Double press to copy)
  • Speaking astronomy details (sunrise, sunset, moon phase) (Double press to copy)
  • Cycling through your configured favorite locations
  • Opening the Weather Checker Settings panel

How to Set Up and Configure

  1. Go to NVDA Menu -> Preferences -> Settings.
  2. Navigate to the Weather Checker category in the settings list.
  3. Select Weather Provider:
    • OpenWeather: Requires an OpenWeather API key.
    • Pirate Weather: Requires a Pirate Weather API key.
    • All Providers: Requires both API keys. Queries both services and aggregates results.
  4. Configure Location:
    • Check Automatically detect my location to query weather based on your current IP address.
    • Or, uncheck it to configure a static default location: click Search for Location... to search for your city, or click Use Current Location to set it based on your current IP.
  5. Configure your preferences for Temperature Unit (Celsius/Fahrenheit), Wind Speed, Pressure, Visibility, Automatically copy spoken weather details to clipboard, and Auto-Update Checks.
  6. Press OK to save configurations.

Download & Repository

The official source code, repository, and release packages are hosted on GitHub:


Contributions

Contributions are welcome! If you want to contribute, please follow these guidelines:

Contribution Guidelines

  1. Reporting Issues: If you encounter bugs or want to request features, please open an issue on the GitHub Issues page.
  2. Submitting Pull Requests:
    • Fork the repository and create your branch from main.
    • Implement your changes, keeping the code clean and properly structured.
    • Commit your changes with clear, descriptive commit messages.
    • Submit a Pull Request describing your changes.
  3. Code Quality:
    • Write clean, readable code.
    • Test your changes locally before submitting.
  4. Local Building & Testing:
    • Run scons in the root directory to build the .nvda-addon package.
    • Install the generated package in NVDA to verify your changes.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors