AtmosphericX - Widgets (GUIDE)
THIS DOCUMENT IS A WORK IN PROGRESS
Note: This document is currently a work in progress and may not contain all the necessary information. It is recommended to check back later for updates or refer to the official documentation for more details. Feel free to ask in the Discord if you have any questions or need assistance with the configuration.
Introduction to AtmosphericX Widgets
Project AtmosphericX provides a set of customizable widgets that can be used to display weather data from multiple sources into your project, streaming software, or web applications. Each widget has its own benefits and features, allowing you to choose the ones that best suit your needs. These widgets are designed to be lightweight, easy to integrate, and provide near real-time weather data and alerts.
How to Use Widgets
Widgets can be used directly with OBS Studio or any other software that supports HTML sources. You can also use them in your own web applications by embedding the widget URLs.
| Widget Type | Parameters | Description |
|---|---|---|
/widgets/clock | ?time, ?date | Displays the current time and date. |
/widgets/table | N/A | Displays a table with the latest active alerts, including the type and area. |
/widgets/colors | ?light, ?dark | Displays a dynamic color palette block based on the active alerts this can be customized by alert type in the configurations, default is light, however you can use ?dark to switch to a slightly darker color palette. |
/widgets/location | N/A | Shows the current location if available, useful for location based alerts and chasers to display their geographical location and location based weather details. |
/widgets/chatbot | N/A | Integrates a chatbot for user assistance and quick weather queries. |
/widgets/header | N/A | Renders a customizable header for showing total alerts active (Custom Text) |
/widgets/watchdog | N/A | Monitors specific weather events and counts them. |
/widgets/notification | N/A | Custom text and title notification widget to display certain details manually. |
/widgets/spc | N/A | Displays Storm Prediction Center outlooks (Cycles). |
/widgets/portable | N/A | A compact, portable widget for listening without fancy displays. |
/widgets/mapbox | ?random, ?showAlert | Displays a Mapbox map with polygons and a semi-functional reflectivity layer. If you use ?random, it will show a random active alert on the map. If using ?showAlertit will display the current alert you are zoomed on with details. |
/widgets/random | ?alert (Default), ?description,?locations, ?expires | Displays a random alert from the server, with options to show the alert type, description, and locations. Use ?alert to show the alert type, ?description to show the description, and?locations to show the locations. Use ?expires to show the expiration time of the alert. |
/widgets/alerts | ?alert, ?top | Shows information about active alerts as soon as they’re processed by the server. Top parameter is used to show a small widget of the highest alert, this can also be used with ?colorTop to show the alerts color and?trackingID to show a specific alert by its tracking ID. |
Paramter example:
/widgets/mapbox?randomfor a random active alert on the map.