README.md

MagicMirror-air-raid-monitor-ua

This is an extension for the MagicMirror. It shows the current status of air raid alerts across Ukraine's regions on a map of the country. Based on data from the UkraineAlarm API — you'll need an API key from that service to use this module.

Installation

1. Install and configure MagicMirror.
2. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/PavlenkoM/MagicMirror-air-raid-monitor-ua.git
3. To use this module, add it to the modules array in the config/config.js file:

modules: [
	{
		module: 'MagicMirror-air-raid-monitor-ua',
		config: {
      		apiKey: 'YOUR_API_KEY',
			updateInterval: 90,
			fullAlertThreshold: 0.5,
		}
	}
]

Configuration options

The following properties can be configured:

Option	Description
apiKey	Your API key for accessing the air raid data.
updateInterval	Interval of updating information about air raids in Ukraine. Value in seconds. Default and minimum value 90 seconds (lower values are ignored) — the UkraineAlarm API rate-limits each key to about one request per minute and answers faster polling with empty 401 responses, so the module keeps a safety margin above that limit.
fullAlertThreshold	Fraction (0–1) of an oblast's districts/communities that must be under alert before the whole oblast is painted "full" instead of "partial". Strict greater-than (exactly at the threshold stays "partial"). Default 0.5.

License

This module is licensed under the MIT License.