Pikud Ha'oref Alarm Tracking
A simple CLI tool for tracking Pikud Ha'oref alarms.
Polls the unofficial API endpoint every second for incoming alarms. Prints active alarms as they occur. Prints routine messages once every 5 minutes by default.
⚠️
Disclaimer
⚠️
This tool is based on an unofficial API, and cannot be guaranteed to show correct or timely data. Do not use it if human life is at stake. Do not assume it shows you correct data. Do not assume it works properly, or even works at all. Always follow official guidelines and procedures published by Pikud Ha'oref.
Further fine-print covering the terms of use of this tool can be found in the GPLv3 license file.
Install
Pip
The easiest way to install is from PyPI with pip:
$ pip install alarmpy
You can then run the alarmpy executable directly:
$ alarmpy --help
Pipenv
For development usage it's recommended to clone the git repo and use pipenv:
$ git clone https://github.com/yuvadm/alarmpy
$ cd alarmpy
$ pipenv sync -d
$ pipenv run alarmpy
Usage
For the default usage after installation, just run:
$ alarmpy
Display
- Set the output language using
--language [en|he|ar|ru], this uses the official city and area name translations for Hebrew, Arabic, English and Russian. - In case of RTL issues in the terminal use
--reverseto output all names in reverse. - Use
--highlight abcin order to highlight any alarm which contains the stringabc.
Proxy
The unofficial API is limited for use for Israeli-originating IPs only. In order to use alarmpy from outside Israel, users must route traffic through an Israeli exit point. The HTTPS_PROXY environment variable is supported for this use case.
Advanced
Advanced flags can be set as described in the usage:
$ pipenv run alarmpy --help
Usage: alarmpy.py [OPTIONS]
Options:
--language [en|he|ar|ru] Alert language
--highlight TEXT String to search for and highlight in case of
alarm
--reverse Reverse Hebrew/Arabic output for terminals with
RTL bugs
--polling-delay INTEGER Polling delay in seconds
--routine-delay INTEGER Routine message delay in seconds
--alarm-id Print alarm IDs
--repeat-alarms Do not suppress ongoing alarms
--quiet Print only active alarms
--desktop-notifications Create push notifications on your desktop
notification center (currently only in Mac OS)
--mqtt-server TEXT Hostname / IP of MQTT server (optional)
--mqtt-client-id TEXT MQTT client identifier
--mqtt-port INTEGER Port for MQTT server
--mqtt-topic TEXT Topic on which to send MQTT messages
--mqtt-filter TEXT Payload value to filter before sending as a
message (semicolon separated)
--output-test Print a debug output and exit
--help Show this message and exit.
MQTT Notifications
Integration with an MQTT server provides the ability to send custom MQTT messages for all or some of the alerts that are received. MQTT requires paho-mqtt to be installed separately as an optional dependency.
To enable, specify at least the following parameters via the command line:
mqtt-server- The MQTT Server hostname or IP, e.g.localhostmqtt-topic- The MQTT topic to which the MQTT message will be sent, e.g.alarmpy/zone
Additional optional parameters for MQTT integration are:
mqtt-client-id- The ID of the MQTT client used by alarmpy. This will be used to connect to the MQTT server. Default:alarmPyClient. This only needs to be change in case you plan to have more than one instance of alarmpy runningmqtt-port- The port on which the MQTT server is listening to. Default:1883
Filtering
When MQTT is enabled, all alerts are sent as separate messages on the specified topic. In case there is a desire to include only specific alert, use the mqtt-filter parameter to provide a semicolon separated list of substrings enclosed in double quotes. Each alert city and area will be checked against all filters, and only when a match is found, will an MQTT message be sent. For example: --mqtt-filter "gaza;negev".
1 Nov 7, 2021
5 Nov 22, 2022
23 Jul 4, 2022
2 Dec 6, 2021
1 Dec 11, 2021
1 Mar 4, 2022
75 Dec 4, 2022
6 Dec 23, 2022
9 May 17, 2022
446 Dec 21, 2022
2 Jan 13, 2022
4 Oct 16, 2022
269 Dec 20, 2022
61 Oct 30, 2022
12 Jan 29, 2022
0 Oct 27, 2022
77 Dec 01, 2022
6 Dec 25, 2021
2 Nov 23, 2021
502 Dec 30, 2022
49 Nov 15, 2021
1 Feb 05, 2022
6 Jan 03, 2023
1 Feb 09, 2022
86 Dec 19, 2022
1 Nov 28, 2021
25 Sep 06, 2022
10.5k Jan 08, 2023