brik-engenharia / lightningdetector Goto Github PK

This project is a supybot plugin which detects lightning strikes based on Finnish Meteorological Institute's open weather data.

Clone this plugin into supybot's run directory under plugins. After this, the authorized user can load the plugin with command "load LightningDetector".

• alarmadd lat lon radius_km
  • Adds an alarm for the user -- each user can have only one alarm.
  • Once an alarm is set, the plugin will periocally check if any lighting strikes are detected in the vicinity. The user will be alarmed to the channel where the alarm was originally set. The plugin tries not to spam and has three hour blocking period after user has been alarmed.
  • Example: alarmadd 62.2321 24.2455 50
• alarmremove
  • Removes alarm for the user
• alarmlist
  • Lists all alarms
  • Output format is the following: user channel lat lon radius unix_ts_until_next_alarm
  • Example: tipi^ #salamatesting 62.2447 25.7472 50 1463528267
• alarmstatus
  • Forces the alarm to be shown regardless blocking period
• alarmemail email
  • Adds email alert to user's alarm. User can remove the email alert by using this command without parameter.
  • Using this command requires that Gmail credentials are entered to userconf.py
• weather place
  • Returns the weather for a city in Finland

In addition to the files contained in this project, the user must create a file 'userconf.py' which contains the variable APIKEY in the following format.

APIKEY = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

The API key is a personal key which the user can register for [here] (https://ilmatieteenlaitos.fi/rekisteroityminen-avoimen-datan-kayttajaksi).

If you wish to use the email alarm functionality, add Gmail credentials to the same file.

GMAIL_USER = '<user>@gmail.com'
GMAIL_PASS = '<pass>'